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.

Sign up for GitHub

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

Jump to bottom

Add x-pack monitoring note to kibana/es docs #4012

Merged
merged 1 commit into from
Apr 25, 2017
Merged

Add x-pack monitoring note to kibana/es docs #4012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions metricbeat/docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ include::../../libbeat/docs/version.asciidoc[]
:beatname_lc: metricbeat
:beatname_uc: Metricbeat
:security: X-Pack Security
:monitoringdoc: https://www.elastic.co/guide/en/x-pack/current

include::./overview.asciidoc[]

Expand Down
4 changes: 2 additions & 2 deletions metricbeat/docs/modules/elasticsearch.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ This file is generated! See scripts/docs_collector.py
////

[[metricbeat-module-elasticsearch]]
== elasticsearch Module
== Elasticsearch Module

This is the elasticsearch Module. The elasticsearch module contains a minimal set of metrics to enable monitoring of elasticsearch across multiple versions.
This is the Elasticsearch Module. The Elasticsearch module contains a minimal set of metrics to enable monitoring of Elasticsearch across multiple versions. To monitor more Elasticsearch metrics, use our {monitoringdoc}/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license.


[float]
Expand Down
6 changes: 2 additions & 4 deletions metricbeat/docs/modules/kibana.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ This file is generated! See scripts/docs_collector.py
////

[[metricbeat-module-kibana]]
== kibana Module

This is the kibana Module.
== Kibana Module

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.
Copy link

Choose a reason for hiding this comment

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

@ruflin what high level metrics are we tracking? can you point me to a PR/issue?

Copy link
Member Author

Choose a reason for hiding this comment

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

@bohyun-e here you can find all the fields: https://github.com/elastic/beats/blob/master/metricbeat/module/kibana/status/_meta/data.json

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

deal



[float]
Expand All @@ -23,7 +22,6 @@ metricbeat.modules:
enabled: false
period: 10s
hosts: ["localhost:5601"]

----

[float]
Expand Down
1 change: 0 additions & 1 deletion metricbeat/metricbeat.full.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,6 @@ metricbeat.modules:
period: 10s
hosts: ["localhost:5601"]


#------------------------------- kubelet Module ------------------------------
- module: kubelet
metricsets: ["node","container","volume","pod","system"]
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/module/elasticsearch/_meta/docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
== elasticsearch Module
== Elasticsearch Module

This is the elasticsearch Module. The elasticsearch module contains a minimal set of metrics to enable monitoring of elasticsearch across multiple versions.
This is the Elasticsearch Module. The Elasticsearch module contains a minimal set of metrics to enable monitoring of Elasticsearch across multiple versions. To monitor more Elasticsearch metrics, use our {monitoringdoc}/xpack-monitoring.html[X-Pack monitoring] which is available under a free basic license.
1 change: 0 additions & 1 deletion metricbeat/module/kibana/_meta/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@
enabled: false
period: 10s
hosts: ["localhost:5601"]

5 changes: 2 additions & 3 deletions metricbeat/module/kibana/_meta/docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
== kibana Module

This is the kibana Module.
== Kibana Module

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.
1 change: 1 addition & 0 deletions metricbeat/module/kibana/_meta/fields.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[]experimental

kibana Module
short_config: false
fields:
- name: kibana
type: group
Expand Down