[chore][receivercreator] docs: add data type to endpoints variables #31407
Conversation
This file contains 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
andrzej-stencel
changed the title
andrzej-stencel
changed the title
andrzej-stencel
added
the
Skip Changelog
andrzej-stencel
approved these changes
Feb 26, 2024
dmitryax
approved these changes
Feb 27, 2024
|
Thanks @chenlujjj! |
XinRanZhAWS
pushed a commit
to XinRanZhAWS/opentelemetry-collector-contrib
that referenced
this pull request
Mar 13, 2024
…pen-telemetry#31407) **Description:** Adding data type to endpoints(pod/port/node/...) variables in the readme doc. The reason why I'd like to do this is, I tried to use the receiver creator to scrape metrics with prometheus receiver and the configuration is like: ``` receiver_creator/1: receivers: prometheus_simple/app_pods: rule: type == "port" && pod.annotations["prometheus.io/scrape"] == "true" && ( port == pod.annotations["prometheus.io/port"] || name == pod.annotations["prometheus.io/port"] ) config: endpoint: '`endpoint`' metrics_path: '`"prometheus.io/path" in pod.annotations ? pod.annotations["prometheus.io/path"] : "/metrics"`' collection_interval: '`"prometheus.io/collection_interval" in pod.annotations ? pod.annotations["prometheus.io/collection_interval"] : "10s"`' ``` I made a silly mistake here in `port == pod.annotations["prometheus.io/port"]`, I ignored the data type of `port` variable and it took me a while to fix it. So I think it will help others and avoid such kinds of mistakes to add the data types in readme.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
Adding data type to endpoints(pod/port/node/...) variables in the readme doc.
The reason why I'd like to do this is, I tried to use the receiver creator to scrape metrics with prometheus receiver and the configuration is like:
I made a silly mistake here in
port == pod.annotations["prometheus.io/port"], I ignored the data type ofportvariable and it took me a while to fix it.So I think it will help others and avoid such kinds of mistakes to add the data types in readme.
Link to tracking Issue:
Testing:
Documentation: