kibana/api_docs/observability_shared.devdocs.json

4925 lines
No EOL
170 KiB
JSON

{
"id": "observabilityShared",
"client": {
"classes": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin",
"type": "Class",
"tags": [],
"label": "ObservabilitySharedPlugin",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.ObservabilitySharedPlugin",
"text": "ObservabilitySharedPlugin"
},
" implements ",
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<void, void, object, object>"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(coreSetup: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, pluginsSetup: ",
"ObservabilitySharedSetup",
") => { locators: { profiling: { flamegraphLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"FlamegraphLocatorParams",
">; topNFunctionsLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"TopNFunctionsLocatorParams",
">; stacktracesLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"StacktracesLocatorParams",
">; }; }; navigation: { registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; }"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "coreSetup",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "pluginsSetup",
"description": [],
"signature": [
"ObservabilitySharedSetup"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", plugins: ",
"ObservabilitySharedStart",
") => { navigation: { PageTemplate: (pageTemplateProps: ",
"WrappedPageTemplateProps",
") => JSX.Element; registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; updateGlobalNavigation: ({ capabilities, deepLinks, updater$, }: { capabilities: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>; deepLinks: ",
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppDeepLink",
"text": "AppDeepLink"
},
"<string>[]; updater$: ",
"Subject",
"<",
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppUpdater",
"text": "AppUpdater"
},
">; }) => void; setIsSidebarEnabled: (isEnabled: boolean) => void; }"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"ObservabilitySharedStart"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ActionMenu",
"type": "Function",
"tags": [],
"label": "ActionMenu",
"description": [],
"signature": [
"(props: Props) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/action_menu/action_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ActionMenu.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/plugins/observability_shared/public/components/action_menu/action_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ActionMenuDivider",
"type": "Function",
"tags": [],
"label": "ActionMenuDivider",
"description": [],
"signature": [
"() => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/action_menu/action_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.createEsParams",
"type": "Function",
"tags": [],
"label": "createEsParams",
"description": [],
"signature": [
"(params: T) => T"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.createEsParams.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableFlamegraph",
"type": "Function",
"tags": [],
"label": "EmbeddableFlamegraph",
"description": [],
"signature": [
"(props: Props) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/profiling/embeddables/embeddable_flamegraph.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableFlamegraph.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/plugins/observability_shared/public/components/profiling/embeddables/embeddable_flamegraph.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableFunctions",
"type": "Function",
"tags": [],
"label": "EmbeddableFunctions",
"description": [],
"signature": [
"(props: Props) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/profiling/embeddables/embeddable_functions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableFunctions.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/plugins/observability_shared/public/components/profiling/embeddables/embeddable_functions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getContextMenuItemsFromActions",
"type": "Function",
"tags": [],
"label": "getContextMenuItemsFromActions",
"description": [],
"signature": [
"({\n uiActions,\n triggerId,\n context,\n}: { uiActions: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
"; triggerId: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ObservabilityTriggerId",
"text": "ObservabilityTriggerId"
},
"; context: Record<string, any>; }) => Promise<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.ObservabilityActionContextMenuItemProps",
"text": "ObservabilityActionContextMenuItemProps"
},
"[]>"
],
"path": "x-pack/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.getContextMenuItemsFromActions.$1",
"type": "Object",
"tags": [],
"label": "{\n uiActions,\n triggerId,\n context,\n}",
"description": [],
"path": "x-pack/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.getContextMenuItemsFromActions.$1.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"{ readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerTrigger: (trigger: ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Trigger",
"text": "Trigger"
},
") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ",
"TriggerContract",
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: (id: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>; readonly getTriggerActions: (triggerId: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
"; }"
],
"path": "x-pack/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getContextMenuItemsFromActions.$1.triggerId",
"type": "Enum",
"tags": [],
"label": "triggerId",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ObservabilityTriggerId",
"text": "ObservabilityTriggerId"
}
],
"path": "x-pack/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getContextMenuItemsFromActions.$1.context",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.HeaderMenuPortal",
"type": "Function",
"tags": [],
"label": "HeaderMenuPortal",
"description": [],
"signature": [
"(props: ",
"HeaderMenuPortalProps",
") => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/header_menu/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.HeaderMenuPortal.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"HeaderMenuPortalProps"
],
"path": "x-pack/plugins/observability_shared/public/components/header_menu/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.InspectorContextProvider",
"type": "Function",
"tags": [],
"label": "InspectorContextProvider",
"description": [],
"signature": [
"({ children }: { children: React.ReactNode; }) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.InspectorContextProvider.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.InspectorContextProvider.$1.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LoadWhenInView",
"type": "Function",
"tags": [],
"label": "LoadWhenInView",
"description": [],
"signature": [
"(props: ",
"LoadWhenInViewProps",
") => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/load_when_in_view/get_load_when_in_view_lazy.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.LoadWhenInView.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"LoadWhenInViewProps"
],
"path": "x-pack/plugins/observability_shared/public/components/load_when_in_view/get_load_when_in_view_lazy.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationWarningPromptProvider",
"type": "Function",
"tags": [],
"label": "NavigationWarningPromptProvider",
"description": [],
"signature": [
"({ children }: { children?: React.ReactNode; }) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationWarningPromptProvider.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"signature": [
"{ children?: React.ReactNode; }"
],
"path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/context.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.noCasesPermissions",
"type": "Function",
"tags": [],
"label": "noCasesPermissions",
"description": [],
"signature": [
"() => { all: boolean; create: boolean; read: boolean; update: boolean; delete: boolean; push: boolean; connectors: boolean; }"
],
"path": "x-pack/plugins/observability_shared/public/utils/cases_permissions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.Prompt",
"type": "Function",
"tags": [],
"label": "Prompt",
"description": [],
"signature": [
"({ prompt }: React.PropsWithChildren<Props>) => null"
],
"path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/prompt.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.Prompt.$1",
"type": "CompoundType",
"tags": [],
"label": "{ prompt }",
"description": [],
"signature": [
"React.PropsWithChildren<Props>"
],
"path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/prompt.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.Section",
"type": "Function",
"tags": [],
"label": "Section",
"description": [],
"signature": [
"string & ",
"StyledComponentBase",
"<\"div\", any, {}, never> & ",
"NonReactStatics",
"<never, {}>"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionLink",
"type": "Function",
"tags": [],
"label": "SectionLink",
"description": [],
"signature": [
"({\n showNewBadge,\n ...props\n}: ",
"CommonProps",
" & Omit<(",
"DisambiguateSet",
"<(",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>), React.HTMLAttributes<HTMLSpanElement>> & React.HTMLAttributes<HTMLSpanElement>) | (",
"DisambiguateSet",
"<React.HTMLAttributes<HTMLSpanElement>, (",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>)> & ((",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"l\" | \"xs\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ",
"IconType",
" | undefined; iconProps?: Omit<",
"EuiIconProps",
", \"type\"> | undefined; icon?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; showToolTip?: boolean | undefined; extraAction?: ",
"EuiListGroupItemExtraActionProps",
" | undefined; onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref<HTMLButtonElement> | undefined; toolTipText?: string | undefined; toolTipProps?: Partial<",
"EuiToolTipProps",
"> | undefined; } & { showNewBadge?: boolean | undefined; }) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionLink.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n showNewBadge,\n ...props\n}",
"description": [],
"signature": [
"CommonProps",
" & Omit<(",
"DisambiguateSet",
"<(",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>), React.HTMLAttributes<HTMLSpanElement>> & React.HTMLAttributes<HTMLSpanElement>) | (",
"DisambiguateSet",
"<React.HTMLAttributes<HTMLSpanElement>, (",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>)> & ((",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"l\" | \"xs\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ",
"IconType",
" | undefined; iconProps?: Omit<",
"EuiIconProps",
", \"type\"> | undefined; icon?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; showToolTip?: boolean | undefined; extraAction?: ",
"EuiListGroupItemExtraActionProps",
" | undefined; onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref<HTMLButtonElement> | undefined; toolTipText?: string | undefined; toolTipProps?: Partial<",
"EuiToolTipProps",
"> | undefined; } & { showNewBadge?: boolean | undefined; }"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionLinks",
"type": "Function",
"tags": [],
"label": "SectionLinks",
"description": [],
"signature": [
"({ children, ...props }: { children?: React.ReactNode; } & ",
"CommonProps",
" & Omit<React.HTMLAttributes<HTMLUListElement>, \"color\"> & { bordered?: boolean | undefined; flush?: boolean | undefined; gutterSize?: \"m\" | \"none\" | \"s\" | undefined; listItems?: ",
"EuiListGroupItemProps",
"[] | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; size?: \"m\" | \"s\" | \"l\" | \"xs\" | undefined; maxWidth?: boolean | ",
"Property",
".MaxWidth<string | number> | undefined; showToolTips?: boolean | undefined; wrapText?: boolean | undefined; ariaLabelledby?: string | undefined; }) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionLinks.$1",
"type": "CompoundType",
"tags": [],
"label": "{ children, ...props }",
"description": [],
"signature": [
"{ children?: React.ReactNode; } & ",
"CommonProps",
" & Omit<React.HTMLAttributes<HTMLUListElement>, \"color\"> & { bordered?: boolean | undefined; flush?: boolean | undefined; gutterSize?: \"m\" | \"none\" | \"s\" | undefined; listItems?: ",
"EuiListGroupItemProps",
"[] | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; size?: \"m\" | \"s\" | \"l\" | \"xs\" | undefined; maxWidth?: boolean | ",
"Property",
".MaxWidth<string | number> | undefined; showToolTips?: boolean | undefined; wrapText?: boolean | undefined; ariaLabelledby?: string | undefined; }"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionSpacer",
"type": "Function",
"tags": [],
"label": "SectionSpacer",
"description": [],
"signature": [
"() => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionSubtitle",
"type": "Function",
"tags": [],
"label": "SectionSubtitle",
"description": [],
"signature": [
"({ children }: { children?: React.ReactNode; }) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionSubtitle.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionSubtitle.$1.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionTitle",
"type": "Function",
"tags": [],
"label": "SectionTitle",
"description": [],
"signature": [
"({ children }: { children?: React.ReactNode; }) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionTitle.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionTitle.$1.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.shouldHandleLinkEvent",
"type": "Function",
"tags": [],
"label": "shouldHandleLinkEvent",
"description": [],
"signature": [
"(e: React.MouseEvent<Element, MouseEvent> | React.MouseEvent<HTMLAnchorElement | HTMLButtonElement, MouseEvent>) => boolean"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.shouldHandleLinkEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "e",
"description": [],
"signature": [
"React.MouseEvent<Element, MouseEvent> | React.MouseEvent<HTMLAnchorElement | HTMLButtonElement, MouseEvent>"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TechnicalPreviewBadge",
"type": "Function",
"tags": [],
"label": "TechnicalPreviewBadge",
"description": [],
"signature": [
"({ icon = 'beaker', size, style }: Props) => JSX.Element"
],
"path": "x-pack/plugins/observability_shared/public/components/technical_preview_badge/technical_preview_badge.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.TechnicalPreviewBadge.$1",
"type": "CompoundType",
"tags": [],
"label": "{ icon = 'beaker', size, style }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/plugins/observability_shared/public/components/technical_preview_badge/technical_preview_badge.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs",
"type": "Function",
"tags": [],
"label": "useBreadcrumbs",
"description": [],
"signature": [
"(extraCrumbs: ",
"EuiBreadcrumbProps",
"[], app?: { id: string; label: string; } | undefined) => void"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$1",
"type": "Array",
"tags": [],
"label": "extraCrumbs",
"description": [],
"signature": [
"EuiBreadcrumbProps",
"[]"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2",
"type": "Object",
"tags": [],
"label": "app",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useChartTheme",
"type": "Function",
"tags": [],
"label": "useChartTheme",
"description": [],
"signature": [
"() => ",
"RecursivePartial",
"<",
"Theme",
">[]"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_chart_theme.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEsSearch",
"type": "Function",
"tags": [],
"label": "useEsSearch",
"description": [],
"signature": [
"<DocumentSource extends unknown, TParams extends ",
"SearchRequest",
">(params: TParams, fnDeps: any[], options: { inspector?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IInspectorInfo",
"text": "IInspectorInfo"
},
" | undefined; name: string; }) => { data: ",
{
"pluginId": "@kbn/es-types",
"scope": "common",
"docId": "kibKbnEsTypesPluginApi",
"section": "def-common.ESSearchResponse",
"text": "ESSearchResponse"
},
"<DocumentSource, TParams, { restTotalHitsAsInt: false; }>; loading: boolean; }"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEsSearch.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"TParams"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEsSearch.$2",
"type": "Array",
"tags": [],
"label": "fnDeps",
"description": [],
"signature": [
"any[]"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEsSearch.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEsSearch.$3.inspector",
"type": "Object",
"tags": [],
"label": "inspector",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IInspectorInfo",
"text": "IInspectorInfo"
},
" | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEsSearch.$3.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_es_search.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useFetcher",
"type": "Function",
"tags": [],
"label": "useFetcher",
"description": [],
"signature": [
"(fn: ({}: { signal: AbortSignal; }) => TReturn, fnDeps: any[], options: { preservePreviousData?: boolean | undefined; }) => ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.FetcherResult",
"text": "FetcherResult"
},
"<InferResponseType<TReturn>> & { refetch: () => void; }"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useFetcher.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"({}: { signal: AbortSignal; }) => TReturn"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useFetcher.$2",
"type": "Array",
"tags": [],
"label": "fnDeps",
"description": [],
"signature": [
"any[]"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useFetcher.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useFetcher.$3.preservePreviousData",
"type": "CompoundType",
"tags": [],
"label": "preservePreviousData",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useGetUserCasesPermissions",
"type": "Function",
"tags": [],
"label": "useGetUserCasesPermissions",
"description": [],
"signature": [
"() => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
}
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_get_user_cases_permissions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useInspectorContext",
"type": "Function",
"tags": [],
"label": "useInspectorContext",
"description": [],
"signature": [
"() => ",
"InspectorContextValue"
],
"path": "x-pack/plugins/observability_shared/public/contexts/inspector/use_inspector_context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useKibanaSpace",
"type": "Function",
"tags": [],
"label": "useKibanaSpace",
"description": [],
"signature": [
"() => { space: ",
{
"pluginId": "spaces",
"scope": "common",
"docId": "kibSpacesPluginApi",
"section": "def-common.Space",
"text": "Space"
},
" | undefined; loading: boolean | undefined; error: Error | undefined; }"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_kibana_space.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useLinkProps",
"type": "Function",
"tags": [],
"label": "useLinkProps",
"description": [],
"signature": [
"({ app, pathname, hash, search, state }: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.LinkDescriptor",
"text": "LinkDescriptor"
},
", options?: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.Options",
"text": "Options"
},
") => ",
"LinkProps"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useLinkProps.$1",
"type": "Object",
"tags": [],
"label": "{ app, pathname, hash, search, state }",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.LinkDescriptor",
"text": "LinkDescriptor"
}
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useLinkProps.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.Options",
"text": "Options"
}
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useObservabilityTourContext",
"type": "Function",
"tags": [],
"label": "useObservabilityTourContext",
"description": [],
"signature": [
"() => ",
"ObservabilityTourContextValue"
],
"path": "x-pack/plugins/observability_shared/public/components/tour/tour.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useQuickTimeRanges",
"type": "Function",
"tags": [],
"label": "useQuickTimeRanges",
"description": [],
"signature": [
"() => { start: string; end: string; label: string; }[]"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_quick_time_ranges.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTheme",
"type": "Function",
"tags": [],
"label": "useTheme",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
}
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_theme.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTimeZone",
"type": "Function",
"tags": [],
"label": "useTimeZone",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_time_zone.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTrackMetric",
"type": "Function",
"tags": [],
"label": "useTrackMetric",
"description": [],
"signature": [
"({ app, metric, metricType = METRIC_TYPE.COUNT, delay = 0 }: ",
"TrackMetricOptions",
", effectDependencies: EffectDeps) => void"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTrackMetric.$1",
"type": "CompoundType",
"tags": [],
"label": "{ app, metric, metricType = METRIC_TYPE.COUNT, delay = 0 }",
"description": [],
"signature": [
"TrackMetricOptions"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTrackMetric.$2",
"type": "Array",
"tags": [],
"label": "effectDependencies",
"description": [],
"signature": [
"EffectDeps"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTrackPageview",
"type": "Function",
"tags": [],
"label": "useTrackPageview",
"description": [],
"signature": [
"({ path, ...rest }: TrackPageviewProps, effectDependencies: EffectDeps) => void"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTrackPageview.$1",
"type": "CompoundType",
"tags": [],
"label": "{ path, ...rest }",
"description": [],
"signature": [
"TrackPageviewProps"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useTrackPageview.$2",
"type": "Array",
"tags": [],
"label": "effectDependencies",
"description": [],
"signature": [
"EffectDeps"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUiTracker",
"type": "Function",
"tags": [],
"label": "useUiTracker",
"description": [],
"signature": [
"({\n app: defaultApp,\n}: { app?: ",
"ObservabilityApp",
" | undefined; }) => ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.TrackEvent",
"text": "TrackEvent"
}
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUiTracker.$1",
"type": "Object",
"tags": [],
"label": "{\n app: defaultApp,\n}",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUiTracker.$1.app",
"type": "CompoundType",
"tags": [],
"label": "app",
"description": [],
"signature": [
"ObservabilityApp",
" | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig",
"type": "Interface",
"tags": [],
"label": "ApmIndicesConfig",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig.error",
"type": "string",
"tags": [],
"label": "error",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig.onboarding",
"type": "string",
"tags": [],
"label": "onboarding",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig.span",
"type": "string",
"tags": [],
"label": "span",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig.transaction",
"type": "string",
"tags": [],
"label": "transaction",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig.metric",
"type": "string",
"tags": [],
"label": "metric",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FetcherResult",
"type": "Interface",
"tags": [],
"label": "FetcherResult",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.FetcherResult",
"text": "FetcherResult"
},
"<Data>"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.FetcherResult.data",
"type": "Uncategorized",
"tags": [],
"label": "data",
"description": [],
"signature": [
"Data | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FetcherResult.status",
"type": "Enum",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.FETCH_STATUS",
"text": "FETCH_STATUS"
}
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FetcherResult.error",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FetcherResult.loading",
"type": "CompoundType",
"tags": [],
"label": "loading",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LinkDescriptor",
"type": "Interface",
"tags": [],
"label": "LinkDescriptor",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.LinkDescriptor.app",
"type": "string",
"tags": [],
"label": "app",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LinkDescriptor.pathname",
"type": "string",
"tags": [],
"label": "pathname",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LinkDescriptor.hash",
"type": "string",
"tags": [],
"label": "hash",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LinkDescriptor.search",
"type": "Object",
"tags": [],
"label": "search",
"description": [],
"signature": [
"Search | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LinkDescriptor.state",
"type": "Unknown",
"tags": [],
"label": "state",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry",
"type": "Interface",
"tags": [],
"label": "NavigationEntry",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.app",
"type": "string",
"tags": [],
"label": "app",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.path",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.matchFullPath",
"type": "CompoundType",
"tags": [],
"label": "matchFullPath",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.ignoreTrailingSlash",
"type": "CompoundType",
"tags": [],
"label": "ignoreTrailingSlash",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.onClick",
"type": "Function",
"tags": [],
"label": "onClick",
"description": [],
"signature": [
"((event: React.MouseEvent<HTMLElement | HTMLButtonElement, MouseEvent>) => void) | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.onClick.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.MouseEvent<HTMLElement | HTMLButtonElement, MouseEvent>"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.isNewFeature",
"type": "CompoundType",
"tags": [],
"label": "isNewFeature",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.isTechnicalPreview",
"type": "CompoundType",
"tags": [],
"label": "isTechnicalPreview",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.isBetaFeature",
"type": "CompoundType",
"tags": [],
"label": "isBetaFeature",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.matchPath",
"type": "Function",
"tags": [],
"label": "matchPath",
"description": [],
"signature": [
"((path: string) => boolean) | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationEntry.matchPath.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationSection",
"type": "Interface",
"tags": [],
"label": "NavigationSection",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationSection.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationSection.sortKey",
"type": "number",
"tags": [],
"label": "sortKey",
"description": [],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationSection.entries",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationEntry",
"text": "NavigationEntry"
},
"[]"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.NavigationSection.isBetaFeature",
"type": "CompoundType",
"tags": [],
"label": "isBetaFeature",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.Options",
"type": "Interface",
"tags": [],
"label": "Options",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.Options.hrefOnly",
"type": "CompoundType",
"tags": [],
"label": "hrefOnly",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics",
"type": "Interface",
"tags": [],
"label": "UXMetrics",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.cls",
"type": "CompoundType",
"tags": [],
"label": "cls",
"description": [],
"signature": [
"number | null"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.fid",
"type": "CompoundType",
"tags": [],
"label": "fid",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.lcp",
"type": "CompoundType",
"tags": [],
"label": "lcp",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.tbt",
"type": "number",
"tags": [],
"label": "tbt",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.fcp",
"type": "CompoundType",
"tags": [],
"label": "fcp",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.coreVitalPages",
"type": "number",
"tags": [],
"label": "coreVitalPages",
"description": [],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.lcpRanks",
"type": "Array",
"tags": [],
"label": "lcpRanks",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.fidRanks",
"type": "Array",
"tags": [],
"label": "fidRanks",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.clsRanks",
"type": "Array",
"tags": [],
"label": "clsRanks",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.FETCH_STATUS",
"type": "Enum",
"tags": [],
"label": "FETCH_STATUS",
"description": [],
"path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.METRIC_TYPE",
"type": "Enum",
"tags": [],
"label": "METRIC_TYPE",
"description": [],
"path": "packages/kbn-analytics/src/metrics/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddInspectorRequest",
"type": "Type",
"tags": [],
"label": "AddInspectorRequest",
"description": [],
"signature": [
"(result: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.FetcherResult",
"text": "FetcherResult"
},
"<{ mainStatisticsData?: { _inspect?: InspectResponse | undefined; } | undefined; _inspect?: InspectResponse | undefined; }>) => void"
],
"path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddInspectorRequest.$1",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.FetcherResult",
"text": "FetcherResult"
},
"<{ mainStatisticsData?: { _inspect?: InspectResponse | undefined; } | undefined; _inspect?: InspectResponse | undefined; }>"
],
"path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.casesFeatureId",
"type": "string",
"tags": [],
"label": "casesFeatureId",
"description": [],
"signature": [
"\"observabilityCases\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EMBEDDABLE_FLAMEGRAPH",
"type": "string",
"tags": [],
"label": "EMBEDDABLE_FLAMEGRAPH",
"description": [
"Profiling flamegraph embeddable key"
],
"signature": [
"\"EMBEDDABLE_FLAMEGRAPH\""
],
"path": "x-pack/plugins/observability_shared/public/components/profiling/embeddables/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EMBEDDABLE_FUNCTIONS",
"type": "string",
"tags": [],
"label": "EMBEDDABLE_FUNCTIONS",
"description": [
"Profiling functions embeddable key"
],
"signature": [
"\"EMBEDDABLE_FUNCTIONS\""
],
"path": "x-pack/plugins/observability_shared/public/components/profiling/embeddables/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.LazyObservabilityPageTemplateProps",
"type": "Type",
"tags": [],
"label": "LazyObservabilityPageTemplateProps",
"description": [],
"signature": [
"Pick<",
"KibanaPageTemplateProps",
", \"children\" | \"data-test-subj\" | \"pageHeader\" | \"restrictWidth\" | \"isEmptyState\" | \"noDataConfig\"> & { showSolutionNav?: boolean | undefined; isPageDataLoaded?: boolean | undefined; pageSectionProps?: ",
"EuiPageSectionProps",
" | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ",
"_EuiPageBottomBarProps",
" | undefined; }"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilityActionContextMenuItemProps",
"type": "Type",
"tags": [],
"label": "ObservabilityActionContextMenuItemProps",
"description": [],
"signature": [
"EuiContextMenuItemProps",
" & { children: React.ReactElement<any, string | React.JSXElementConstructor<any>>; }"
],
"path": "x-pack/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.observabilityAppId",
"type": "string",
"tags": [],
"label": "observabilityAppId",
"description": [],
"signature": [
"\"observability-overview\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.observabilityFeatureId",
"type": "string",
"tags": [],
"label": "observabilityFeatureId",
"description": [],
"signature": [
"\"observability\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilityPageTemplateProps",
"type": "Type",
"tags": [],
"label": "ObservabilityPageTemplateProps",
"description": [],
"signature": [
"Omit<",
"ObservabilityPageTemplateDependencies",
", \"isSidebarEnabled$\"> & Pick<",
"KibanaPageTemplateProps",
", \"children\" | \"data-test-subj\" | \"pageHeader\" | \"restrictWidth\" | \"isEmptyState\" | \"noDataConfig\"> & { showSolutionNav?: boolean | undefined; isPageDataLoaded?: boolean | undefined; pageSectionProps?: ",
"EuiPageSectionProps",
" | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ",
"_EuiPageBottomBarProps",
" | undefined; }"
],
"path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPluginSetup",
"type": "Type",
"tags": [],
"label": "ObservabilitySharedPluginSetup",
"description": [],
"signature": [
"{ locators: { profiling: { flamegraphLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"FlamegraphLocatorParams",
">; topNFunctionsLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"TopNFunctionsLocatorParams",
">; stacktracesLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"StacktracesLocatorParams",
">; }; }; navigation: { registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; }"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ObservabilitySharedPluginStart",
"type": "Type",
"tags": [],
"label": "ObservabilitySharedPluginStart",
"description": [],
"signature": [
"{ navigation: { PageTemplate: (pageTemplateProps: ",
"WrappedPageTemplateProps",
") => JSX.Element; registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; updateGlobalNavigation: ({ capabilities, deepLinks, updater$, }: { capabilities: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>; deepLinks: ",
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppDeepLink",
"text": "AppDeepLink"
},
"<string>[]; updater$: ",
"Subject",
"<",
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppUpdater",
"text": "AppUpdater"
},
">; }) => void; setIsSidebarEnabled: (isEnabled: boolean) => void; }"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.observTourStepStorageKey",
"type": "string",
"tags": [],
"label": "observTourStepStorageKey",
"description": [],
"signature": [
"\"guidedOnboarding.observability.tourStep\""
],
"path": "x-pack/plugins/observability_shared/public/components/tour/tour.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ProfilingLocators",
"type": "Type",
"tags": [],
"label": "ProfilingLocators",
"description": [],
"signature": [
"{ flamegraphLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"FlamegraphLocatorParams",
">; topNFunctionsLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"TopNFunctionsLocatorParams",
">; stacktracesLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"StacktracesLocatorParams",
">; }"
],
"path": "x-pack/plugins/observability_shared/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionLinkProps",
"type": "Type",
"tags": [],
"label": "SectionLinkProps",
"description": [],
"signature": [
"CommonProps",
" & Omit<(",
"DisambiguateSet",
"<(",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>), React.HTMLAttributes<HTMLSpanElement>> & React.HTMLAttributes<HTMLSpanElement>) | (",
"DisambiguateSet",
"<React.HTMLAttributes<HTMLSpanElement>, (",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>)> & ((",
"DisambiguateSet",
"<React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">) | (",
"DisambiguateSet",
"<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, \"href\">, React.ButtonHTMLAttributes<HTMLButtonElement>> & React.ButtonHTMLAttributes<HTMLButtonElement>))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"l\" | \"xs\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ",
"IconType",
" | undefined; iconProps?: Omit<",
"EuiIconProps",
", \"type\"> | undefined; icon?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; showToolTip?: boolean | undefined; extraAction?: ",
"EuiListGroupItemExtraActionProps",
" | undefined; onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref<HTMLButtonElement> | undefined; toolTipText?: string | undefined; toolTipProps?: Partial<",
"EuiToolTipProps",
"> | undefined; }"
],
"path": "x-pack/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.sloFeatureId",
"type": "string",
"tags": [],
"label": "sloFeatureId",
"description": [],
"signature": [
"\"slo\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TrackEvent",
"type": "Type",
"tags": [],
"label": "TrackEvent",
"description": [],
"signature": [
"(options: ",
"TrackMetricOptions",
") => void"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.TrackEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TrackOptions & { metric: string; }"
],
"path": "x-pack/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse",
"type": "Function",
"tags": [],
"label": "getInspectResponse",
"description": [
"\nCreate a formatted response to be sent in the _inspect key for use in the\ninspector."
],
"signature": [
"({\n esError,\n esRequestParams,\n esRequestStatus,\n esResponse,\n kibanaRequest,\n operationName,\n startTime,\n}: { esError: ",
"WrappedElasticsearchClientError",
" | null; esRequestParams: Record<string, any>; esRequestStatus: ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestStatus",
"text": "RequestStatus"
},
"; esResponse: any; kibanaRequest: ",
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>; operationName: string; startTime: number; }) => ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Request",
"text": "Request"
}
],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1",
"type": "Object",
"tags": [],
"label": "{\n esError,\n esRequestParams,\n esRequestStatus,\n esResponse,\n kibanaRequest,\n operationName,\n startTime,\n}",
"description": [],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.esError",
"type": "CompoundType",
"tags": [],
"label": "esError",
"description": [],
"signature": [
"WrappedElasticsearchClientError",
" | null"
],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.esRequestParams",
"type": "Object",
"tags": [],
"label": "esRequestParams",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.esRequestStatus",
"type": "Enum",
"tags": [],
"label": "esRequestStatus",
"description": [],
"signature": [
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.RequestStatus",
"text": "RequestStatus"
}
],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.esResponse",
"type": "Any",
"tags": [],
"label": "esResponse",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.kibanaRequest",
"type": "Object",
"tags": [],
"label": "kibanaRequest",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.operationName",
"type": "string",
"tags": [],
"label": "operationName",
"description": [],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.getInspectResponse.$1.startTime",
"type": "number",
"tags": [],
"label": "startTime",
"description": [],
"path": "x-pack/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ObservabilityTriggerId",
"type": "Enum",
"tags": [],
"label": "ObservabilityTriggerId",
"description": [],
"path": "x-pack/plugins/observability_shared/common/trigger_ids.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AGENT",
"type": "string",
"tags": [],
"label": "AGENT",
"description": [],
"signature": [
"\"agent\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AGENT_NAME",
"type": "string",
"tags": [],
"label": "AGENT_NAME",
"description": [],
"signature": [
"\"agent.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AGENT_VERSION",
"type": "string",
"tags": [],
"label": "AGENT_VERSION",
"description": [],
"signature": [
"\"agent.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.casesFeatureId",
"type": "string",
"tags": [],
"label": "casesFeatureId",
"description": [],
"signature": [
"\"observabilityCases\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLIENT_GEO",
"type": "string",
"tags": [],
"label": "CLIENT_GEO",
"description": [],
"signature": [
"\"client.geo\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLIENT_GEO_COUNTRY_ISO_CODE",
"type": "string",
"tags": [],
"label": "CLIENT_GEO_COUNTRY_ISO_CODE",
"description": [],
"signature": [
"\"client.geo.country_iso_code\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLIENT_GEO_COUNTRY_NAME",
"type": "string",
"tags": [],
"label": "CLIENT_GEO_COUNTRY_NAME",
"description": [],
"signature": [
"\"client.geo.country_name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLOUD",
"type": "string",
"tags": [],
"label": "CLOUD",
"description": [],
"signature": [
"\"cloud\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLOUD_AVAILABILITY_ZONE",
"type": "string",
"tags": [],
"label": "CLOUD_AVAILABILITY_ZONE",
"description": [],
"signature": [
"\"cloud.availability_zone\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLOUD_MACHINE_TYPE",
"type": "string",
"tags": [],
"label": "CLOUD_MACHINE_TYPE",
"description": [],
"signature": [
"\"cloud.machine.type\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLOUD_PROVIDER",
"type": "string",
"tags": [],
"label": "CLOUD_PROVIDER",
"description": [],
"signature": [
"\"cloud.provider\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLOUD_REGION",
"type": "string",
"tags": [],
"label": "CLOUD_REGION",
"description": [],
"signature": [
"\"cloud.region\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CLS_FIELD",
"type": "string",
"tags": [],
"label": "CLS_FIELD",
"description": [],
"signature": [
"\"transaction.experience.cls\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.CONTAINER_ID",
"type": "string",
"tags": [],
"label": "CONTAINER_ID",
"description": [],
"signature": [
"\"container.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.DESTINATION_ADDRESS",
"type": "string",
"tags": [],
"label": "DESTINATION_ADDRESS",
"description": [],
"signature": [
"\"destination.address\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_CULPRIT",
"type": "string",
"tags": [],
"label": "ERROR_CULPRIT",
"description": [],
"signature": [
"\"error.culprit\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_EXC_HANDLED",
"type": "string",
"tags": [],
"label": "ERROR_EXC_HANDLED",
"description": [],
"signature": [
"\"error.exception.handled\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_EXC_MESSAGE",
"type": "string",
"tags": [],
"label": "ERROR_EXC_MESSAGE",
"description": [],
"signature": [
"\"error.exception.message\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_EXC_TYPE",
"type": "string",
"tags": [],
"label": "ERROR_EXC_TYPE",
"description": [],
"signature": [
"\"error.exception.type\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_GROUP_ID",
"type": "string",
"tags": [],
"label": "ERROR_GROUP_ID",
"description": [],
"signature": [
"\"error.grouping_key\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_LOG_LEVEL",
"type": "string",
"tags": [],
"label": "ERROR_LOG_LEVEL",
"description": [],
"signature": [
"\"error.log.level\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_LOG_MESSAGE",
"type": "string",
"tags": [],
"label": "ERROR_LOG_MESSAGE",
"description": [],
"signature": [
"\"error.log.message\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ERROR_PAGE_URL",
"type": "string",
"tags": [],
"label": "ERROR_PAGE_URL",
"description": [],
"signature": [
"\"error.page.url\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.EVENT_OUTCOME",
"type": "string",
"tags": [],
"label": "EVENT_OUTCOME",
"description": [],
"signature": [
"\"event.outcome\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FCP_FIELD",
"type": "string",
"tags": [],
"label": "FCP_FIELD",
"description": [],
"signature": [
"\"transaction.marks.agent.firstContentfulPaint\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FID_FIELD",
"type": "string",
"tags": [],
"label": "FID_FIELD",
"description": [],
"signature": [
"\"transaction.experience.fid\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HOST",
"type": "string",
"tags": [],
"label": "HOST",
"description": [],
"signature": [
"\"host\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HOST_HOSTNAME",
"type": "string",
"tags": [],
"label": "HOST_HOSTNAME",
"description": [],
"signature": [
"\"host.hostname\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HOST_OS_PLATFORM",
"type": "string",
"tags": [],
"label": "HOST_OS_PLATFORM",
"description": [],
"signature": [
"\"host.os.platform\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HTTP_REQUEST_METHOD",
"type": "string",
"tags": [],
"label": "HTTP_REQUEST_METHOD",
"description": [],
"signature": [
"\"http.request.method\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HTTP_RESPONSE_STATUS_CODE",
"type": "string",
"tags": [],
"label": "HTTP_RESPONSE_STATUS_CODE",
"description": [],
"signature": [
"\"http.response.status_code\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.KUBERNETES",
"type": "string",
"tags": [],
"label": "KUBERNETES",
"description": [],
"signature": [
"\"kubernetes\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.LABEL_NAME",
"type": "string",
"tags": [],
"label": "LABEL_NAME",
"description": [],
"signature": [
"\"labels.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.LCP_FIELD",
"type": "string",
"tags": [],
"label": "LCP_FIELD",
"description": [],
"signature": [
"\"transaction.marks.agent.largestContentfulPaint\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_CGROUP_MEMORY_LIMIT_BYTES",
"type": "string",
"tags": [],
"label": "METRIC_CGROUP_MEMORY_LIMIT_BYTES",
"description": [],
"signature": [
"\"system.process.cgroup.memory.mem.limit.bytes\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_CGROUP_MEMORY_USAGE_BYTES",
"type": "string",
"tags": [],
"label": "METRIC_CGROUP_MEMORY_USAGE_BYTES",
"description": [],
"signature": [
"\"system.process.cgroup.memory.mem.usage.bytes\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_GC_COUNT",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_GC_COUNT",
"description": [],
"signature": [
"\"jvm.gc.count\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_GC_TIME",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_GC_TIME",
"description": [],
"signature": [
"\"jvm.gc.time\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_HEAP_MEMORY_COMMITTED",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_HEAP_MEMORY_COMMITTED",
"description": [],
"signature": [
"\"jvm.memory.heap.committed\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_HEAP_MEMORY_MAX",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_HEAP_MEMORY_MAX",
"description": [],
"signature": [
"\"jvm.memory.heap.max\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_HEAP_MEMORY_USED",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_HEAP_MEMORY_USED",
"description": [],
"signature": [
"\"jvm.memory.heap.used\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_NON_HEAP_MEMORY_COMMITTED",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_NON_HEAP_MEMORY_COMMITTED",
"description": [],
"signature": [
"\"jvm.memory.non_heap.committed\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_NON_HEAP_MEMORY_MAX",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_NON_HEAP_MEMORY_MAX",
"description": [],
"signature": [
"\"jvm.memory.non_heap.max\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_NON_HEAP_MEMORY_USED",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_NON_HEAP_MEMORY_USED",
"description": [],
"signature": [
"\"jvm.memory.non_heap.used\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_JAVA_THREAD_COUNT",
"type": "string",
"tags": [],
"label": "METRIC_JAVA_THREAD_COUNT",
"description": [],
"signature": [
"\"jvm.thread.count\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_PROCESS_CPU_PERCENT",
"type": "string",
"tags": [],
"label": "METRIC_PROCESS_CPU_PERCENT",
"description": [],
"signature": [
"\"system.process.cpu.total.norm.pct\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_SYSTEM_CPU_PERCENT",
"type": "string",
"tags": [],
"label": "METRIC_SYSTEM_CPU_PERCENT",
"description": [],
"signature": [
"\"system.cpu.total.norm.pct\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_SYSTEM_CPU_USAGE",
"type": "string",
"tags": [],
"label": "METRIC_SYSTEM_CPU_USAGE",
"description": [],
"signature": [
"\"system.cpu.usage\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_SYSTEM_FREE_MEMORY",
"type": "string",
"tags": [],
"label": "METRIC_SYSTEM_FREE_MEMORY",
"description": [],
"signature": [
"\"system.memory.actual.free\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_SYSTEM_MEMORY_USAGE",
"type": "string",
"tags": [],
"label": "METRIC_SYSTEM_MEMORY_USAGE",
"description": [],
"signature": [
"\"system.memory.usage\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRIC_SYSTEM_TOTAL_MEMORY",
"type": "string",
"tags": [],
"label": "METRIC_SYSTEM_TOTAL_MEMORY",
"description": [],
"signature": [
"\"system.memory.total\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.NETWORK_TIMINGS_FIELDS",
"type": "Array",
"tags": [],
"label": "NETWORK_TIMINGS_FIELDS",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.observabilityAppId",
"type": "string",
"tags": [],
"label": "observabilityAppId",
"description": [],
"signature": [
"\"observability-overview\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.observabilityFeatureId",
"type": "string",
"tags": [],
"label": "observabilityFeatureId",
"description": [],
"signature": [
"\"observability\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.OBSERVER_HOSTNAME",
"type": "string",
"tags": [],
"label": "OBSERVER_HOSTNAME",
"description": [],
"signature": [
"\"observer.hostname\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.OBSERVER_LISTENING",
"type": "string",
"tags": [],
"label": "OBSERVER_LISTENING",
"description": [],
"signature": [
"\"observer.listening\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.OBSERVER_VERSION_MAJOR",
"type": "string",
"tags": [],
"label": "OBSERVER_VERSION_MAJOR",
"description": [],
"signature": [
"\"observer.version_major\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PARENT_ID",
"type": "string",
"tags": [],
"label": "PARENT_ID",
"description": [],
"signature": [
"\"parent.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.POD_NAME",
"type": "string",
"tags": [],
"label": "POD_NAME",
"description": [],
"signature": [
"\"kubernetes.pod.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROCESSOR_EVENT",
"type": "string",
"tags": [],
"label": "PROCESSOR_EVENT",
"description": [],
"signature": [
"\"processor.event\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_ALLOC_OBJECTS",
"type": "string",
"tags": [],
"label": "PROFILE_ALLOC_OBJECTS",
"description": [],
"signature": [
"\"profile.alloc_objects.count\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_ALLOC_SPACE",
"type": "string",
"tags": [],
"label": "PROFILE_ALLOC_SPACE",
"description": [],
"signature": [
"\"profile.alloc_space.bytes\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_CPU_NS",
"type": "string",
"tags": [],
"label": "PROFILE_CPU_NS",
"description": [],
"signature": [
"\"profile.cpu.ns\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_DURATION",
"type": "string",
"tags": [],
"label": "PROFILE_DURATION",
"description": [],
"signature": [
"\"profile.duration\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_ID",
"type": "string",
"tags": [],
"label": "PROFILE_ID",
"description": [],
"signature": [
"\"profile.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_INUSE_OBJECTS",
"type": "string",
"tags": [],
"label": "PROFILE_INUSE_OBJECTS",
"description": [],
"signature": [
"\"profile.inuse_objects.count\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_INUSE_SPACE",
"type": "string",
"tags": [],
"label": "PROFILE_INUSE_SPACE",
"description": [],
"signature": [
"\"profile.inuse_space.bytes\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_SAMPLES_COUNT",
"type": "string",
"tags": [],
"label": "PROFILE_SAMPLES_COUNT",
"description": [],
"signature": [
"\"profile.samples.count\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_STACK",
"type": "string",
"tags": [],
"label": "PROFILE_STACK",
"description": [],
"signature": [
"\"profile.stack\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_TOP_ID",
"type": "string",
"tags": [],
"label": "PROFILE_TOP_ID",
"description": [],
"signature": [
"\"profile.top.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.PROFILE_WALL_US",
"type": "string",
"tags": [],
"label": "PROFILE_WALL_US",
"description": [],
"signature": [
"\"profile.wall.us\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE",
"type": "string",
"tags": [],
"label": "SERVICE",
"description": [],
"signature": [
"\"service\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_ENVIRONMENT",
"type": "string",
"tags": [],
"label": "SERVICE_ENVIRONMENT",
"description": [],
"signature": [
"\"service.environment\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_FRAMEWORK_NAME",
"type": "string",
"tags": [],
"label": "SERVICE_FRAMEWORK_NAME",
"description": [],
"signature": [
"\"service.framework.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_FRAMEWORK_VERSION",
"type": "string",
"tags": [],
"label": "SERVICE_FRAMEWORK_VERSION",
"description": [],
"signature": [
"\"service.framework.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_LANGUAGE_NAME",
"type": "string",
"tags": [],
"label": "SERVICE_LANGUAGE_NAME",
"description": [],
"signature": [
"\"service.language.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_LANGUAGE_VERSION",
"type": "string",
"tags": [],
"label": "SERVICE_LANGUAGE_VERSION",
"description": [],
"signature": [
"\"service.language.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_NAME",
"type": "string",
"tags": [],
"label": "SERVICE_NAME",
"description": [],
"signature": [
"\"service.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_NODE_NAME",
"type": "string",
"tags": [],
"label": "SERVICE_NODE_NAME",
"description": [],
"signature": [
"\"service.node.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_RUNTIME_NAME",
"type": "string",
"tags": [],
"label": "SERVICE_RUNTIME_NAME",
"description": [],
"signature": [
"\"service.runtime.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_RUNTIME_VERSION",
"type": "string",
"tags": [],
"label": "SERVICE_RUNTIME_VERSION",
"description": [],
"signature": [
"\"service.runtime.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_VERSION",
"type": "string",
"tags": [],
"label": "SERVICE_VERSION",
"description": [],
"signature": [
"\"service.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.sloFeatureId",
"type": "string",
"tags": [],
"label": "sloFeatureId",
"description": [],
"signature": [
"\"slo\""
],
"path": "x-pack/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_ACTION",
"type": "string",
"tags": [],
"label": "SPAN_ACTION",
"description": [],
"signature": [
"\"span.action\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_DESTINATION_SERVICE_RESOURCE",
"type": "string",
"tags": [],
"label": "SPAN_DESTINATION_SERVICE_RESOURCE",
"description": [],
"signature": [
"\"span.destination.service.resource\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_DESTINATION_SERVICE_RESPONSE_TIME_COUNT",
"type": "string",
"tags": [],
"label": "SPAN_DESTINATION_SERVICE_RESPONSE_TIME_COUNT",
"description": [],
"signature": [
"\"span.destination.service.response_time.count\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_DESTINATION_SERVICE_RESPONSE_TIME_SUM",
"type": "string",
"tags": [],
"label": "SPAN_DESTINATION_SERVICE_RESPONSE_TIME_SUM",
"description": [],
"signature": [
"\"span.destination.service.response_time.sum.us\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_DURATION",
"type": "string",
"tags": [],
"label": "SPAN_DURATION",
"description": [],
"signature": [
"\"span.duration.us\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_ID",
"type": "string",
"tags": [],
"label": "SPAN_ID",
"description": [],
"signature": [
"\"span.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_NAME",
"type": "string",
"tags": [],
"label": "SPAN_NAME",
"description": [],
"signature": [
"\"span.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_SELF_TIME_SUM",
"type": "string",
"tags": [],
"label": "SPAN_SELF_TIME_SUM",
"description": [],
"signature": [
"\"span.self_time.sum.us\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_SUBTYPE",
"type": "string",
"tags": [],
"label": "SPAN_SUBTYPE",
"description": [],
"signature": [
"\"span.subtype\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SPAN_TYPE",
"type": "string",
"tags": [],
"label": "SPAN_TYPE",
"description": [],
"signature": [
"\"span.type\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_BLOCKED_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_BLOCKED_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.blocked\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_CONNECT_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_CONNECT_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.connect\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_DNS_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_DNS_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.dns\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_RECEIVE_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_RECEIVE_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.receive\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_SEND_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_SEND_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.send\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_SSL_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_SSL_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.ssl\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_TOTAL_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_TOTAL_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.total\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SYNTHETICS_WAIT_TIMINGS",
"type": "string",
"tags": [],
"label": "SYNTHETICS_WAIT_TIMINGS",
"description": [],
"signature": [
"\"synthetics.payload.timings.wait\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TBT_FIELD",
"type": "string",
"tags": [],
"label": "TBT_FIELD",
"description": [],
"signature": [
"\"transaction.experience.tbt\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRACE_ID",
"type": "string",
"tags": [],
"label": "TRACE_ID",
"description": [],
"signature": [
"\"trace.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_DOM_INTERACTIVE",
"type": "string",
"tags": [],
"label": "TRANSACTION_DOM_INTERACTIVE",
"description": [],
"signature": [
"\"transaction.marks.agent.domInteractive\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_DURATION",
"type": "string",
"tags": [],
"label": "TRANSACTION_DURATION",
"description": [],
"signature": [
"\"transaction.duration.us\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_DURATION_HISTOGRAM",
"type": "string",
"tags": [],
"label": "TRANSACTION_DURATION_HISTOGRAM",
"description": [],
"signature": [
"\"transaction.duration.histogram\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_ID",
"type": "string",
"tags": [],
"label": "TRANSACTION_ID",
"description": [],
"signature": [
"\"transaction.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_NAME",
"type": "string",
"tags": [],
"label": "TRANSACTION_NAME",
"description": [],
"signature": [
"\"transaction.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_PAGE_URL",
"type": "string",
"tags": [],
"label": "TRANSACTION_PAGE_URL",
"description": [],
"signature": [
"\"transaction.page.url\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_RESULT",
"type": "string",
"tags": [],
"label": "TRANSACTION_RESULT",
"description": [],
"signature": [
"\"transaction.result\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_ROOT",
"type": "string",
"tags": [],
"label": "TRANSACTION_ROOT",
"description": [],
"signature": [
"\"transaction.root\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_SAMPLED",
"type": "string",
"tags": [],
"label": "TRANSACTION_SAMPLED",
"description": [],
"signature": [
"\"transaction.sampled\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_TIME_TO_FIRST_BYTE",
"type": "string",
"tags": [],
"label": "TRANSACTION_TIME_TO_FIRST_BYTE",
"description": [],
"signature": [
"\"transaction.marks.agent.timeToFirstByte\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_TYPE",
"type": "string",
"tags": [],
"label": "TRANSACTION_TYPE",
"description": [],
"signature": [
"\"transaction.type\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_URL",
"type": "string",
"tags": [],
"label": "TRANSACTION_URL",
"description": [],
"signature": [
"\"url.full\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.URL_FULL",
"type": "string",
"tags": [],
"label": "URL_FULL",
"description": [],
"signature": [
"\"url.full\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_AGENT_DEVICE",
"type": "string",
"tags": [],
"label": "USER_AGENT_DEVICE",
"description": [],
"signature": [
"\"user_agent.device.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_AGENT_NAME",
"type": "string",
"tags": [],
"label": "USER_AGENT_NAME",
"description": [],
"signature": [
"\"user_agent.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_AGENT_ORIGINAL",
"type": "string",
"tags": [],
"label": "USER_AGENT_ORIGINAL",
"description": [],
"signature": [
"\"user_agent.original\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_AGENT_OS",
"type": "string",
"tags": [],
"label": "USER_AGENT_OS",
"description": [],
"signature": [
"\"user_agent.os.name\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_AGENT_OS_VERSION",
"type": "string",
"tags": [],
"label": "USER_AGENT_OS_VERSION",
"description": [],
"signature": [
"\"user_agent.os.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_AGENT_VERSION",
"type": "string",
"tags": [],
"label": "USER_AGENT_VERSION",
"description": [],
"signature": [
"\"user_agent.version\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.USER_ID",
"type": "string",
"tags": [],
"label": "USER_ID",
"description": [],
"signature": [
"\"user.id\""
],
"path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}