kibana/x-pack/plugins/stack_alerts
2021-06-21 11:11:15 +01:00
..
common Move ES aggregation types to src/core (#102597) 2021-06-21 11:11:15 +01:00
public
server Move ES aggregation types to src/core (#102597) 2021-06-21 11:11:15 +01:00
jest.config.js
kibana.json
README.md
tsconfig.json

stack_alerts plugin

This plugin provides alertTypes shipped with Kibana for use with the the alerting plugin. When enabled, it will register the alertTypes by the Stack in the alerting plugin, register associated HTTP routes, etc.

The plugin setup and start contracts for this plugin are the following type, which provides some runtime capabilities. Each built-in alertType will have it's own top-level property in the IService interface, if it needs to expose functionality.

export interface IService {
  indexThreshold: {
     timeSeriesQuery(params: TimeSeriesQueryParameters): Promise<TimeSeriesResult>;
  }
}

Each Stack AlertType is described in it's own README: