[mdatagen] Documentation is not generated for resource attributes without metrics #10705
Labels
bug
Something isn't working
Comments
|
@crobert-1 I tried my hand at it and filed #11242. I'm not quite familiar with mdatagen concept so I'm not sure if I have missed/broken anything in my attempt :). |
jackgopack4
pushed a commit
to jackgopack4/opentelemetry-collector
that referenced
this issue
Oct 8, 2024
…utes only (open-telemetry#11242) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description This PR adds support for generating `documentation.md` files for components which only define resource attributes. This was reported at open-telemetry#10705 and also applies at open-telemetry/opentelemetry-collector-contrib#34210. <!-- Issue number if applicable --> #### Link to tracking issue Fixes open-telemetry#10705 <!--Describe what testing was performed and which tests were added.--> #### Testing Tuned tests and added a sample processor component which only defines resource attributes. <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.--> Signed-off-by: ChrsMark <[email protected]>
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this issue
Dec 19, 2024
…utes only (open-telemetry#11242) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description This PR adds support for generating `documentation.md` files for components which only define resource attributes. This was reported at open-telemetry#10705 and also applies at open-telemetry/opentelemetry-collector-contrib#34210. <!-- Issue number if applicable --> #### Link to tracking issue Fixes open-telemetry#10705 <!--Describe what testing was performed and which tests were added.--> #### Testing Tuned tests and added a sample processor component which only defines resource attributes. <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.--> Signed-off-by: ChrsMark <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
When looking into open-telemetry/opentelemetry-collector-contrib#34210, I was confused as to why no
documentation.mdfile was generated for the EKS detector of the resource detection processor, as it has a metadata.yaml file. However, I found that thedocumentation.mdfile is only generated if there are metrics or internal metrics defined.Steps to reproduce
Run mdatagen against a
metadata.yamlfile that does not include metrics or internal metrics, but includes resource attributesWhat did you expect to see?
A
documentation.mdfile that includes information about valid resource attributes and how to enable and disable them.What did you see instead?
No file is generated.
What version did you use?
v0.104.0The text was updated successfully, but these errors were encountered: