Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Alerts][Doc] Added README documentation for alerts plugin status and framework health checks configuration options. #92761

Merged
merged 2 commits into from
Feb 26, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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

The plugin status of an alert is customized by including information about checking failures for the framework decryption:
```
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 for framework decryption failures, we use the task `alerting_health_check`, which runs every 60 minutes by default. To change the default schedule, use the kibana.yml configuration option `xpack.alerts.healthCheck.interval`.

## Alert types

### Methods
Expand Down