kibana/api_docs/kbn_deeplinks_observability.devdocs.json

515 lines
No EOL
18 KiB
JSON

{
"id": "@kbn/deeplinks-observability",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerLocatorParams",
"type": "Interface",
"tags": [],
"label": "LogExplorerLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.LogExplorerLocatorParams",
"text": "LogExplorerLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.LogExplorerNavigationParams",
"text": "LogExplorerNavigationParams"
}
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerLocatorParams.dataset",
"type": "string",
"tags": [],
"label": "dataset",
"description": [
"\nDataset name to be selected."
],
"signature": [
"string | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams",
"type": "Interface",
"tags": [],
"label": "LogExplorerNavigationParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.LogExplorerNavigationParams",
"text": "LogExplorerNavigationParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [
"\nOptionally set the time range in the time picker."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams.refreshInterval",
"type": "Object",
"tags": [],
"label": "refreshInterval",
"description": [
"\nOptionally set the refresh interval."
],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [
"\nOptionally set a query."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"string[][] | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LogExplorerNavigationParams.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nOptionally apply filters."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.ObservabilityOnboardingLocatorParams",
"type": "Interface",
"tags": [],
"label": "ObservabilityOnboardingLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.ObservabilityOnboardingLocatorParams",
"text": "ObservabilityOnboardingLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "packages/deeplinks/observability/locators/observability_onboarding.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.ObservabilityOnboardingLocatorParams.source",
"type": "CompoundType",
"tags": [],
"label": "source",
"description": [
"If given, it will load the given map else will load the create a new map page."
],
"signature": [
"\"customLogs\" | \"systemLogs\" | undefined"
],
"path": "packages/deeplinks/observability/locators/observability_onboarding.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.SingleDatasetLocatorParams",
"type": "Interface",
"tags": [],
"label": "SingleDatasetLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.SingleDatasetLocatorParams",
"text": "SingleDatasetLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.LogExplorerNavigationParams",
"text": "LogExplorerNavigationParams"
}
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.SingleDatasetLocatorParams.integration",
"type": "string",
"tags": [],
"label": "integration",
"description": [
"\nIntegration name to be selected."
],
"signature": [
"string | undefined"
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.SingleDatasetLocatorParams.dataset",
"type": "string",
"tags": [],
"label": "dataset",
"description": [
"\nDataset name to be selected.\nex: system.syslog"
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.ALL_DATASETS_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "ALL_DATASETS_LOCATOR_ID",
"description": [],
"signature": [
"\"ALL_DATASETS_LOCATOR\""
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.AllDatasetsLocatorParams",
"type": "Type",
"tags": [],
"label": "AllDatasetsLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.LogExplorerNavigationParams",
"text": "LogExplorerNavigationParams"
}
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.AppId",
"type": "Type",
"tags": [],
"label": "AppId",
"description": [],
"signature": [
"\"metrics\" | \"apm\" | \"logs\" | \"observability-overview\" | \"observability-log-explorer\" | \"observabilityOnboarding\""
],
"path": "packages/deeplinks/observability/deep_links.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.DatasetLocatorParams",
"type": "Type",
"tags": [],
"label": "DatasetLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.LogExplorerNavigationParams",
"text": "LogExplorerNavigationParams"
}
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.DeepLinkId",
"type": "Type",
"tags": [],
"label": "DeepLinkId",
"description": [],
"signature": [
{
"pluginId": "@kbn/deeplinks-observability",
"scope": "common",
"docId": "kibKbnDeeplinksObservabilityPluginApi",
"section": "def-common.AppId",
"text": "AppId"
},
" | \"logs:settings\" | \"logs:stream\" | \"logs:log-categories\" | \"logs:anomalies\" | \"observability-overview:cases\" | \"observability-overview:rules\" | \"observability-overview:alerts\" | \"observability-overview:cases_create\" | \"observability-overview:cases_configure\" | \"observability-overview:slos\" | \"metrics:settings\" | \"metrics:inventory\" | \"metrics:metrics-explorer\" | \"metrics:metrics-hosts\" | \"apm:traces\" | \"apm:dependencies\" | \"apm:service-map\" | \"apm:settings\" | \"apm:services\" | \"apm:service-groups-list\" | \"apm:storage-explorer\""
],
"path": "packages/deeplinks/observability/deep_links.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.LOG_EXPLORER_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "LOG_EXPLORER_LOCATOR_ID",
"description": [],
"signature": [
"\"LOG_EXPLORER_LOCATOR\""
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.OBSERVABILITY_ONBOARDING_APP_ID",
"type": "string",
"tags": [],
"label": "OBSERVABILITY_ONBOARDING_APP_ID",
"description": [],
"signature": [
"\"observabilityOnboarding\""
],
"path": "packages/deeplinks/observability/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.OBSERVABILITY_ONBOARDING_LOCATOR",
"type": "string",
"tags": [],
"label": "OBSERVABILITY_ONBOARDING_LOCATOR",
"description": [],
"signature": [
"\"OBSERVABILITY_ONBOARDING_LOCATOR\""
],
"path": "packages/deeplinks/observability/locators/observability_onboarding.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.RefreshInterval",
"type": "Type",
"tags": [],
"label": "RefreshInterval",
"description": [],
"signature": [
"{ pause: boolean; value: number; }"
],
"path": "packages/deeplinks/observability/locators/log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/deeplinks-observability",
"id": "def-common.SINGLE_DATASET_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "SINGLE_DATASET_LOCATOR_ID",
"description": [],
"signature": [
"\"SINGLE_DATASET_LOCATOR\""
],
"path": "packages/deeplinks/observability/locators/observability_log_explorer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}