Add x-pack monitoring note to kibana/es docs #4012
Conversation
ruflin
commented
Apr 13, 2017
ruflin
commented
- Remove kibana from the short config and comment it out by default
|
Needs rebase when #4014 is merged |
| @@ -7,6 +7,7 @@ This file is generated! See scripts/docs_collector.py | |||
|
|
|||
| This is the elasticsearch Module. The elasticsearch module contains a minimal set of metrics to enable monitoring of elasticsearch across multiple versions. | |||
|
|
|||
| For more detailed monitoring of elasticsearch use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
Can you create a variable in the index.asciidoc file and use the variable to resolve the path?
Add this to index.asciidoc:
:monitoringdoc: https://www.elastic.co/guide/en/x-pack/current
Then use {monitoringdoc}/xpack-monitoring.html[free x-pack monitoring].
Note that for X-Pack we don't use {doc-branch} to resolve the branch because we end up with broken links in master (for X-Pack, we don't build/publish docs in master).
| @@ -7,6 +7,7 @@ This file is generated! See scripts/docs_collector.py | |||
|
|
|||
| This is the elasticsearch Module. The elasticsearch module contains a minimal set of metrics to enable monitoring of elasticsearch across multiple versions. | |||
|
|
|||
| For more detailed monitoring of elasticsearch use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
Oh also please capitalize Elasticsearch. :-)
| @@ -5,7 +5,7 @@ This file is generated! See scripts/docs_collector.py | |||
| [[metricbeat-module-kibana]] | |||
| == kibana Module | |||
|
|
|||
| This is the kibana Module. | |||
| This is the kibana Module and only tracks the high level metrics. For more detailed monitoring of kibana use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
ditto - same comments as above.
| @@ -7,6 +7,7 @@ This file is generated! See scripts/docs_collector.py | |||
|
|
|||
| This is the elasticsearch Module. The elasticsearch module contains a minimal set of metrics to enable monitoring of elasticsearch across multiple versions. | |||
|
|
|||
| For more detailed monitoring of elasticsearch use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
May I suggest saying something like "To monitor more Elasticsearch metrics, use our https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license."
| @@ -5,7 +5,7 @@ This file is generated! See scripts/docs_collector.py | |||
| [[metricbeat-module-kibana]] | |||
| == kibana Module | |||
|
|
|||
| This is the kibana Module. | |||
| This is the kibana Module and only tracks the high level metrics. For more detailed monitoring of kibana use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
May I suggest saying something like "To monitor more Kibana metrics, use our https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license.
| @@ -2,3 +2,4 @@ | |||
|
|
|||
| This is the elasticsearch Module. The elasticsearch module contains a minimal set of metrics to enable monitoring of elasticsearch across multiple versions. | |||
|
|
|||
| For more detailed monitoring of elasticsearch use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
May I suggest saying something like "To monitor more Elasticsearch metrics, use our https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license."
| @@ -1,4 +1,4 @@ | |||
| == kibana Module | |||
|
|
|||
| This is the kibana Module. | |||
| This is the kibana Module and only tracks the high level metrics. For more detailed monitoring of kibana use the https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[free x-pack monitoring]. | |||
There was a problem hiding this comment.
May I suggest saying something like "To monitor more Kibana Elasticsearch metrics, use our https://www.elastic.co/guide/en/x-pack/current/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license."
|
@bohyun-e @dedemorton Reviews applied. Can you check again? |
|
@ruflin I'll probably take a pass at editing the content for the new modules after they're merged, but this looks good for now. |
|
|
||
| This is the Kibana Module and only tracks the high level metrics. To monitor more Kibana metrics, use our {monitoringdoc}/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license. |
There was a problem hiding this comment.
@ruflin what high level metrics are we tracking? can you point me to a PR/issue?
There was a problem hiding this comment.
@bohyun-e here you can find all the fields: https://github.com/elastic/beats/blob/master/metricbeat/module/kibana/status/_meta/data.json
There was a problem hiding this comment.
It might be worth adding a bit more clarification so users know what you mean by high-level metrics. So something like this:
The Kibana module tracks high-level metrics, such as the number of current connections, the number of requests, and the overall status of Kibana.
I'd keep it short to give users a general sense of what we mean by high-level.
There was a problem hiding this comment.
LGTM with the understanding that we'll flesh out the details of what we mean by "high-level metrics" when this module is more mature.
* Remove kibana from the short config and comment it out by default
