maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/rule_registry.json
Madison Caldwell 8f9086b4c2
[RAC][Security Solution] Add base Security Rule Type (#105096) 
* injects bulkCreate and wrapHits to individual rule executors

* WIP create_security_rule_type_factory based on Marshall's work in #d3076ca54526ea0e61a9a99e1c1bce854806977e

* removes ruleStatusService from old rule executors, fixes executor unit tests

* fixes rebase

* Rename reference_rules to rule_types

* Fix type errors

* Fix type errors in base security rule factory

* Additional improvements to types and interfaces

* More type alignment

* Fix remaining type errors in query rule

* Add validation / inject lists plugin

* Formatting

* Improvements to typing

* Static typing on executors

* cleanup

* Hook up params for query/threshold rules... includes exceptionsList and daterange tuple

* Scaffolding for wrapHits and bulkCreate

* Add error handling / status reporting

* Fixup alert type state

* Begin threshold

* Begin work on threshold state

* Organize rule types

* Export base security rule types

* Fixup lifecycle static typing

* WrapHits / bulk changes

* Field mappings (partial)

* whoops

* Remove redundant params

* More flexibile implementation of bulkCreateFactory

* Add mappings

* Finish query rule

* Revert "Remove redundant params"

This reverts commit 87aff9c810.

* Revert "whoops"

This reverts commit a7771bd392.

* Fixup return types

* Use alertWithPersistence

* Fix import

* End-to-end rule mostly working

* Fix bulkCreate

* Bug fixes

* Bug fixes and mapping changes

* Fix indexing

* cleanup

* Fix type errors

* Test fixes

* Fix query tests

* cleanup / rename kibana.rac to kibana

* Remove eql/threshold (for now)

* Move technical fields to package

* Add indexAlias and buildRuleMessageFactory

* imports

* type errors

* Change 'kibana.rac.*' to 'kibana.*'

* Fix lifecycle tests

* Single alert instance

* fix import

* Fix type error

* Fix more type errors

* Fix query rule type test

* revert to previous ts-expect-error

* type errors again

* types / linting

* General readability improvements

* Add invariant function from Dmitrii's branch

* Use invariant and constants

* Improvements to field mappings

* More test failure fixes

* Add refresh param for bulk create

* Update more field refs

* Actually use refresh param

* cleanup

* test fixes

* changes to rule creation script

* Fix created signals count

* Use ruleId

* Updates to bulk indexing

* Mapping updates

* Cannot use 'strict' for dynamic setting

Co-authored-by: Marshall Main <marshall.main@elastic.co>
Co-authored-by: Ece Ozalp <ozale272@newschool.edu>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-08-03 12:48:07 -04:00

1179 lines
50 KiB
JSON
Raw Blame History

{
"id": "ruleRegistry",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient",
"type": "Class",
"tags": [],
"label": "RuleDataClient",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
" implements ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
}
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RuleDataClientConstructorOptions"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.isWriteEnabled",
"type": "Function",
"tags": [],
"label": "isWriteEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getReader",
"type": "Function",
"tags": [],
"label": "getReader",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; }) => ",
"RuleDataReader"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getReader.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getReader.$1.options.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getWriter",
"type": "Function",
"tags": [],
"label": "getWriter",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; }) => ",
"RuleDataWriter"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getWriter.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getWriter.$1.options.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.createWriteTargetIfNeeded",
"type": "Function",
"tags": [],
"label": "createWriteTargetIfNeeded",
"description": [],
"signature": [
"({ namespace }: { namespace?: string | undefined; }) => Promise<void>"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.createWriteTargetIfNeeded.$1.namespace",
"type": "Object",
"tags": [],
"label": "{ namespace }",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.createWriteTargetIfNeeded.$1.namespace.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/index.ts",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleExecutor",
"type": "Function",
"tags": [],
"label": "createLifecycleExecutor",
"description": [],
"signature": [
"(logger: ",
"Logger",
", ruleDataClient: Pick<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
", \"isWriteEnabled\" | \"getReader\" | \"getWriter\" | \"createWriteTargetIfNeeded\">) => <Params extends Record<string, unknown> = never, State extends Record<string, unknown> = never, InstanceState extends { [x: string]: unknown; } = never, InstanceContext extends { [x: string]: unknown; } = never, ActionGroupIds extends string = never>(wrappedExecutor: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.LifecycleRuleExecutor",
"text": "LifecycleRuleExecutor"
},
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>) => (options: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertExecutorOptions",
"text": "AlertExecutorOptions"
},
"<Params, ",
"WrappedLifecycleRuleState",
"<State>, InstanceState, InstanceContext, ActionGroupIds>) => Promise<",
"WrappedLifecycleRuleState",
"<State>>"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleExecutor.$1",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
"Logger"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleExecutor.$2",
"type": "Object",
"tags": [],
"label": "ruleDataClient",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
", \"isWriteEnabled\" | \"getReader\" | \"getWriter\" | \"createWriteTargetIfNeeded\">"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleRuleTypeFactory",
"type": "Function",
"tags": [],
"label": "createLifecycleRuleTypeFactory",
"description": [],
"signature": [
"({ logger, ruleDataClient, }: { ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
"; logger: ",
"Logger",
"; }) => <TParams extends Record<string, unknown>, TAlertInstanceContext extends { [x: string]: unknown; }, TServices extends { alertWithLifecycle: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.LifecycleAlertService",
"text": "LifecycleAlertService"
},
"<TAlertInstanceContext, string>; }>(type: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertTypeWithExecutor",
"text": "AlertTypeWithExecutor"
},
"<TParams, TAlertInstanceContext, TServices>) => ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertTypeWithExecutor",
"text": "AlertTypeWithExecutor"
},
"<TParams, TAlertInstanceContext, any>"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleRuleTypeFactory.$1.loggerruleDataClient",
"type": "Object",
"tags": [],
"label": "{\n logger,\n ruleDataClient,\n}",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleRuleTypeFactory.$1.loggerruleDataClient.ruleDataClient",
"type": "Object",
"tags": [],
"label": "ruleDataClient",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
}
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createLifecycleRuleTypeFactory.$1.loggerruleDataClient.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
"Logger"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createPersistenceRuleTypeFactory",
"type": "Function",
"tags": [],
"label": "createPersistenceRuleTypeFactory",
"description": [],
"signature": [
"({ logger, ruleDataClient, }: { ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
"; logger: ",
"Logger",
"; }) => <TParams extends Record<string, unknown>, TAlertInstanceContext extends { [x: string]: unknown; }, TServices extends { alertWithPersistence: PersistenceAlertService<TAlertInstanceContext>; findAlerts: PersistenceAlertQueryService; }>(type: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertTypeWithExecutor",
"text": "AlertTypeWithExecutor"
},
"<TParams, TAlertInstanceContext, TServices>) => { executor: (options: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertExecutorOptions",
"text": "AlertExecutorOptions"
},
"<TParams, Record<string, unknown>, { [x: string]: unknown; }, TAlertInstanceContext, never> & { services: any; }) => Promise<any>; id: string; name: string; validate?: { params?: ",
"AlertTypeParamsValidator",
"<TParams> | undefined; } | undefined; actionGroups: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<string>[]; defaultActionGroupId: string; recoveryActionGroup?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<string> | undefined; producer: string; actionVariables?: { context?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; state?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; params?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; } | undefined; minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"; useSavedObjectReferences?: { extractReferences: (params: TParams) => ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleParamsAndRefs",
"text": "RuleParamsAndRefs"
},
"<TParams>; injectReferences: (params: TParams, references: ",
"SavedObjectReference",
"[]) => TParams; } | undefined; isExportable: boolean; }"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createPersistenceRuleTypeFactory.$1",
"type": "Object",
"tags": [],
"label": "{\n logger,\n ruleDataClient,\n}",
"description": [],
"signature": [
"{ ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
"; logger: ",
"Logger",
"; }"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.getRuleData",
"type": "Function",
"tags": [],
"label": "getRuleData",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertExecutorOptions",
"text": "AlertExecutorOptions"
},
"<any, any, any, any, any>) => { \"rule.id\": string; \"rule.uuid\": string; \"rule.category\": string; \"rule.name\": string; tags: string[]; \"kibana.alert.producer\": string; }"
],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.getRuleData.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertExecutorOptions",
"text": "AlertExecutorOptions"
},
"<any, any, any, any, any>"
],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient",
"type": "Interface",
"tags": [],
"label": "IRuleDataClient",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getReader",
"type": "Function",
"tags": [],
"label": "getReader",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; } | undefined) => ",
"RuleDataReader"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getReader.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getReader.$1.options.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getWriter",
"type": "Function",
"tags": [],
"label": "getWriter",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; } | undefined) => ",
"RuleDataWriter"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getWriter.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getWriter.$1.options.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.isWriteEnabled",
"type": "Function",
"tags": [],
"label": "isWriteEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.createWriteTargetIfNeeded",
"type": "Function",
"tags": [],
"label": "createWriteTargetIfNeeded",
"description": [],
"signature": [
"(options: { namespace?: string | undefined; }) => Promise<void>"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.createWriteTargetIfNeeded.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.createWriteTargetIfNeeded.$1.options.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/rule_registry/server/rule_data_client/types.ts",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.LifecycleAlertServices",
"type": "Interface",
"tags": [],
"label": "LifecycleAlertServices",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.LifecycleAlertServices",
"text": "LifecycleAlertServices"
},
"<InstanceState, InstanceContext, ActionGroupIds>"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.LifecycleAlertServices.alertWithLifecycle",
"type": "Function",
"tags": [],
"label": "alertWithLifecycle",
"description": [],
"signature": [
"(alert: { id: string; fields: Record<string, unknown> & Partial<Pick<OutputOf<",
"Optional",
"<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>, \"tags\" | \"@timestamp\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>; }) => Pick<",
"AlertInstance",
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.alert",
"type": "Object",
"tags": [],
"label": "alert",
"description": [],
"signature": [
"{ id: string; fields: Record<string, unknown> & Partial<Pick<OutputOf<",
"Optional",
"<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>, \"tags\" | \"@timestamp\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>; }"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RacApiRequestHandlerContext",
"type": "Interface",
"tags": [],
"label": "RacApiRequestHandlerContext",
"description": [],
"path": "x-pack/plugins/rule_registry/server/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RacApiRequestHandlerContext.getAlertsClient",
"type": "Function",
"tags": [],
"label": "getAlertsClient",
"description": [],
"signature": [
"() => Promise<",
"AlertsClient",
">"
],
"path": "x-pack/plugins/rule_registry/server/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData",
"type": "Interface",
"tags": [],
"label": "RuleExecutorData",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData.RULE_CATEGORY",
"type": "string",
"tags": [],
"label": "[RULE_CATEGORY]",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData.RULE_ID",
"type": "string",
"tags": [],
"label": "[RULE_ID]",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData.RULE_UUID",
"type": "string",
"tags": [],
"label": "[RULE_UUID]",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData.RULE_NAME",
"type": "string",
"tags": [],
"label": "[RULE_NAME]",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData.ALERT_PRODUCER",
"type": "string",
"tags": [],
"label": "[ALERT_PRODUCER]",
"description": [],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleExecutorData.TAGS",
"type": "Array",
"tags": [],
"label": "[TAGS]",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertTypeWithExecutor",
"type": "Type",
"tags": [],
"label": "AlertTypeWithExecutor",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertType",
"text": "AlertType"
},
"<TParams, TParams, Record<string, unknown>, { [x: string]: unknown; }, TAlertInstanceContext, string, string>, \"id\" | \"name\" | \"validate\" | \"actionGroups\" | \"defaultActionGroupId\" | \"recoveryActionGroup\" | \"producer\" | \"actionVariables\" | \"minimumLicenseRequired\" | \"useSavedObjectReferences\" | \"isExportable\"> & { executor: ",
"AlertTypeExecutor",
"<TParams, TAlertInstanceContext, TServices>; }"
],
"path": "x-pack/plugins/rule_registry/server/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.LifecycleAlertService",
"type": "Type",
"tags": [],
"label": "LifecycleAlertService",
"description": [],
"signature": [
"(alert: { id: string; fields: Record<string, unknown>; }) => Pick<",
"AlertInstance",
"<{ [x: string]: unknown; }, TAlertInstanceContext, TActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.alert",
"type": "Object",
"tags": [],
"label": "alert",
"description": [],
"signature": [
"{ id: string; fields: Record<string, unknown>; }"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.LifecycleRuleExecutor",
"type": "Type",
"tags": [],
"label": "LifecycleRuleExecutor",
"description": [],
"signature": [
"(options: ",
"AlertExecutorOptionsWithExtraServices",
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.LifecycleAlertServices",
"text": "LifecycleAlertServices"
},
"<InstanceState, InstanceContext, ActionGroupIds>>) => Promise<void | State>"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.options",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertExecutorOptions",
"text": "AlertExecutorOptions"
},
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>, \"name\" | \"params\" | \"tags\" | \"spaceId\" | \"rule\" | \"createdBy\" | \"updatedBy\" | \"previousStartedAt\" | \"state\" | \"alertId\" | \"namespace\" | \"startedAt\"> & { services: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertServices",
"text": "AlertServices"
},
"<InstanceState, InstanceContext, ActionGroupIds> & ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.LifecycleAlertServices",
"text": "LifecycleAlertServices"
},
"<InstanceState, InstanceContext, ActionGroupIds>; }"
],
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginConfig",
"type": "Type",
"tags": [],
"label": "RuleRegistryPluginConfig",
"description": [],
"signature": [
"{ readonly enabled: boolean; readonly index: string; readonly write: Readonly<{} & { enabled: boolean; }>; }"
],
"path": "x-pack/plugins/rule_registry/server/config.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract",
"type": "Interface",
"tags": [],
"label": "RuleRegistryPluginSetupContract",
"description": [],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract.ruleDataService",
"type": "Object",
"tags": [],
"label": "ruleDataService",
"description": [],
"signature": [
"RuleDataPluginService"
],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract.eventLogService",
"type": "Object",
"tags": [],
"label": "eventLogService",
"description": [],
"signature": [
"IEventLogService"
],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract",
"type": "Interface",
"tags": [],
"label": "RuleRegistryPluginStartContract",
"description": [],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest",
"type": "Function",
"tags": [],
"label": "getRacClientWithRequest",
"description": [],
"signature": [
"(req: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
"AlertsClient",
">"
],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract.alerting",
"type": "Object",
"tags": [],
"label": "alerting",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
}
],
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.parseTechnicalFields",
"type": "Function",
"tags": [],
"label": "parseTechnicalFields",
"description": [],
"signature": [
"(input: unknown) => OutputOf<",
"Optional",
"<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>"
],
"path": "x-pack/plugins/rule_registry/common/parse_technical_fields.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.parseTechnicalFields.$1",
"type": "Unknown",
"tags": [],
"label": "input",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/rule_registry/common/parse_technical_fields.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink