Provide a fuller example in modules.d/elasticsearch.yml.disabled

[ppf2]

Currently, the out of the box modules.d/elasticsearch.yml.disabled file shows just the following:

# Module: elasticsearch
# Docs: https://www.elastic.co/guide/en/beats/metricbeat/6.7/metricbeat-module-elasticsearch.html

- module: elasticsearch
  #metricsets:
  #  - node
  #  - node_stats
  period: 10s
  hosts: ["http://localhost:9200"]
  #username: "user"
  #password: "secret"

Will be nice if we improve the above to the following:

# Module: elasticsearch
# Docs: https://www.elastic.co/guide/en/beats/metricbeat/6.7/metricbeat-module-elasticsearch.html


- module: elasticsearch
  metricsets:
    - ccr
    - cluster_stats
    - index
    - index_recovery
    - index_summary
    - ml_job
    - node
    - node_stats
    - shard
  period: 10s
  hosts: ["http://localhost:9200"] 
  username: "user"
  password: "secret"
  xpack.enabled: true

The above will be consistent with the documentation. Some of the above flags are important (such as xpack.enabled; if missed the monitoring UI will not show any data because the ES module metrics would be indexed to metricbeat* indices instead of .monitoring* by default).

Speaking of documentation, Step 3c is missing - node btw.

[elasticmachine]

Pinging @elastic/stack-monitoring

[ycombinator]

Related: #9118

[ycombinator]

Speaking of documentation, Step 3c is missing - node btw.

For X-Pack Monitoring, the node metricset is not required. That's why it's not in the documentation.

[ycombinator]

@ppf2 @cachedout @ruflin I'm curious to hear your thoughts on this request. I see two possible options here:

1. We could do essentially what this request is asking for, by providing a commented-out section for setting up stack (x-pack) monitoring in each stack module's configuration file. Users who want to use a stack module for stack monitoring would then need to comment out the uncommented section and uncomment the commented-out section.

OR

2. We could revive the proposal in Module configuration variants #9118.

I'd prefer option 2 as I think it's a better user experience. But we've already had a lot of discussion around naming and such on #9118 which made be a bit weary TBH. So I'd prefer to revive it only if we all agree that it's the right direction to go in. Thoughts?

[ppf2]

For X-Pack Monitoring, the node metricset is not required. That's why it's not in the documentation.

Ah that's good to know, thx! Yah I think it will be good to abstract this out so that end users will not have to figure out the minimum metricsets they will have to add for stack monitoring to work. Maybe we can update https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-metricset-elasticsearch-node.html to indicate that this is not necessary for xpack monitoring? (and remove that from the modules.d/elasticsearch.yml.disabled commented example)

[cachedout]

@ycombinator I'm a strong +1 on the second option. From a quick glance through that issue, it mostly seems like the last remaining concerns were from @ruflin. Maybe we can just sync up to work through them?

[ycombinator]

Great, thanks for weighing in @ppf2 and @cachedout. I'll revive #9118 now.

[ycombinator]

@ppf2 Update: #9118 was merged yesterday and I'm working on doc updates in elastic/elasticsearch#40879 and elastic/kibana#34599.

[cachedout]

Nicely done, @ycombinator ! I've left reviews on the two PRs you link above.

[cachedout]

@ycombinator All the PRs you link are now merged. Close this?