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.

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

services/horizon: Strip regexes from routes before sending to prometheus #3459

Merged

Conversation

paulbellamy
Copy link
Contributor

@paulbellamy paulbellamy commented Mar 9, 2021

Fixes #3436

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
    • The tests are not outstanding, but at least check the regexp. I had a look at testing it at the prometheus level, but didn't see a simple way to do that.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.
    • Didn't see any related docs.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.
    • Patch change.

What

Remove and escape regexes from chi routes when sending metrics to prometheus.

Why

Prometheus throws and error when metric labels contain unescaped \, ", and \n. See #3436
Also, the regular expressions are ugly and hard to remember when querying.

Known limitations

[TODO or N/A]

@paulbellamy paulbellamy requested a review from a team March 9, 2021 15:39
@paulbellamy paulbellamy force-pushed the 3436/replace-regexs-for-prometheus branch from 0a9116c to da83bb1 Compare March 9, 2021 15:56
@paulbellamy paulbellamy force-pushed the 3436/replace-regexs-for-prometheus branch from 7fb9e3d to 342d0b9 Compare March 9, 2021 16:52
@paulbellamy paulbellamy force-pushed the 3436/replace-regexs-for-prometheus branch from 342d0b9 to 7740246 Compare March 9, 2021 16:56
@paulbellamy paulbellamy merged commit 0977967 into stellar:master Mar 11, 2021
@paulbellamy paulbellamy deleted the 3436/replace-regexs-for-prometheus branch March 11, 2021 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace regexps in route name before setting Prometheus metric's label
3 participants