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

fix doc "collect/metamonitoring": relocate 'replace prometheus.exporter.self "<SELF_LABEL>" instruction' to correct location #2997

Merged
merged 1 commit into from
Mar 14, 2025

Conversation

edv1n
Copy link
Contributor

@edv1n edv1n commented Mar 14, 2025

PR Description

fix doc collect/metamonitoring that:

The instruction of

Replace the following:

  • <SELF_LABEL>: The label for the component such as default or metamonitoring. The label must be unique across all prometheus.exporter.self components in the same configuration file.

should be under the code block of

   prometheus.exporter.self "<SELF_LABEL>" {
   }

instead of the code block of

   prometheus.scrape "<SCRAPE_LABEL>" {
     targets    = prometheus.exporter.self.<SELF_LABEL>.targets
     forward_to = [<METRICS_RECEIVER_LIST>]
   }

Which issue(s) this PR fixes

This PR is a trivial fix, no issue is required according to the Contributing guideline

Notes to the Reviewer

I found the instruction of replacing the <SELF_LABEL> under step 2 is a bit difficult to follow, so I suggest changing it to step 1. I have also checked the doc of collect/datadog-traces-metrics to ensure consistency.

PR Checklist

I am not sure if I need to update the CHANGELOG.md as this is just a small fix of the documentation.

…us.exporter.self <SELF_LABEL> to correct location
@edv1n edv1n requested a review from clayton-cornell as a code owner March 14, 2025 15:01
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this. Approving and merging.

@clayton-cornell clayton-cornell enabled auto-merge (squash) March 14, 2025 18:17
@clayton-cornell clayton-cornell merged commit f161963 into grafana:main Mar 14, 2025
35 checks passed
github-actions bot pushed a commit that referenced this pull request Mar 14, 2025
…us.exporter.self <SELF_LABEL> to correct location (#2997)

(cherry picked from commit f161963)
github-actions bot pushed a commit that referenced this pull request Mar 14, 2025
…us.exporter.self <SELF_LABEL> to correct location (#2997)

(cherry picked from commit f161963)
github-actions bot pushed a commit that referenced this pull request Mar 14, 2025
…us.exporter.self <SELF_LABEL> to correct location (#2997)

(cherry picked from commit f161963)
clayton-cornell pushed a commit that referenced this pull request Mar 14, 2025
…us.exporter.self <SELF_LABEL> to correct location (#2997) (#3003)

(cherry picked from commit f161963)

Co-authored-by: Edwin S <[email protected]>
clayton-cornell pushed a commit that referenced this pull request Mar 14, 2025
…us.exporter.self <SELF_LABEL> to correct location (#2997) (#3005)

(cherry picked from commit f161963)

Co-authored-by: Edwin S <[email protected]>
clayton-cornell pushed a commit that referenced this pull request Mar 14, 2025
…us.exporter.self <SELF_LABEL> to correct location (#2997) (#3004)

(cherry picked from commit f161963)

Co-authored-by: Edwin S <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants