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

[Alerting][Docs] adds documentation on NTP based synchronization #90747

Merged
merged 2 commits into from
Feb 11, 2021

Conversation

gmmorris
Copy link
Contributor

@gmmorris gmmorris commented Feb 9, 2021

Summary

Part of #89997

Adds documentation on NTP based synchronization to the Alerting docs.

I've kept the description close to the Watcher one on purpose: https://www.elastic.co/guide/en/elasticsearch/reference/current/trigger-schedule.html

Checklist

Delete any items that are not applicable to this PR.

  • Documentation was added for features that require explanation or tutorials

@gmmorris gmmorris requested a review from a team as a code owner February 9, 2021 11:05
@gmmorris gmmorris added Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Team:Docs v7.12.0 v8.0.0 labels Feb 9, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@gmmorris gmmorris added the release_note:skip Skip the PR/issue when compiling release notes label Feb 9, 2021
Copy link
Member

@pmuellr pmuellr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this belongs somewhere else.

@@ -6,6 +6,7 @@

* *Persistence*: all task state and scheduling is stored in {es}, so if {kib} is restarted, alerts and actions will pick up where they left off. Task definitions for alerts and actions are stored in the index specified by `xpack.task_manager.index` (defaults to `.kibana_task_manager`). It is important to have at least 1 replica of this index for production deployments, since if you lose this index all scheduled alerts and actions are also lost.
* *Scaling*: multiple {kib} instances can read from and update the same task queue in {es}, allowing the alerting and action load to be distributed across instances. In cases where a {kib} instance no longer has capacity to run alert checks or actions, capacity can be increased by adding additional {kib} instances.
* *Synchronization*: {es} and {kib} instances use the system clock to determine the current time. To ensure schedules are triggered when expected, you should synchronize the clocks of all nodes in the cluster using a time service such as http://www.ntp.org/[Network Time Protocol].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description of this is fine, but the context seems wrong. This isn't a benefit, AFAIK, it's a requirement. :-)

If it does happen to be a benefit, then the sentence above needs to be changed to

This has THREE major benefits:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, I missed that 😬

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tylersmalley
Copy link
Contributor

Jenkins, test it

@tylersmalley
Copy link
Contributor

Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@pmuellr pmuellr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thx!

@gmmorris gmmorris merged commit 4834de6 into elastic:master Feb 11, 2021
gmmorris added a commit to gmmorris/kibana that referenced this pull request Feb 11, 2021
…stic#90747)

Adds docs on usage of NTP to sync nodes in a prod setting for alerting.
gmmorris added a commit to gmmorris/kibana that referenced this pull request Feb 11, 2021
* master:
  [Alerting][Docs] adds documentation on NTP based synchronization (elastic#90747)
gmmorris added a commit that referenced this pull request Feb 11, 2021
) (#91101)

Adds docs on usage of NTP to sync nodes in a prod setting for alerting.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.12.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants