[receiver/prometheus] Cleanup and restructure README#41251
Merged
songy23 merged 1 commit intoJul 11, 2025
Conversation
ChristianCiach
requested review from
a team,
ArthurSens and
dashpole
as code owners
dashpole
approved these changes
Jul 11, 2025
Contributor
|
Thanks! |
Dylan-M
pushed a commit
to Dylan-M/opentelemetry-collector-contrib
that referenced
this pull request
Aug 5, 2025
…41251) #### Description The README of this receiver is really hard to read. It seems like, over time, new sections have been inserted at really bad places, disrupting the flow of existing text. For example, just below the `Feature gates` section there was this text: ``` - `report_extra_scrape_metrics`: Extra Prometheus scrape metrics can be reported by setting this parameter to `true` You can copy and paste that same configuration under: ``yaml receivers: prometheus: config: `` ``` * What is `report_extra_scrape_metrics` talking about? What does this have to do with the `RemoveStartTimeAdjustment` feature gate? * What is `You can copy and paste that same configuration under:` talking about? What "configuration"? The Feature gates? It took a while to figure out what the README tries to tell me. I've moved the "Feature Gates" paragraph as its own section to the end of the file, to be more in line with the other READMEs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README of this receiver is really hard to read. It seems like, over time, new sections have been inserted at really bad places, disrupting the flow of existing text.
For example, just below the
Feature gatessection there was this text:report_extra_scrape_metricstalking about? What does this have to do with theRemoveStartTimeAdjustmentfeature gate?You can copy and paste that same configuration under:talking about? What "configuration"? The Feature gates?It took a while to figure out what the README tries to tell me.
I've moved the "Feature Gates" paragraph as its own section to the end of the file, to be more in line with the other READMEs.