kibana/x-pack/plugins/stack_alerts/README.md
Mike Côté 23ce8dcfdb
Rename alerts plugin to alerting (#92898)
* Rename alerts plugin to alerting

* Deprecate old config values

* Few more renames

* Update plugin list

* Rename xpack.alerts -> xpack.alerting

* Fix some ESLint rules

* Fix typecheck

* Fix some test failures

* Some more renames

* Fix ESLint

* Fix some test failures

* Fix failing jest test

* Undo exclusive test

* Fix APM deps

* Fix docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-05 13:59:34 -05:00

822 B

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: