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

[mdatagen] Documentation is not generated for resource attributes without metrics #10705

Open
crobert-1 opened this issue Jul 23, 2024 · 1 comment · May be fixed by #11242
Open

[mdatagen] Documentation is not generated for resource attributes without metrics #10705

crobert-1 opened this issue Jul 23, 2024 · 1 comment · May be fixed by #11242
Labels
bug Something isn't working

Comments

@crobert-1
Copy link
Member

Describe the bug

When looking into open-telemetry/opentelemetry-collector-contrib#34210, I was confused as to why no documentation.md file was generated for the EKS detector of the resource detection processor, as it has a metadata.yaml file. However, I found that the documentation.md file is only generated if there are metrics or internal metrics defined.

Steps to reproduce

Run mdatagen against a metadata.yaml file that does not include metrics or internal metrics, but includes resource attributes

What did you expect to see?

A documentation.md file 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.0

@ChrsMark
Copy link
Member

ChrsMark commented Sep 23, 2024

@crobert-1 I tried my hand at it and filed #10705. I'm not quite familiar with mdatagen concept so I'm not sure if I have missed/broken anything in my attempt :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
2 participants