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

[DOCS] improving production documentation for task manager and alerting #87484

Merged

Conversation

bmcconaghy
Copy link
Contributor

Closes #78431

Adding documentation for settings for task manager, calling out specifically that the task manager index needs to have a replica count of at least 1 for production, and renaming a section to make its purpose clearer.

@bmcconaghy bmcconaghy added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes docs v7.11.0 v7.12.0 labels Jan 6, 2021
@bmcconaghy bmcconaghy requested a review from a team as a code owner January 6, 2021 13:56
Comment on lines 22 to 24
| `xpack.task_manager.max_poll_inactivity_cycles`
| How many poll interval cycles can work take before it's timed out. Defaults to 10.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure we should include this.
I don't expect customers to change this - if they go too low it might restart TM prematurely and we've yet to see a deployment where the default wasn't sufficient

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK will remove.

Copy link
Contributor

@gmmorris gmmorris left a comment

Choose a reason for hiding this comment

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

Other than the comments I made this all makes sense 👍
LGTM

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!

@bmcconaghy bmcconaghy merged commit 7efcdb8 into elastic:master Jan 6, 2021
@bmcconaghy bmcconaghy deleted the improve_alerting_production_docs branch January 6, 2021 14:59
bmcconaghy added a commit to bmcconaghy/kibana that referenced this pull request Jan 6, 2021
…ng (elastic#87484)

* improving production documentation for task manager and alerting

* calling it Kibana Task Manager to be more explicit

* addressing PR feedback
bmcconaghy added a commit that referenced this pull request Jan 6, 2021
…ng (#87484) (#87502)

* improving production documentation for task manager and alerting

* calling it Kibana Task Manager to be more explicit

* addressing PR feedback
bmcconaghy added a commit that referenced this pull request Jan 6, 2021
…ng (#87484) (#87503)

* improving production documentation for task manager and alerting

* calling it Kibana Task Manager to be more explicit

* addressing PR feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs release_note:skip Skip the PR/issue when compiling release notes v7.11.0 v7.12.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs about .kibana_task_manager
3 participants