History

Yuliia Naumenko f589c2fc29 [Alerting] Rename alertTypeRegistry to ruleTypeRegistry according to the new terminology. (#106519 ) * [Alerting] Renamed Alerting framework AlertsClient to RulesClient according to the new terminology. * fixed path * fixed type checks * fixed type checks * [Alerting] Rename alertTypeRegistry to ruleTypeRegistry. * Apply suggestions from code review Co-authored-by: ymao1 <ying.mao@elastic.co> * fixed type checks * fixed tests * fixed merge issues * fixed merge issues * fixed tests * fixed tests * fixed functional tests Co-authored-by: ymao1 <ying.mao@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>		2021-07-27 10:03:00 -07:00
..
common	Move ES aggregation types to src/core (#102597 )	2021-06-21 11:11:15 +01:00
public	[Alerting] Rename alertTypeRegistry to ruleTypeRegistry according to the new terminology. (#106519 )	2021-07-27 10:03:00 -07:00
server	[Es query] Move to package (#103530 )	2021-07-21 17:10:55 +02:00
jest.config.js
kibana.json	Rename alerts plugin to alerting (#92898 )	2021-03-05 13:59:34 -05:00
README.md	Rename alerts plugin to alerting (#92898 )	2021-03-05 13:59:34 -05:00
tsconfig.json	Revert "TS Incremental build exclude test files (#95610 )" (#96223 )	2021-04-05 11:59:26 -07:00

README.md

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:

index threshold: server/alert_types/index_threshold