Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

fix prometheus log message terminology#9256

Merged
bkchr merged 1 commit intoparitytech:masterfrom
gangelop:prometheus-strict-language
Jul 2, 2021
Merged

fix prometheus log message terminology#9256
bkchr merged 1 commit intoparitytech:masterfrom
gangelop:prometheus-strict-language

Conversation

@gangelop
Copy link
Copy Markdown
Contributor

@gangelop gangelop commented Jul 2, 2021

A prometheus "server" typically refers to the prometheus process running
on a central server which connects to various prometheus "exporters" and
collects metrics. What is implemented here in substrate is a prometheus
exporter.

This patch fixes the associated log message to avoid confusion for new
users.

  • You added a brief description of the PR, e.g.:
    • What does it do?
    • What important points reviewers should know?
    • Is there something left for follow-up PRs?
  • You labeled the PR appropriately if you have permissions to do so:
    • A* for PR status (one required)
    • B* for changelog (one required)
    • C* for release notes (exactly one required)
    • D* for various implications/requirements
    • Github's project assignment
  • You mentioned a related issue if this PR related to it, e.g. Fixes #228 or Related #1337.
  • You asked any particular reviewers to review. If you aren't sure, start with GH suggestions.
  • Your PR adheres to the style guide
    • In particular, mind the maximal line length of 100 (120 in exceptional circumstances).
    • There is no commented code checked in unless necessary.
    • Any panickers have a proof or removed.
  • You bumped the runtime version if there are breaking changes in the runtime.
  • You updated any rustdocs which may have changed
  • Has the PR altered the external API or interfaces used by Polkadot? Do you have the corresponding Polkadot PR ready?

Refer to the contributing guide for details.

After you've read this notice feel free to remove it.
Thank you!

✄ -----------------------------------------------------------------------------

A prometheus "server" typically refers to the prometheus process running
on a central server which connects to various prometheus "exporters" and
collects metrics. What is implemented here in substrate is a prometheus
exporter.

This patch fixes the associated log message to avoid confusion for new
users.
@cla-bot-2021
Copy link
Copy Markdown

cla-bot-2021 bot commented Jul 2, 2021

User @gangelop, please sign the CLA here.

@gangelop
Copy link
Copy Markdown
Contributor Author

gangelop commented Jul 2, 2021

Forgot to mention this for reference:
https://prometheus.io/docs/introduction/glossary/#exporter

@bkchr bkchr added A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Jul 2, 2021
@bkchr bkchr merged commit cf4e320 into paritytech:master Jul 2, 2021
@gangelop gangelop deleted the prometheus-strict-language branch July 2, 2021 13:32
@asymmetric
Copy link
Copy Markdown
Contributor

Thank you for this one, was just scratching my head about what the log message actually meant!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants