mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
624 lines
No EOL
22 KiB
JSON
624 lines
No EOL
22 KiB
JSON
{
|
|
"id": "@kbn/alerts-grouping",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGrouping",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AlertsGrouping",
|
|
"description": [
|
|
"\nA coordinator component to show multiple alert tables grouped by one or more fields\n"
|
|
],
|
|
"signature": [
|
|
"<T extends ",
|
|
{
|
|
"pluginId": "@kbn/alerts-grouping",
|
|
"scope": "public",
|
|
"docId": "kibKbnAlertsGroupingPluginApi",
|
|
"section": "def-public.BaseAlertsGroupAggregations",
|
|
"text": "BaseAlertsGroupAggregations"
|
|
},
|
|
">(props: ",
|
|
{
|
|
"pluginId": "@kbn/alerts-grouping",
|
|
"scope": "public",
|
|
"docId": "kibKbnAlertsGroupingPluginApi",
|
|
"section": "def-public.AlertsGroupingProps",
|
|
"text": "AlertsGroupingProps"
|
|
},
|
|
"<T>) => React.JSX.Element"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/components/alerts_grouping.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGrouping.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerts-grouping",
|
|
"scope": "public",
|
|
"docId": "kibKbnAlertsGroupingPluginApi",
|
|
"section": "def-public.AlertsGroupingProps",
|
|
"text": "AlertsGroupingProps"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/components/alerts_grouping.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.useAlertsGroupingState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useAlertsGroupingState",
|
|
"description": [],
|
|
"signature": [
|
|
"(groupingId: string) => { grouping: ",
|
|
"GroupModel",
|
|
"; updateGrouping: (groupModel: Partial<",
|
|
"GroupModel",
|
|
"> | null) => void; }"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/contexts/alerts_grouping_context.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.useAlertsGroupingState.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "groupingId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/contexts/alerts_grouping_context.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupAggregationBucket",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertsGroupAggregationBucket",
|
|
"description": [],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupAggregationBucket.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupAggregationBucket.doc_count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "doc_count",
|
|
"description": [],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupAggregationBucket.isNullGroup",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isNullGroup",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupAggregationBucket.unitsCount",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "unitsCount",
|
|
"description": [],
|
|
"signature": [
|
|
"{ value: number; } | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertsGroupingProps",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerts-grouping",
|
|
"scope": "public",
|
|
"docId": "kibKbnAlertsGroupingPluginApi",
|
|
"section": "def-public.AlertsGroupingProps",
|
|
"text": "AlertsGroupingProps"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.children",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "children",
|
|
"description": [
|
|
"\nThe leaf component that will be rendered in the grouping panels"
|
|
],
|
|
"signature": [
|
|
"(groupingFilters: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]) => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.children.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "groupingFilters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.renderGroupPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderGroupPanel",
|
|
"description": [
|
|
"\nRender function for the group panel header"
|
|
],
|
|
"signature": [
|
|
"GroupPanelRenderer",
|
|
"<T> | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.getGroupStats",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getGroupStats",
|
|
"description": [
|
|
"\nA function that given the current grouping field and aggregation results, returns an array of\nstat items to be rendered in the group panel"
|
|
],
|
|
"signature": [
|
|
"GetGroupStats",
|
|
"<T> | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.defaultFilters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "defaultFilters",
|
|
"description": [
|
|
"\nDefault search filters"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.globalFilters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "globalFilters",
|
|
"description": [
|
|
"\nGlobal search filters"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.takeActionItems",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "takeActionItems",
|
|
"description": [
|
|
"\nItems that will be rendered in the `Take Actions` menu"
|
|
],
|
|
"signature": [
|
|
"((groupFilters: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[], groupNumber: number) => JSX.Element[]) | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.defaultGroupingOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "defaultGroupingOptions",
|
|
"description": [
|
|
"\nThe default fields available for grouping"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/grouping",
|
|
"scope": "common",
|
|
"docId": "kibKbnGroupingPluginApi",
|
|
"section": "def-common.GroupOption",
|
|
"text": "GroupOption"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.ruleTypeIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ruleTypeIds",
|
|
"description": [
|
|
"\nThe alerting rule type ids this grouping covers"
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.consumers",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "consumers",
|
|
"description": [
|
|
"\nThe alerting consumers this grouping covers"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.from",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [
|
|
"\nTime filter start"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.to",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "to",
|
|
"description": [
|
|
"\nTime filter end"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.globalQuery",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "globalQuery",
|
|
"description": [
|
|
"\nGlobal search query (i.e. from the KQL bar)"
|
|
],
|
|
"signature": [
|
|
"{ query: string | { [key: string]: any; }; language: string; }"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.loading",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "loading",
|
|
"description": [
|
|
"\nExternal loading state"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.groupingId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "groupingId",
|
|
"description": [
|
|
"\nID used to retrieve the current grouping configuration from the state"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.getAggregationsByGroupingField",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAggregationsByGroupingField",
|
|
"description": [
|
|
"\nResolves an array of aggregations for a given grouping field"
|
|
],
|
|
"signature": [
|
|
"(field: string) => ",
|
|
{
|
|
"pluginId": "@kbn/grouping",
|
|
"scope": "common",
|
|
"docId": "kibKbnGroupingPluginApi",
|
|
"section": "def-common.NamedAggregation",
|
|
"text": "NamedAggregation"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.getAggregationsByGroupingField.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.AlertsGroupingProps.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [
|
|
"\nServices required for the grouping component"
|
|
],
|
|
"signature": [
|
|
"{ notifications: ",
|
|
"NotificationsStart",
|
|
"; dataViews: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.DataViewsServicePublic",
|
|
"text": "DataViewsServicePublic"
|
|
},
|
|
"; http: ",
|
|
"HttpSetup",
|
|
"; }"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.BaseAlertsGroupAggregations",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BaseAlertsGroupAggregations",
|
|
"description": [],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.BaseAlertsGroupAggregations.groupByFields",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "groupByFields",
|
|
"description": [],
|
|
"signature": [
|
|
"{ doc_count_error_upper_bound: number; sum_other_doc_count: number; buckets: ",
|
|
{
|
|
"pluginId": "@kbn/alerts-grouping",
|
|
"scope": "public",
|
|
"docId": "kibKbnAlertsGroupingPluginApi",
|
|
"section": "def-public.AlertsGroupAggregationBucket",
|
|
"text": "AlertsGroupAggregationBucket"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.BaseAlertsGroupAggregations.groupsCount",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "groupsCount",
|
|
"description": [],
|
|
"signature": [
|
|
"{ value: number; }"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/alerts-grouping",
|
|
"id": "def-public.BaseAlertsGroupAggregations.unitsCount",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "unitsCount",
|
|
"description": [],
|
|
"signature": [
|
|
"{ value: number; }"
|
|
],
|
|
"path": "x-pack/solutions/observability/packages/kbn-alerts-grouping/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |