Uploaded image for project: 'Percona Monitoring and Management'
  1. Percona Monitoring and Management
  2. PMM-4902

Update #HELP comments in mongodb_exporter Oct 2019

    XMLWordPrintable

    Details

    • Needs Review:
      Yes
    • Needs QA:
      Yes
    • Needs Packaging:
      Yes
    • Needs Doc:
      No

      Description

      Whilst doing PMM-4857 I have created an update for all the "# HELP ..." descriptions that removes the long descriptions and replaces them with the mongodb source metric. I found too many of the metric names were too vague. The generic names too often resembled not one but several source metrics in MongoDB serverStatus etc. output. And/or don't indicate the dimension/label level in them.

      These HELP comments are not for general user reading, you only see them if looking at raw prometheus exporter pages. So this is patch for the sake of programmers. They will be able to easily lookup the MongoDB documentation (just cut and paste into google, click) for the metric source from these rewritten help field strings.

      https://github.com/percona/mongodb_exporter/pull/165

        Smart Checklist

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                Unassigned
                Reporter:
                akira.kurogane Akira Kurogane
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                  Dates

                  Created:
                  Updated: