Skip to content

Commit

Permalink
[Alerts][Doc] Added README documentation for alerts plugin status and…
Browse files Browse the repository at this point in the history
… framework health checks configuration options.
  • Loading branch information
YulNaumenko committed Feb 25, 2021
1 parent deb555a commit 7fd16ef
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions x-pack/plugins/alerts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Table of Contents
- [Terminology](#terminology)
- [Usage](#usage)
- [Limitations](#limitations)
- [Plugin status](#plugin-status)
- [Alert types](#alert-types)
- [Methods](#methods)
- [Executor](#executor)
Expand Down Expand Up @@ -64,6 +65,27 @@ Note that the `manage_own_api_key` cluster privilege is not enough - it can be u
is unauthorized for user [user-name-here]
```

## Plugin status

Alerts plugin's status is customized by including information about checking framework decryption failures:
```
core.status.set(
combineLatest([
core.status.derivedStatus$,
getHealthStatusStream(startPlugins.taskManager),
]).pipe(
map(([derivedStatus, healthStatus]) => {
if (healthStatus.level > derivedStatus.level) {
return healthStatus as ServiceStatus;
} else {
return derivedStatus;
}
})
)
);
```
To check framework decryption failures we use task `alerting_health_check`, which runs with default interval 60 mins. To change the dafault schedule use kibana.yml configuration option `xpack.alerts.healthCheck.interval: 60m`.

## Alert types

### Methods
Expand Down

0 comments on commit 7fd16ef

Please sign in to comment.