Missing documentation for query metricset

[masci]

Current docs at https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-metricset-mysql-query.html don't show how the module is supposed to be configured, in particular users have a hard time finding out that:

• If the query metricset is enabled, the queries parameter is mandatory, otherwise you get the error Error getting metricbeat modules: module initialization error: 1 error: missing required field accessing ‘0.queries’
• the queries config param has to be an array, see the following example:

• module: mysql metricsets:
  • status
  • galera_status
  • performance
  • query period: 10s namespace: "my_namespace" queries:
  • query: "SELECT * FROM performance_schema.global_status" response_format: "variables" query_namespace: "my_first_query_namespace"
  • query: "SELECT * FROM performance_schema.global_status" response_format: "variables" query_namespace: "my_second_query_namespace"

• the response_format is the same as sql_response_format in the SQL Module, documentation can be found there 🙈

[elasticmachine]

Pinging @elastic/integrations (Team:Integrations)

[jakefeasey]

This is still a present issue, I have had to come to this issue to find out why I have been unable to get the query metric set to work.

[kaykhancheckpoint]

Im also having the same problem with the aws module, it's really difficult to know without documentation which metricset require additional details

[botelastic[bot]]

Hi! We just realized that we haven't looked into this issue in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!

[djpain]

👍 I just ran into this today, So I do think the docs need to be updated.

[botelastic[bot]]

Hi! We just realized that we haven't looked into this issue in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!