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

[monitoring] Document all elasticsearch settings #18448

Closed
elasticmachine opened this issue Sep 27, 2017 · 4 comments
Closed

[monitoring] Document all elasticsearch settings #18448

elasticmachine opened this issue Sep 27, 2017 · 4 comments
Assignees
Labels
Team:Docs Team:Monitoring Stack Monitoring team

Comments

@elasticmachine
Copy link
Contributor

Original comment by @jbudz:

The docs at https://www.elastic.co/guide/en/kibana/5.6/monitoring-settings-kb.html only have elasticsearch.url. Can we document the other settings too?

It should be a pretty close match to the kibana settings at https://www.elastic.co/guide/en/kibana/current/settings.html

@elasticmachine
Copy link
Contributor Author

Original comment by @inqueue:

This came up again recently with someone attempting to configure a monitoring cluster with TLS enabled. The doc says:

There are also xpack.monitoring.elasticsearch.* settings, which support the 
same values as Kibana configuration settings

This is very confusing to a newcomer and I myself had to look at Kibana source just to understand the structure of the configuration parameters for TLS/SSL. All settings supported in kibana.yml should be clearly documented, even if it means overlap with other product documentation.

@tylersmalley tylersmalley added the Team:Monitoring Stack Monitoring team label Aug 7, 2018
@lcawl lcawl removed their assignment Mar 2, 2020
@chrisronline
Copy link
Contributor

One major thing we need to correct is the prefix change that will be in 7.7.

Other than that, here are the lists of configs (using the new prefix):

monitoring.enabled
monitoring.elasticsearch  (same as elasticsearch.* settings)
monitoring.ui.enabled
monitoring.ui.ccs.enabled
monitoring.ui.logs.index
monitoring.ui.max_bucket_size
monitoring.ui.elasticsearch  (same as elasticsearch.* settings except for the ones listed below)
monitoring.ui.elasticsearch.logFetchCount
monitoring.ui.container.elasticsearch.enabled
monitoring.ui.container.logstash.enabled
monitoring.ui.min_interval_seconds
monitoring.ui.show_license_expiration
monitoring.kibana.collection.enabled
monitoring.kibana.collection.interval
monitoring.cluster_alerts.enabled
monitoring.cluster_alerts.email_notifications.enabled
monitoring.cluster_alerts.email_notifications.email_address
monitoring.xpack_api_polling_frequency_millis
monitoring.agent.interval
monitoring.tests.cloud_detector.enabled

I don't think we use monitoring.agent.interval anymore, but the rest look legit. The monitoring.cluster_alerts will go away once we shift to using Kibana alerting (which is expected to land before 8.0)

@lcawl lcawl self-assigned this Mar 4, 2020
@igoristic
Copy link
Contributor

igoristic commented Feb 11, 2021

Adding a newly created option to the current list in: #18448 (comment)

monitoring.ui.container.apm.enabled: true

Also relates to:
#90157
#37644

@KOTungseth
Copy link
Contributor

Closing due to inactivity. To further discuss, please reopen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Team:Monitoring Stack Monitoring team
Projects
None yet
Development

No branches or pull requests

6 participants