Rule help text override is ignored

[marceldegraaf]

According to the code it's possible to add a help tag to a JSON metrics object, which – I guess – should then be used in the metrics output for Prometheus. For example:

{
  "metrics": [
    {
      "help": "test",
      "aws_namespace": "AWS/DynamoDB",
      "aws_metric_name": "ProvisionedReadCapacityUnits",
      "aws_dimensions": [ ... ],
      "aws_dimension_select_regex": { ... }
    }
  ]
}

However, when compiling the final help text for Prometheus, this override is ignored. Instead of returning rule.help, a generated help string is always returned.

[brian-brazil]

Thanks for the report, that's a silly bug. I've put it on our list for the Digital Ocean Hacktoberfest as it's a nice starter project.

[marceldegraaf]

Hi @brian-brazil, any news on this? Because of this limitation we can currently not export some data to Prometheus, because the export file contains multiple identical help strings which is invalid syntax.

[brian-brazil]

the export file contains multiple identical help strings which is invalid syntax.

That should be valid syntax, only if they're different will you get an error last time I checked.

[brian-brazil]

This was fixed in #12

[marceldegraaf]

Great, thanks!