kibana/x-pack/plugins/alerting_builtins
2020-03-19 18:29:26 -04:00
..
common/alert_types/index_threshold [Alerting] replace index threshold graph usage of watcher APIs with new API (#59385) 2020-03-06 10:26:52 -05:00
server [Alerting] add functional tests for index threshold alertType (#60597) 2020-03-19 18:29:26 -04:00
kibana.json [alerting] initial index threshold alertType and supporting APIs (#57030) 2020-02-28 11:48:28 -05:00
README.md [alerting] initial index threshold alertType and supporting APIs (#57030) 2020-02-28 11:48:28 -05:00

alerting_builtins plugin

This plugin provides alertTypes shipped with Kibana for use with the the alerting plugin. When enabled, it will register the built-in alertTypes with 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 built-in alertType is described in it's own README: