github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/observability_shared.devdocs.json

9437 lines
No EOL
348 KiB
JSON
Raw Permalink Blame History

{
"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 ",
"Plugin",
"<void, void, never, never>"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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: ",
"CoreSetup",
"<{}, unknown>, pluginsSetup: ",
"ObservabilitySharedSetup",
") => { registerProfilingComponent: <T>(key: string, component: React.FC<T>) => void; locators: ObservabilitySharedLocators; navigation: { registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; }"
],
"path": "x-pack/solutions/observability/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": [
"CoreSetup",
"<{}, unknown>"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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: ",
"CoreStart",
", plugins: ",
"ObservabilitySharedStart",
") => { locators: ObservabilitySharedLocators; navigation: { PageTemplate: (pageTemplateProps: ",
"WrappedPageTemplateProps",
") => React.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; }>; discover?: Readonly<{}> | undefined; dashboard?: Readonly<{}> | undefined; maps?: Readonly<{}> | undefined; visualize?: Readonly<{}> | undefined; }>; deepLinks: ",
"AppDeepLink",
"<string>[]; updater$: ",
"Subject",
"<",
"AppUpdater",
">; }) => void; }"
],
"path": "x-pack/solutions/observability/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": [
"CoreStart"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"() => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/action_menu/action_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanel",
"type": "Function",
"tags": [],
"label": "AddDataPanel",
"description": [],
"signature": [
"({\n content,\n actions,\n onDismiss,\n onLearnMore,\n onTryIt,\n onAddData,\n 'data-test-subj': dataTestSubj,\n}: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.AddDataPanelProps",
"text": "AddDataPanelProps"
},
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanel.$1",
"type": "Object",
"tags": [],
"label": "{\n content,\n actions,\n onDismiss,\n onLearnMore,\n onTryIt,\n onAddData,\n 'data-test-subj': dataTestSubj,\n}",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.AddDataPanelProps",
"text": "AddDataPanelProps"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.allCasesPermissions",
"type": "Function",
"tags": [],
"label": "allCasesPermissions",
"description": [],
"signature": [
"() => { all: boolean; create: boolean; read: boolean; update: boolean; delete: boolean; push: boolean; connectors: boolean; settings: boolean; createComment: boolean; reopenCase: boolean; assign: boolean; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/utils/cases_permissions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.BottomBarActions",
"type": "Function",
"tags": [],
"label": "BottomBarActions",
"description": [],
"signature": [
"({ isLoading, onDiscardChanges, onSave, unsavedChangesCount, saveLabel, appTestSubj, areChangesInvalid, }: Props) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/bottom_bar_actions/bottom_bar_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.BottomBarActions.$1",
"type": "Object",
"tags": [],
"label": "{\n isLoading,\n onDiscardChanges,\n onSave,\n unsavedChangesCount,\n saveLabel,\n appTestSubj,\n areChangesInvalid = false,\n}",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/bottom_bar_actions/bottom_bar_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.createEsParams",
"type": "Function",
"tags": [],
"label": "createEsParams",
"description": [],
"signature": [
"(params: T) => T"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"({ height, ...props }: Props) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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": "{ height, ...props }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/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) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_functions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableFunctions.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_functions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBar",
"type": "Function",
"tags": [],
"label": "EmbeddableProfilingSearchBar",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.EmbeddableProfilingSearchBarProps",
"text": "EmbeddableProfilingSearchBarProps"
},
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBar.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.EmbeddableProfilingSearchBarProps",
"text": "EmbeddableProfilingSearchBarProps"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableStackTraces",
"type": "Function",
"tags": [],
"label": "EmbeddableStackTraces",
"description": [],
"signature": [
"(props: Props) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_stack_traces.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableStackTraces.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_stack_traces.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ExternalResourceLinks",
"type": "Function",
"tags": [],
"label": "ExternalResourceLinks",
"description": [],
"signature": [
"() => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/external_resource_links/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FeatureFeedbackButton",
"type": "Function",
"tags": [],
"label": "FeatureFeedbackButton",
"description": [],
"signature": [
"({ formUrl, formConfig, \"data-test-subj\": dts, onClickCapture, defaultButton, kibanaVersion, isCloudEnv, isServerlessEnv, sanitizedPath, nodeType, surveyButtonText, }: FeatureFeedbackButtonProps) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.FeatureFeedbackButton.$1",
"type": "Object",
"tags": [],
"label": "{\n formUrl,\n formConfig,\n 'data-test-subj': dts,\n onClickCapture,\n defaultButton,\n kibanaVersion,\n isCloudEnv,\n isServerlessEnv,\n sanitizedPath,\n nodeType,\n surveyButtonText = (\n <FormattedMessage\n id=\"xpack.observabilityShared.featureFeedbackButton.tellUsWhatYouThinkLink\"\n defaultMessage=\"Tell us what you think!\"\n />\n ),\n}",
"description": [],
"signature": [
"FeatureFeedbackButtonProps"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FieldValueSelection",
"type": "Function",
"tags": [],
"label": "FieldValueSelection",
"description": [],
"signature": [
"(props: ",
"FieldValueSelectionProps",
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.FieldValueSelection.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FieldValueSelectionProps"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.FieldValueSuggestions",
"type": "Function",
"tags": [],
"label": "FieldValueSuggestions",
"description": [],
"signature": [
"(props: ",
"FieldValueSuggestionsProps",
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.FieldValueSuggestions.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FieldValueSuggestionsProps"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/index.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.UiActionsPublicStart",
"text": "UiActionsPublicStart"
},
"; 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/solutions/observability/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/solutions/observability/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 registerTrigger: (trigger: ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Trigger",
"text": "Trigger"
},
") => void; readonly hasTrigger: (triggerId: string) => boolean; readonly getTrigger: (triggerId: string) => ",
"TriggerContract",
"<object>; 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 registerActionAsync: <Context extends object>(id: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>>) => void; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly addTriggerActionAsync: (triggerId: string, actionId: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>>) => void; readonly getAction: (id: string) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>>; readonly getTriggerActions: (triggerId: string) => Promise<",
{
"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 getFrequentlyChangingActionsForTrigger: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.FrequentCompatibilityChangeAction",
"text": "FrequentCompatibilityChangeAction"
},
"<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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/public/services/get_context_menu_items_from_actions.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL",
"type": "Function",
"tags": [],
"label": "getSurveyFeedbackURL",
"description": [],
"signature": [
"({ formUrl, formConfig, kibanaVersion, sanitizedPath, isCloudEnv, isServerlessEnv, nodeType, }: { formUrl: string; formConfig?: ",
"FormConfig",
" | undefined; kibanaVersion?: string | undefined; deploymentType?: string | undefined; sanitizedPath?: string | undefined; mlJobType?: string | undefined; isCloudEnv?: boolean | undefined; isServerlessEnv?: boolean | undefined; nodeType?: ",
"NodeType",
" | undefined; }) => string"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1",
"type": "Object",
"tags": [],
"label": "{\n formUrl,\n formConfig,\n kibanaVersion,\n sanitizedPath,\n isCloudEnv,\n isServerlessEnv,\n nodeType,\n}",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.formUrl",
"type": "string",
"tags": [],
"label": "formUrl",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.formConfig",
"type": "Object",
"tags": [],
"label": "formConfig",
"description": [],
"signature": [
"FormConfig",
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.kibanaVersion",
"type": "string",
"tags": [],
"label": "kibanaVersion",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.deploymentType",
"type": "string",
"tags": [],
"label": "deploymentType",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.sanitizedPath",
"type": "string",
"tags": [],
"label": "sanitizedPath",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.mlJobType",
"type": "string",
"tags": [],
"label": "mlJobType",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.isCloudEnv",
"type": "CompoundType",
"tags": [],
"label": "isCloudEnv",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.isServerlessEnv",
"type": "CompoundType",
"tags": [],
"label": "isServerlessEnv",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.getSurveyFeedbackURL.$1.nodeType",
"type": "CompoundType",
"tags": [],
"label": "nodeType",
"description": [],
"signature": [
"NodeType",
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/feature_feedback_button/feature_feedback_button.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.HeaderMenuPortal",
"type": "Function",
"tags": [],
"label": "HeaderMenuPortal",
"description": [],
"signature": [
"(props: ",
"HeaderMenuPortalProps",
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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; }) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "x-pack/solutions/observability/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",
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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; }) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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; settings: boolean; createComment: boolean; reopenCase: boolean; assign: boolean; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/utils/cases_permissions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ProfilingEmptyState",
"type": "Function",
"tags": [],
"label": "ProfilingEmptyState",
"description": [],
"signature": [
"() => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/profiling_empty_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.Prompt",
"type": "Function",
"tags": [],
"label": "Prompt",
"description": [],
"signature": [
"({ prompt }: Props) => null"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/navigation_warning_prompt/prompt.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.Prompt.$1",
"type": "Object",
"tags": [],
"label": "{ prompt }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"({ ...props }: ",
"EuiListGroupItemProps",
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.SectionLink.$1",
"type": "CompoundType",
"tags": [],
"label": "{ ...props }",
"description": [],
"signature": [
"EuiListGroupItemProps"
],
"path": "x-pack/solutions/observability/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; }) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"() => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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; }) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "x-pack/solutions/observability/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; }) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "x-pack/solutions/observability/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<HTMLButtonElement | HTMLAnchorElement, MouseEvent>) => boolean"
],
"path": "x-pack/solutions/observability/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<HTMLButtonElement | HTMLAnchorElement, MouseEvent>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsList",
"type": "Function",
"tags": [],
"label": "TagsList",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.TagsListProps",
"text": "TagsListProps"
},
") => React.JSX.Element"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list_lazy.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsList.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.TagsListProps",
"text": "TagsListProps"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list_lazy.tsx",
"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) => React.JSX.Element"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": [
"\n\nBy default the breadcrumbs will be passed to either serverless.setBreadcrumbs or chrome.setBreadcrumbs depending on the\nenvironment. The breadcrumbs will *also* be passed to the project style breadcrumbs for stateful project style. We will use \"project style\"\nhere to refer to serverless chrome and stateful project style chrome. Classic refers to stateful classic chrome.\n\nProject style breadcrumbs add a root crumb (\"deployment\" etc) and \"nav crumbs\" which are derived from the navigation structure. By default\nthe \"absolute\" mode is used which means the breadcrumbs passed here will omit the navigation derived \"nav crumbs\". You can pass\nabsoluteProjectStyleBreadcrumbs: false to include the 'smart' \"nav crumbs\".\n\nIn classic mode (not project style) the 'Observability' crumb is added.\n\nYou can also pass classicOnly to only set breadrumbs in the classic chrome context. This can be useful if your solution just wants to defer all project style crumbs to the \"nav crumbs\"."
],
"signature": [
"(extraCrumbs: ",
"ChromeBreadcrumb",
"[], options?: { app?: { id: string; label: string; } | undefined; breadcrumbsAppendExtension?: ",
"ChromeBreadcrumbsAppendExtension",
" | undefined; serverless?: ",
{
"pluginId": "serverless",
"scope": "public",
"docId": "kibServerlessPluginApi",
"section": "def-public.ServerlessPluginStart",
"text": "ServerlessPluginStart"
},
" | undefined; absoluteProjectStyleBreadcrumbs?: boolean | undefined; classicOnly?: boolean | undefined; } | undefined) => void"
],
"path": "x-pack/solutions/observability/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": [
"ChromeBreadcrumb",
"[]"
],
"path": "x-pack/solutions/observability/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": "options",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.app",
"type": "Object",
"tags": [],
"label": "app",
"description": [],
"signature": [
"{ id: string; label: string; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.breadcrumbsAppendExtension",
"type": "Object",
"tags": [],
"label": "breadcrumbsAppendExtension",
"description": [],
"signature": [
"ChromeBreadcrumbsAppendExtension",
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.serverless",
"type": "Object",
"tags": [],
"label": "serverless",
"description": [],
"signature": [
{
"pluginId": "serverless",
"scope": "public",
"docId": "kibServerlessPluginApi",
"section": "def-public.ServerlessPluginStart",
"text": "ServerlessPluginStart"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.absoluteProjectStyleBreadcrumbs",
"type": "CompoundType",
"tags": [],
"label": "absoluteProjectStyleBreadcrumbs",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useBreadcrumbs.$2.classicOnly",
"type": "CompoundType",
"tags": [],
"label": "classicOnly",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_breadcrumbs.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useChartThemes",
"type": "Function",
"tags": [],
"label": "useChartThemes",
"description": [],
"signature": [
"() => { baseTheme: ",
"Theme",
"; theme: ",
"RecursivePartial",
"<",
"Theme",
">[]; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_chart_theme.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useControlPanels",
"type": "Function",
"tags": [],
"label": "useControlPanels",
"description": [],
"signature": [
"(controlPanelConfigs: { [x: string]: { order: number; type: string; } & { width?: \"small\" | \"medium\" | \"large\" | undefined; grow?: boolean | undefined; dataViewId?: string | undefined; fieldName?: string | undefined; title?: string | undefined; selectedOptions?: string[] | undefined; }; }, dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined) => [{ [x: string]: { order: number; type: string; } & { width?: \"small\" | \"medium\" | \"large\" | undefined; grow?: boolean | undefined; dataViewId?: string | undefined; fieldName?: string | undefined; title?: string | undefined; selectedOptions?: string[] | undefined; }; }, (state: { [x: string]: { order: number; type: string; } & { width?: \"small\" | \"medium\" | \"large\" | undefined; grow?: boolean | undefined; dataViewId?: string | undefined; fieldName?: string | undefined; title?: string | undefined; selectedOptions?: string[] | undefined; }; }) => void]"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_control_panels_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useControlPanels.$1",
"type": "Object",
"tags": [],
"label": "controlPanelConfigs",
"description": [],
"signature": [
"{ [x: string]: { order: number; type: string; } & { width?: \"small\" | \"medium\" | \"large\" | undefined; grow?: boolean | undefined; dataViewId?: string | undefined; fieldName?: string | undefined; title?: string | undefined; selectedOptions?: string[] | undefined; }; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_control_panels_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useControlPanels.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_control_panels_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEditableSettings",
"type": "Function",
"tags": [],
"label": "useEditableSettings",
"description": [],
"signature": [
"(settingsKeys: string[]) => { fields: Record<string, ",
{
"pluginId": "@kbn/management-settings-types",
"scope": "public",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-public.FieldDefinition",
"text": "FieldDefinition"
},
"<",
"UiSettingsType",
", string | number | boolean | (string | number)[] | null | undefined>>; unsavedChanges: Record<string, ",
{
"pluginId": "@kbn/management-settings-types",
"scope": "public",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-public.UnsavedFieldChange",
"text": "UnsavedFieldChange"
},
"<",
"UiSettingsType",
">>; handleFieldChange: ",
{
"pluginId": "@kbn/management-settings-types",
"scope": "public",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-public.OnFieldChangeFn",
"text": "OnFieldChangeFn"
},
"<",
"UiSettingsType",
">; saveAll: () => Promise<void>; isSaving: boolean; cleanUnsavedChanges: () => void; saveSingleSetting: (id: string, change: string | number | boolean | (string | number)[] | null | undefined) => Promise<void>; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_editable_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useEditableSettings.$1",
"type": "Array",
"tags": [],
"label": "settingsKeys",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_editable_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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; error?: Error | undefined; }"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/public/hooks/use_fetcher.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useInspectorContext",
"type": "Function",
"tags": [],
"label": "useInspectorContext",
"description": [],
"signature": [
"() => ",
"InspectorContextValue"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/contexts/inspector/use_inspector_context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useKibanaQuerySettings",
"type": "Function",
"tags": [],
"label": "useKibanaQuerySettings",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.EsQueryConfig",
"text": "EsQueryConfig"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_kibana_query_settings.ts",
"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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/public/hooks/use_track_metric.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState",
"type": "Function",
"tags": [],
"label": "useUrlState",
"description": [],
"signature": [
"<State>({ defaultState, decodeUrlState, encodeUrlState, urlStateKey, writeDefaultState, }: { defaultState: State; decodeUrlState: (value: ",
{
"pluginId": "@kbn/rison",
"scope": "common",
"docId": "kibKbnRisonPluginApi",
"section": "def-common.RisonValue",
"text": "RisonValue"
},
" | undefined) => State | undefined; encodeUrlState: (value: State) => ",
{
"pluginId": "@kbn/rison",
"scope": "common",
"docId": "kibKbnRisonPluginApi",
"section": "def-common.RisonValue",
"text": "RisonValue"
},
" | undefined; urlStateKey: string; writeDefaultState?: boolean | undefined; }) => [State, (patch: State | ((prevState: State) => State) | undefined) => void]"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1",
"type": "Object",
"tags": [],
"label": "{\n defaultState,\n decodeUrlState,\n encodeUrlState,\n urlStateKey,\n writeDefaultState = false,\n}",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.defaultState",
"type": "Uncategorized",
"tags": [],
"label": "defaultState",
"description": [],
"signature": [
"State"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.decodeUrlState",
"type": "Function",
"tags": [],
"label": "decodeUrlState",
"description": [],
"signature": [
"(value: ",
{
"pluginId": "@kbn/rison",
"scope": "common",
"docId": "kibKbnRisonPluginApi",
"section": "def-common.RisonValue",
"text": "RisonValue"
},
" | undefined) => State | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.decodeUrlState.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/rison",
"scope": "common",
"docId": "kibKbnRisonPluginApi",
"section": "def-common.RisonValue",
"text": "RisonValue"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.encodeUrlState",
"type": "Function",
"tags": [],
"label": "encodeUrlState",
"description": [],
"signature": [
"(value: State) => ",
{
"pluginId": "@kbn/rison",
"scope": "common",
"docId": "kibKbnRisonPluginApi",
"section": "def-common.RisonValue",
"text": "RisonValue"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.encodeUrlState.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"State"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.urlStateKey",
"type": "string",
"tags": [],
"label": "urlStateKey",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useUrlState.$1.writeDefaultState",
"type": "CompoundType",
"tags": [],
"label": "writeDefaultState",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_url_state.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.useValuesList",
"type": "Function",
"tags": [],
"label": "useValuesList",
"description": [],
"signature": [
"({ sourceField, dataViewTitle, query, filters, time, label, keepHistory, cardinalityField, }: ",
"Props",
") => { values: ",
"ListItem",
"[]; loading?: boolean | undefined; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_values_list.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.useValuesList.$1",
"type": "Object",
"tags": [],
"label": "{\n sourceField,\n dataViewTitle,\n query = '',\n filters,\n time,\n label,\n keepHistory,\n cardinalityField,\n}",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_values_list.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps",
"type": "Interface",
"tags": [],
"label": "AddDataPanelProps",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.content",
"type": "Object",
"tags": [],
"label": "content",
"description": [],
"signature": [
"AddDataPanelContent"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.onDismiss",
"type": "Function",
"tags": [],
"label": "onDismiss",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.onAddData",
"type": "Function",
"tags": [],
"label": "onAddData",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.onTryIt",
"type": "Function",
"tags": [],
"label": "onTryIt",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.onLearnMore",
"type": "Function",
"tags": [],
"label": "onLearnMore",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"{ primary: Required<AddDataPanelButton>; secondary?: AddDataPanelButton | undefined; link: AddDataPanelButton; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.AddDataPanelProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/add_data_panel/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ApmIndicesConfig",
"type": "Interface",
"tags": [],
"label": "ApmIndicesConfig",
"description": [],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps",
"type": "Interface",
"tags": [],
"label": "EmbeddableProfilingSearchBarProps",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.kuery",
"type": "string",
"tags": [],
"label": "kuery",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.showDatePicker",
"type": "CompoundType",
"tags": [],
"label": "showDatePicker",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.onQuerySubmit",
"type": "Function",
"tags": [],
"label": "onQuerySubmit",
"description": [],
"signature": [
"(params: { dateRange: { from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }; query: string; }) => void"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.onQuerySubmit.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.onQuerySubmit.$1.dateRange",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.onQuerySubmit.$1.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.onRefresh",
"type": "Function",
"tags": [],
"label": "onRefresh",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EmbeddableProfilingSearchBarProps.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/embeddable_profiling_search_bar.tsx",
"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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/public/hooks/use_link_props.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps",
"type": "Interface",
"tags": [],
"label": "TagsListProps",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.onClick",
"type": "Function",
"tags": [],
"label": "onClick",
"description": [],
"signature": [
"((tag: string) => void) | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.onClick.$1",
"type": "string",
"tags": [],
"label": "tag",
"description": [],
"signature": [
"string"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.numberOfTagsToDisplay",
"type": "number",
"tags": [],
"label": "numberOfTagsToDisplay",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.ignoreEmpty",
"type": "CompoundType",
"tags": [],
"label": "ignoreEmpty",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.TagsListProps.disableExpand",
"type": "CompoundType",
"tags": [],
"label": "disableExpand",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/tags_list/tags_list.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics",
"type": "Interface",
"tags": [],
"label": "UXMetrics",
"description": [],
"path": "x-pack/solutions/observability/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 | undefined"
],
"path": "x-pack/solutions/observability/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/solutions/observability/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.tbt",
"type": "number",
"tags": [],
"label": "tbt",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/solutions/observability/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/solutions/observability/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.coreVitalPages",
"type": "number",
"tags": [],
"label": "coreVitalPages",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/solutions/observability/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[] | undefined"
],
"path": "x-pack/solutions/observability/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[] | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.inp",
"type": "CompoundType",
"tags": [],
"label": "inp",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.hasINP",
"type": "CompoundType",
"tags": [],
"label": "hasINP",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.UXMetrics.inpRanks",
"type": "Array",
"tags": [],
"label": "inpRanks",
"description": [],
"signature": [
"number[] | undefined"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": "src/platform/packages/shared/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"
},
"<",
"InspectorRequestProps",
">) => void"
],
"path": "x-pack/solutions/observability/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"
},
"<",
"InspectorRequestProps",
">"
],
"path": "x-pack/solutions/observability/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": [
"\"observabilityCasesV3\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.ControlPanels",
"type": "Type",
"tags": [],
"label": "ControlPanels",
"description": [],
"signature": [
"{ [x: string]: { order: number; type: string; } & { width?: \"small\" | \"medium\" | \"large\" | undefined; grow?: boolean | undefined; dataViewId?: string | undefined; fieldName?: string | undefined; title?: string | undefined; selectedOptions?: string[] | undefined; }; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/hooks/use_control_panels_url_state.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/solutions/observability/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/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EMBEDDABLE_PROFILING_SEARCH_BAR",
"type": "string",
"tags": [],
"label": "EMBEDDABLE_PROFILING_SEARCH_BAR",
"description": [
"Profiling search bar embeddable key"
],
"signature": [
"\"EMBEDDABLE_PROFILING_SEARCH_BAR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/profiling/embeddables/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.EMBEDDABLE_STACK_TRACES",
"type": "string",
"tags": [],
"label": "EMBEDDABLE_STACK_TRACES",
"description": [
"Profiling threads embeddable key"
],
"signature": [
"\"EMBEDDABLE_STACK_TRACES\""
],
"path": "x-pack/solutions/observability/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",
", \"data-test-subj\" | \"children\" | \"paddingSize\" | \"pageHeader\" | \"restrictWidth\" | \"isEmptyState\" | \"noDataConfig\"> & { showSolutionNav?: boolean | undefined; isPageDataLoaded?: boolean | undefined; pageSectionProps?: ",
"EuiPageSectionProps",
" | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ",
"_EuiPageBottomBarProps",
" | undefined; topSearchBar?: React.ReactNode; }"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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",
", \"data-test-subj\" | \"children\" | \"paddingSize\" | \"pageHeader\" | \"restrictWidth\" | \"isEmptyState\" | \"noDataConfig\"> & { showSolutionNav?: boolean | undefined; isPageDataLoaded?: boolean | undefined; pageSectionProps?: ",
"EuiPageSectionProps",
" | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ",
"_EuiPageBottomBarProps",
" | undefined; topSearchBar?: React.ReactNode; }"
],
"path": "x-pack/solutions/observability/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": [
"{ registerProfilingComponent: <T>(key: string, component: React.FC<T>) => void; locators: ObservabilitySharedLocators; navigation: { registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; }"
],
"path": "x-pack/solutions/observability/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": [
"{ locators: ObservabilitySharedLocators; navigation: { PageTemplate: (pageTemplateProps: ",
"WrappedPageTemplateProps",
") => React.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; }>; discover?: Readonly<{}> | undefined; dashboard?: Readonly<{}> | undefined; maps?: Readonly<{}> | undefined; visualize?: Readonly<{}> | undefined; }>; deepLinks: ",
"AppDeepLink",
"<string>[]; updater$: ",
"Subject",
"<",
"AppUpdater",
">; }) => void; }"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocator",
"text": "FlamegraphLocator"
},
"; topNFunctionsLocator: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocator",
"text": "TopNFunctionsLocator"
},
"; stacktracesLocator: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocator",
"text": "StacktracesLocator"
},
"; }"
],
"path": "x-pack/solutions/observability/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>))), \"rel\" | \"color\" | \"onClick\" | \"target\"> & { size?: \"m\" | \"s\" | \"l\" | \"xs\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; rel?: string | undefined; target?: string | undefined; external?: boolean | 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/solutions/observability/plugins/observability_shared/public/components/section/section.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.SLO_ALERTS_TABLE_CONFIG_ID",
"type": "string",
"tags": [],
"label": "SLO_ALERTS_TABLE_CONFIG_ID",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-public.sloFeatureId",
"type": "string",
"tags": [],
"label": "sloFeatureId",
"description": [],
"signature": [
"\"slo\""
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorDefinition",
"type": "Class",
"tags": [],
"label": "AssetDetailsFlyoutLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsFlyoutLocatorDefinition",
"text": "AssetDetailsFlyoutLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsFlyoutLocatorParams",
"text": "AssetDetailsFlyoutLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"ASSET_DETAILS_FLYOUT_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsFlyoutLocatorParams",
"text": "AssetDetailsFlyoutLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsFlyoutLocatorParams",
"text": "AssetDetailsFlyoutLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorDefinition",
"type": "Class",
"tags": [],
"label": "AssetDetailsLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsLocatorDefinition",
"text": "AssetDetailsLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsLocatorParams",
"text": "AssetDetailsLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"ASSET_DETAILS_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsLocatorParams",
"text": "AssetDetailsLocatorParams"
},
" & { state?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; }) => Promise<{ app: string; path: string; state: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorDefinition.getLocation.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsLocatorParams",
"text": "AssetDetailsLocatorParams"
},
" & { state?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.DependencyOverviewLocatorDefinition",
"type": "Class",
"tags": [],
"label": "DependencyOverviewLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.DependencyOverviewLocatorDefinition",
"text": "DependencyOverviewLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.DependencyOverviewParams",
"text": "DependencyOverviewParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/dependency_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.DependencyOverviewLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"dependencyOverviewLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/dependency_overview_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.DependencyOverviewLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, dependencyName, environment, }: ",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.DependencyOverviewParams",
"text": "DependencyOverviewParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/dependency_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.DependencyOverviewLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{\n rangeFrom,\n rangeTo,\n dependencyName,\n environment,\n }",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.DependencyOverviewParams",
"text": "DependencyOverviewParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/dependency_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.EntitiesInventoryLocatorDefinition",
"type": "Class",
"tags": [],
"label": "EntitiesInventoryLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.EntitiesInventoryLocatorDefinition",
"text": "EntitiesInventoryLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/entity_inventory/entity_inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.EntitiesInventoryLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"ENTITY_INVENTORY_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/entity_inventory/entity_inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.EntitiesInventoryLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"() => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/entity_inventory/entity_inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorDefinition",
"type": "Class",
"tags": [],
"label": "FlamegraphLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocatorDefinition",
"text": "FlamegraphLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocatorParams",
"text": "FlamegraphLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"flamegraphLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, kuery }: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocatorParams",
"text": "FlamegraphLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{ rangeFrom, rangeTo, kuery }",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocatorParams",
"text": "FlamegraphLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorDefinition",
"type": "Class",
"tags": [],
"label": "HostsLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.HostsLocatorDefinition",
"text": "HostsLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.HostsLocatorParams",
"text": "HostsLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"HOSTS_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.HostsLocatorParams",
"text": "HostsLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.HostsLocatorParams",
"text": "HostsLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorDefinition",
"type": "Class",
"tags": [],
"label": "InventoryLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.InventoryLocatorDefinition",
"text": "InventoryLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.InventoryLocatorParams",
"text": "InventoryLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"INVENTORY_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.InventoryLocatorParams",
"text": "InventoryLocatorParams"
},
") => Promise<{ app: string; path: string; state: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.InventoryLocatorParams",
"text": "InventoryLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.MetricsExplorerLocatorDefinition",
"type": "Class",
"tags": [],
"label": "MetricsExplorerLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.MetricsExplorerLocatorDefinition",
"text": "MetricsExplorerLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.MetricsExplorerLocatorParams",
"text": "MetricsExplorerLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.MetricsExplorerLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"METRICS_EXPLORER_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.MetricsExplorerLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.MetricsExplorerLocatorParams",
"text": "MetricsExplorerLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.MetricsExplorerLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.MetricsExplorerLocatorParams",
"text": "MetricsExplorerLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocatorDefinition",
"type": "Class",
"tags": [],
"label": "ServiceEntityLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceEntityLocatorDefinition",
"text": "ServiceEntityLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceEntityLocatorParams",
"text": "ServiceEntityLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"SERVICE_ENTITY_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ serviceName }: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceEntityLocatorParams",
"text": "ServiceEntityLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{ serviceName }",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceEntityLocatorParams",
"text": "ServiceEntityLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewLocatorDefinition",
"type": "Class",
"tags": [],
"label": "ServiceOverviewLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceOverviewLocatorDefinition",
"text": "ServiceOverviewLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceOverviewParams",
"text": "ServiceOverviewParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"serviceOverviewLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, serviceName, environment, }: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceOverviewParams",
"text": "ServiceOverviewParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{\n rangeFrom,\n rangeTo,\n serviceName,\n environment,\n }",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceOverviewParams",
"text": "ServiceOverviewParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorDefinition",
"type": "Class",
"tags": [],
"label": "StacktracesLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocatorDefinition",
"text": "StacktracesLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocatorParams",
"text": "StacktracesLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"stacktracesLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, kuery, type, }: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocatorParams",
"text": "StacktracesLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{\n rangeFrom,\n rangeTo,\n kuery,\n type = TopNType.Threads,\n }",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocatorParams",
"text": "StacktracesLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorDefinition",
"type": "Class",
"tags": [],
"label": "TopNFunctionsLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocatorDefinition",
"text": "TopNFunctionsLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocatorParams",
"text": "TopNFunctionsLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"topNFunctionsLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, kuery, }: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocatorParams",
"text": "TopNFunctionsLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{\n rangeFrom,\n rangeTo,\n kuery,\n }",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocatorParams",
"text": "TopNFunctionsLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByNameLocatorDefinition",
"type": "Class",
"tags": [],
"label": "TransactionDetailsByNameLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TransactionDetailsByNameLocatorDefinition",
"text": "TransactionDetailsByNameLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByNameParams",
"text": "TransactionDetailsByNameParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_name_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByNameLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"TransactionDetailsByNameLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_name_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByNameLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, serviceName, transactionName, }: ",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByNameParams",
"text": "TransactionDetailsByNameParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_name_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByNameLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{\n rangeFrom,\n rangeTo,\n serviceName,\n transactionName,\n }",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByNameParams",
"text": "TransactionDetailsByNameParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_name_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorDefinition",
"type": "Class",
"tags": [],
"label": "TransactionDetailsByTraceIdLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TransactionDetailsByTraceIdLocatorDefinition",
"text": "TransactionDetailsByTraceIdLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByTraceIdLocatorParams",
"text": "TransactionDetailsByTraceIdLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_trace_id_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_trace_id_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"({ rangeFrom, rangeTo, traceId, }: ",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByTraceIdLocatorParams",
"text": "TransactionDetailsByTraceIdLocatorParams"
},
") => Promise<{ app: string; path: string; state: {}; }>"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_trace_id_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "{\n rangeFrom,\n rangeTo,\n traceId,\n }",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByTraceIdLocatorParams",
"text": "TransactionDetailsByTraceIdLocatorParams"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_trace_id_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.colorTransformer",
"type": "Function",
"tags": [],
"label": "colorTransformer",
"description": [],
"signature": [
"(color: ",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.Color",
"text": "Color"
},
") => string"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/color_palette.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.colorTransformer.$1",
"type": "CompoundType",
"tags": [],
"label": "color",
"description": [],
"signature": [
"\"color0\" | \"color1\" | \"color2\" | \"color3\" | \"color4\" | \"color5\" | \"color6\" | \"color7\" | \"color8\" | \"color9\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/color_palette.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"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: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>; operationName: string; startTime: number; }) => ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Request",
"text": "Request"
}
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/utils/get_inspect_response.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorParams",
"type": "Interface",
"tags": [],
"label": "AssetDetailsFlyoutLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsFlyoutLocatorParams",
"text": "AssetDetailsFlyoutLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorParams.tableProperties",
"type": "Object",
"tags": [],
"label": "tableProperties",
"description": [],
"signature": [
"{ detailsItemId: string; pagination?: { pageIndex: number; pageSize: number; } | undefined; sorting?: { direction?: string | undefined; field: string; } | undefined; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocatorParams.assetDetails",
"type": "Object",
"tags": [],
"label": "assetDetails",
"description": [],
"signature": [
"{ tabId?: string | undefined; dashboardId?: string | undefined; dateRange?: { from: string; to: string; } | undefined; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorParams",
"type": "Interface",
"tags": [],
"label": "AssetDetailsLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsLocatorParams",
"text": "AssetDetailsLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorParams.assetType",
"type": "string",
"tags": [],
"label": "assetType",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorParams.assetId",
"type": "string",
"tags": [],
"label": "assetId",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorParams._a",
"type": "Object",
"tags": [],
"label": "_a",
"description": [],
"signature": [
"{ time?: { from?: string | undefined; to?: string | undefined; } | undefined; interval?: string | undefined; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocatorParams.assetDetails",
"type": "Object",
"tags": [],
"label": "assetDetails",
"description": [],
"signature": [
"{ tabId?: string | undefined; name?: string | undefined; dashboardId?: string | undefined; dateRange?: { from: string; to: string; } | undefined; alertMetric?: string | undefined; processSearch?: string | undefined; metadataSearch?: string | undefined; logsSearch?: string | undefined; profilingSearch?: string | undefined; alertStatus?: \"all\" | ",
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertStatus",
"text": "AlertStatus"
},
" | undefined; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorParams",
"type": "Interface",
"tags": [],
"label": "FlamegraphLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocatorParams",
"text": "FlamegraphLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorParams.kuery",
"type": "string",
"tags": [],
"label": "kuery",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorParams.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocatorParams.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams",
"type": "Interface",
"tags": [],
"label": "HostsLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.HostsLocatorParams",
"text": "HostsLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ language: string; query: string; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams.dateRange",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
"{ from: string; to: string; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams.panelFilters",
"type": "Array",
"tags": [],
"label": "panelFilters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams.limit",
"type": "number",
"tags": [],
"label": "limit",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocatorParams.tableProperties",
"type": "Object",
"tags": [],
"label": "tableProperties",
"description": [],
"signature": [
"{ detailsItemId?: string | undefined; pagination: { pageIndex: number; pageSize: number; }; sorting: { direction?: string | undefined; field: string; }; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams",
"type": "Interface",
"tags": [],
"label": "InventoryLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.InventoryLocatorParams",
"text": "InventoryLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.inventoryViewId",
"type": "string",
"tags": [],
"label": "inventoryViewId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.waffleFilter",
"type": "Object",
"tags": [],
"label": "waffleFilter",
"description": [],
"signature": [
"{ expression: string; kind: string; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.waffleTime",
"type": "Object",
"tags": [],
"label": "waffleTime",
"description": [],
"signature": [
"{ currentTime: number; isAutoReloading: boolean; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.waffleOptions",
"type": "Object",
"tags": [],
"label": "waffleOptions",
"description": [],
"signature": [
"{ accountId: string; autoBounds: boolean; boundsOverride: { max: number; min: number; }; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.customMetrics",
"type": "string",
"tags": [],
"label": "customMetrics",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.customOptions",
"type": "string",
"tags": [],
"label": "customOptions",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.groupBy",
"type": "Object",
"tags": [],
"label": "groupBy",
"description": [],
"signature": [
"{ field: string; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.legend",
"type": "Object",
"tags": [],
"label": "legend",
"description": [],
"signature": [
"{ palette: string; reverseColors: boolean; steps: number; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.metric",
"type": "string",
"tags": [],
"label": "metric",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.nodeType",
"type": "string",
"tags": [],
"label": "nodeType",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.region",
"type": "string",
"tags": [],
"label": "region",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.sort",
"type": "Object",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"{ by: string; direction: \"desc\" | \"async\"; } | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.timelineOpen",
"type": "CompoundType",
"tags": [],
"label": "timelineOpen",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.view",
"type": "CompoundType",
"tags": [],
"label": "view",
"description": [],
"signature": [
"\"map\" | \"table\" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocatorParams.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.MetricsExplorerLocatorParams",
"type": "Interface",
"tags": [],
"label": "MetricsExplorerLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.MetricsExplorerLocatorParams",
"text": "MetricsExplorerLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocatorParams",
"type": "Interface",
"tags": [],
"label": "ServiceEntityLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceEntityLocatorParams",
"text": "ServiceEntityLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocatorParams.serviceName",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewParams",
"type": "Interface",
"tags": [],
"label": "ServiceOverviewParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceOverviewParams",
"text": "ServiceOverviewParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewParams.serviceName",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewParams.environment",
"type": "string",
"tags": [],
"label": "environment",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewParams.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewParams.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorParams",
"type": "Interface",
"tags": [],
"label": "StacktracesLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocatorParams",
"text": "StacktracesLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorParams.kuery",
"type": "string",
"tags": [],
"label": "kuery",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorParams.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorParams.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocatorParams.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/profiling-utils",
"scope": "common",
"docId": "kibKbnProfilingUtilsPluginApi",
"section": "def-common.TopNType",
"text": "TopNType"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorParams",
"type": "Interface",
"tags": [],
"label": "TopNFunctionsLocatorParams",
"description": [],
"signature": [
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocatorParams",
"text": "TopNFunctionsLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorParams.kuery",
"type": "string",
"tags": [],
"label": "kuery",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorParams.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocatorParams.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorParams",
"type": "Interface",
"tags": [],
"label": "TransactionDetailsByTraceIdLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByTraceIdLocatorParams",
"text": "TransactionDetailsByTraceIdLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/platform/packages/shared/deeplinks/observability/locators/apm.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorParams.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/deeplinks/observability/locators/apm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorParams.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/deeplinks/observability/locators/apm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocatorParams.traceId",
"type": "string",
"tags": [],
"label": "traceId",
"description": [],
"path": "src/platform/packages/shared/deeplinks/observability/locators/apm.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.EntityDataStreamType",
"type": "Enum",
"tags": [],
"label": "EntityDataStreamType",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/entity/entity_data_stream_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.IndexLifecyclePhaseSelectOption",
"type": "Enum",
"tags": [],
"label": "IndexLifecyclePhaseSelectOption",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/ilm_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ObservabilityTriggerId",
"type": "Enum",
"tags": [],
"label": "ObservabilityTriggerId",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/trigger_ids.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SupportedAssetTypes",
"type": "Enum",
"tags": [],
"label": "SupportedAssetTypes",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ASSET_DETAILS_FLYOUT_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "ASSET_DETAILS_FLYOUT_LOCATOR_ID",
"description": [],
"signature": [
"\"ASSET_DETAILS_FLYOUT_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ASSET_DETAILS_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "ASSET_DETAILS_LOCATOR_ID",
"description": [],
"signature": [
"\"ASSET_DETAILS_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsFlyoutLocator",
"type": "Type",
"tags": [],
"label": "AssetDetailsFlyoutLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsFlyoutLocatorParams",
"text": "AssetDetailsFlyoutLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_flyout_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.AssetDetailsLocator",
"type": "Type",
"tags": [],
"label": "AssetDetailsLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.AssetDetailsLocatorParams",
"text": "AssetDetailsLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/asset_details_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.casesFeatureId",
"type": "string",
"tags": [],
"label": "casesFeatureId",
"description": [],
"signature": [
"\"observabilityCasesV3\""
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.Color",
"type": "Type",
"tags": [],
"label": "Color",
"description": [],
"signature": [
"\"color0\" | \"color1\" | \"color2\" | \"color3\" | \"color4\" | \"color5\" | \"color6\" | \"color7\" | \"color8\" | \"color9\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/color_palette.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.COMMON_OBSERVABILITY_GROUPING",
"type": "Array",
"tags": [],
"label": "COMMON_OBSERVABILITY_GROUPING",
"description": [],
"signature": [
"{ id: string; getDisplayName: () => string; getIconType: () => string; order: number; }[]"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/embeddable_grouping.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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.DATA_STREAM_TYPE",
"type": "string",
"tags": [],
"label": "DATA_STREAM_TYPE",
"description": [],
"signature": [
"\"data_stream.type\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.DataTier",
"type": "Type",
"tags": [],
"label": "DataTier",
"description": [],
"signature": [
"\"data_hot\" | \"data_warm\" | \"data_cold\" | \"data_frozen\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/ilm_types.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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITIES_INVENTORY_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "ENTITIES_INVENTORY_LOCATOR_ID",
"description": [],
"signature": [
"\"ENTITY_INVENTORY_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/entity_inventory/entity_inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.EntitiesInventoryLocator",
"type": "Type",
"tags": [],
"label": "EntitiesInventoryLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/entity_inventory/entity_inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY",
"type": "string",
"tags": [],
"label": "ENTITY",
"description": [],
"signature": [
"\"entity\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_DEFINITION_ID",
"type": "string",
"tags": [],
"label": "ENTITY_DEFINITION_ID",
"description": [],
"signature": [
"\"entity.definition_id\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_DISPLAY_NAME",
"type": "string",
"tags": [],
"label": "ENTITY_DISPLAY_NAME",
"description": [],
"signature": [
"\"entity.display_name\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_FIRST_SEEN",
"type": "string",
"tags": [],
"label": "ENTITY_FIRST_SEEN",
"description": [],
"signature": [
"\"entity.first_seen_timestamp\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_ID",
"type": "string",
"tags": [],
"label": "ENTITY_ID",
"description": [],
"signature": [
"\"entity.id\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_IDENTITY_FIELDS",
"type": "string",
"tags": [],
"label": "ENTITY_IDENTITY_FIELDS",
"description": [],
"signature": [
"\"entity.identity_fields\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_LAST_SEEN",
"type": "string",
"tags": [],
"label": "ENTITY_LAST_SEEN",
"description": [],
"signature": [
"\"entity.last_seen_timestamp\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ENTITY_TYPE",
"type": "string",
"tags": [],
"label": "ENTITY_TYPE",
"description": [],
"signature": [
"\"entity.type\""
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.FlamegraphLocator",
"type": "Type",
"tags": [],
"label": "FlamegraphLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.FlamegraphLocatorParams",
"text": "FlamegraphLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/flamegraph_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HOST",
"type": "string",
"tags": [],
"label": "HOST",
"description": [],
"signature": [
"\"host\""
],
"path": "x-pack/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HOST_NAME",
"type": "string",
"tags": [],
"label": "HOST_NAME",
"description": [],
"signature": [
"\"host.name\""
],
"path": "x-pack/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HOSTS_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "HOSTS_LOCATOR_ID",
"description": [],
"signature": [
"\"HOSTS_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.HostsLocator",
"type": "Type",
"tags": [],
"label": "HostsLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.HostsLocatorParams",
"text": "HostsLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/hosts_locator.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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.INVENTORY_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "INVENTORY_LOCATOR_ID",
"description": [],
"signature": [
"\"INVENTORY_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.InventoryLocator",
"type": "Type",
"tags": [],
"label": "InventoryLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.InventoryLocatorParams",
"text": "InventoryLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/inventory_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.KUBERNETES",
"type": "string",
"tags": [],
"label": "KUBERNETES",
"description": [],
"signature": [
"\"kubernetes\""
],
"path": "x-pack/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.LOGS_EXPLORER_FEEDBACK_LINK",
"type": "string",
"tags": [],
"label": "LOGS_EXPLORER_FEEDBACK_LINK",
"description": [],
"signature": [
"\"https://ela.st/explorer-feedback\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.LOGS_ONBOARDING_FEEDBACK_LINK",
"type": "string",
"tags": [],
"label": "LOGS_ONBOARDING_FEEDBACK_LINK",
"description": [],
"signature": [
"\"https://ela.st/logs-onboarding-feedback\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.METRICS_EXPLORER_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "METRICS_EXPLORER_LOCATOR_ID",
"description": [],
"signature": [
"\"METRICS_EXPLORER_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.MetricsExplorerLocator",
"type": "Type",
"tags": [],
"label": "MetricsExplorerLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.MetricsExplorerLocatorParams",
"text": "MetricsExplorerLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/infra/metrics_explorer_locator.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_ENTITY_LOCATOR",
"type": "string",
"tags": [],
"label": "SERVICE_ENTITY_LOCATOR",
"description": [],
"signature": [
"\"SERVICE_ENTITY_LOCATOR\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SERVICE_OVERVIEW_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "SERVICE_OVERVIEW_LOCATOR_ID",
"description": [],
"signature": [
"\"serviceOverviewLocator\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceEntityLocator",
"type": "Type",
"tags": [],
"label": "ServiceEntityLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceEntityLocatorParams",
"text": "ServiceEntityLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_entity_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.ServiceOverviewLocator",
"type": "Type",
"tags": [],
"label": "ServiceOverviewLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.ServiceOverviewParams",
"text": "ServiceOverviewParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/service_overview_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SLO_ALERTS_TABLE_CONFIG_ID",
"type": "string",
"tags": [],
"label": "SLO_ALERTS_TABLE_CONFIG_ID",
"description": [],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SLO_ALERTS_TABLE_ID",
"type": "string",
"tags": [],
"label": "SLO_ALERTS_TABLE_ID",
"description": [],
"signature": [
"\"xpack.observability.slo.sloDetails.alertTable\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.sloFeatureId",
"type": "string",
"tags": [],
"label": "sloFeatureId",
"description": [],
"signature": [
"\"slo\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.SOURCE_DATA_STREAM_TYPE",
"type": "string",
"tags": [],
"label": "SOURCE_DATA_STREAM_TYPE",
"description": [],
"signature": [
"\"source_data_stream.type\""
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.StacktracesLocator",
"type": "Type",
"tags": [],
"label": "StacktracesLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.StacktracesLocatorParams",
"text": "StacktracesLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/stacktraces_locator.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TopNFunctionsLocator",
"type": "Type",
"tags": [],
"label": "TopNFunctionsLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observabilityShared",
"scope": "common",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-common.TopNFunctionsLocatorParams",
"text": "TopNFunctionsLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/profiling/topn_functions_locator.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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR",
"type": "string",
"tags": [],
"label": "TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR",
"description": [],
"signature": [
"\"TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR\""
],
"path": "src/platform/packages/shared/deeplinks/observability/locators/apm.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByNameLocator",
"type": "Type",
"tags": [],
"label": "TransactionDetailsByNameLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByNameParams",
"text": "TransactionDetailsByNameParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_name_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.TransactionDetailsByTraceIdLocator",
"type": "Type",
"tags": [],
"label": "TransactionDetailsByTraceIdLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.TransactionDetailsByTraceIdLocatorParams",
"text": "TransactionDetailsByTraceIdLocatorParams"
},
">"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/locators/apm/transaction_details_by_trace_id_locator.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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/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/solutions/observability/plugins/observability_shared/common/field_names/elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "observabilityShared",
"id": "def-common.BUILT_IN_ENTITY_TYPES",
"type": "Object",
"tags": [],
"label": "BUILT_IN_ENTITY_TYPES",
"description": [],
"signature": [
"{ readonly HOST_V2: \"built_in_hosts_from_ecs_data\"; readonly CONTAINER_V2: \"built_in_containers_from_ecs_data\"; readonly SERVICE_V2: \"built_in_services_from_ecs_data\"; readonly KUBERNETES_V2: { readonly CLUSTER: { ecs: \"built_in_kubernetes_cluster_ecs\"; semconv: \"built_in_kubernetes_cluster_semconv\"; }; readonly CRON_JOB: { ecs: \"built_in_kubernetes_cron_job_ecs\"; semconv: \"built_in_kubernetes_cron_job_semconv\"; }; readonly DAEMON_SET: { ecs: \"built_in_kubernetes_daemon_set_ecs\"; semconv: \"built_in_kubernetes_daemon_set_semconv\"; }; readonly DEPLOYMENT: { ecs: \"built_in_kubernetes_deployment_ecs\"; semconv: \"built_in_kubernetes_deployment_semconv\"; }; readonly JOB: { ecs: \"built_in_kubernetes_job_ecs\"; semconv: \"built_in_kubernetes_job_semconv\"; }; readonly NODE: { ecs: \"built_in_kubernetes_node_ecs\"; semconv: \"built_in_kubernetes_node_semconv\"; }; readonly POD: { ecs: \"built_in_kubernetes_pod_ecs\"; semconv: \"built_in_kubernetes_pod_semconv\"; }; readonly REPLICA_SET: { ecs: \"built_in_kubernetes_replica_set_ecs\"; semconv: \"built_in_kubernetes_replica_set_semconv\"; }; readonly STATEFUL_SET: { ecs: \"built_in_kubernetes_stateful_set_ecs\"; semconv: \"built_in_kubernetes_stateful_set_semconv\"; }; readonly SERVICE: \"built_in_kubernetes_service_ecs\"; }; readonly HOST: \"host\"; readonly CONTAINER: \"container\"; readonly SERVICE: \"service\"; readonly KUBERNETES: { readonly CLUSTER: { ecs: \"k8s.cluster.ecs\"; semconv: \"k8s.cluster.semconv\"; }; readonly CONTAINER: { ecs: \"k8s.container.ecs\"; semconv: \"k8s.container.semconv\"; }; readonly CRONJOB: { ecs: \"k8s.cron_job.ecs\"; semconv: \"k8s.cron_job.semconv\"; }; readonly DAEMONSET: { ecs: \"k8s.daemonset.ecs\"; semconv: \"k8s.daemonset.semconv\"; }; readonly DEPLOYMENT: { ecs: \"k8s.deployment.ecs\"; semconv: \"k8s.deployment.semconv\"; }; readonly JOB: { ecs: \"k8s.job.ecs\"; semconv: \"k8s.job.semconv\"; }; readonly NAMESPACE: { ecs: \"k8s.namespace.ecs\"; semconv: \"k8s.namespace.semconv\"; }; readonly NODE: { ecs: \"k8s.node.ecs\"; semconv: \"k8s.node.semconv\"; }; readonly POD: { ecs: \"k8s.pod.ecs\"; semconv: \"k8s.pod.semconv\"; }; readonly SERVICE: { ecs: \"k8s.service.ecs\"; semconv: \"k8s.service.semconv\"; }; readonly STATEFULSET: { ecs: \"k8s.statefulset.ecs\"; semconv: \"k8s.statefulset.semconv\"; }; }; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/entity/entity_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityShared",
"id": "def-common.indexLifeCyclePhaseToDataTier",
"type": "Object",
"tags": [],
"label": "indexLifeCyclePhaseToDataTier",
"description": [],
"signature": [
"{ readonly hot: \"data_hot\"; readonly warm: \"data_warm\"; readonly cold: \"data_cold\"; readonly frozen: \"data_frozen\"; }"
],
"path": "x-pack/solutions/observability/plugins/observability_shared/common/ilm_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink