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.

Sign up for GitHub

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

Jump to bottom

[processor/resourcedetection] Produce docs based on metadata.yaml #34210

Closed
ChrsMark opened this issue Jul 23, 2024 · 5 comments · Fixed by #35737
Closed

[processor/resourcedetection] Produce docs based on metadata.yaml #34210

ChrsMark opened this issue Jul 23, 2024 · 5 comments · Fixed by #35737
Labels
documentation Improvements or additions to documentation processor/resourcedetection Resource detection processor

Comments

@ChrsMark
Copy link
Member

Component(s)

processor/resourcedetection

Describe the issue you're reporting

Based on the discussion at #34140, it would be nice and more straightforward to produce docs files for this processor based on the metadata.yaml files.

We can follow what the hostmetricsreceiver does and from the main readme link to the various sub-components.

/cc @codeboten
@ChrsMark ChrsMark added the needs triage New item requiring triage label Jul 23, 2024
@github-actions github-actions bot added the processor/resourcedetection Resource detection processor label Jul 23, 2024
@github-actions GitHub Actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@crobert-1 crobert-1 mentioned this issue Jul 23, 2024
Closed
@crobert-1
Copy link
Member

Thanks for filing @ChrsMark!

I ended up filing open-telemetry/opentelemetry-collector#10705 because I was a bit confused as to why there isn't a documentation.md file for the EKS detector's resource attributes. Once we have one we'll be able to link to it from the top-level README.

@crobert-1 crobert-1 added documentation Improvements or additions to documentation and removed needs triage New item requiring triage labels Jul 23, 2024
@github-actions github-actions bot mentioned this issue Jul 30, 2024
Closed
@github-actions GitHub Actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Sep 23, 2024
@ChrsMark ChrsMark removed the Stale label Sep 23, 2024
@ChrsMark ChrsMark mentioned this issue Sep 23, 2024
Merged
mx-psi pushed a commit to open-telemetry/opentelemetry-collector that referenced this issue Oct 4, 2024
@ChrsMark
[mdatagen] Generate documentation for components with resource attrib…
a260518 
…utes only (#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
#10705
and also applies at
open-telemetry/opentelemetry-collector-contrib#34210.

<!-- Issue number if applicable -->
#### Link to tracking issue
Fixes
#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]>
@ChrsMark
Copy link
Member Author

ChrsMark commented Oct 4, 2024

Since open-telemetry/opentelemetry-collector#10705 is completed we can proceed with tuning the processor's docs accordingly once the latest version of mdatagen is pulled in contrib.

jackgopack4 pushed a commit to jackgopack4/opentelemetry-collector that referenced this issue Oct 8, 2024
@ChrsMark @jackgopack4
[mdatagen] Generate documentation for components with resource attrib…
94d85fd 
…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]>
@ChrsMark ChrsMark mentioned this issue Oct 11, 2024
Merged
@ChrsMark
Copy link
Member Author

The documentation pages were generated with https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/35701/files#diff-a118362df118f1449a78a69e67f50a87d9c86e3b3bbeadb5d01fb15129fd5cc7R1 🎉 .

Filed #35737 as an attempt to adjust the processor's docs accordingly.

@mx-psi mx-psi closed this as completed in 1773b66 Oct 30, 2024
zzhlogin pushed a commit to zzhlogin/opentelemetry-collector-contrib-aws that referenced this issue Nov 12, 2024
@ChrsMark @zzhlogin
[chore] Reference documentation.md for resource attributes per resour…
de9ddc2 
…ce detector (open-telemetry#35737)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This PR fixes the issue described at
open-telemetry#34210.
Each detector's docs should list the resource attributes as they are
defined by the `metadata.yml` files.

This PR links each detector to its `documentation.md` as a reference for
the respective Resource Atrributes.



<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes
open-telemetry#34210

<!--Describe what testing was performed and which tests were added.-->
#### Testing ~

<!--Describe the documentation added.-->
#### Documentation
Added
<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <[email protected]>
sbylica-splunk pushed a commit to sbylica-splunk/opentelemetry-collector-contrib that referenced this issue Dec 17, 2024
@ChrsMark @sbylica-splunk
[chore] Reference documentation.md for resource attributes per resour…
478fa80 
…ce detector (open-telemetry#35737)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This PR fixes the issue described at
open-telemetry#34210.
Each detector's docs should list the resource attributes as they are
defined by the `metadata.yml` files.

This PR links each detector to its `documentation.md` as a reference for
the respective Resource Atrributes.



<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes
open-telemetry#34210

<!--Describe what testing was performed and which tests were added.-->
#### Testing ~

<!--Describe the documentation added.-->
#### Documentation
Added
<!--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
@ChrsMark @HongChenTW
[mdatagen] Generate documentation for components with resource attrib…
9f06205 
…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
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation processor/resourcedetection Resource detection processor
Projects
None yet
Milestone
No milestone
2 participants
@ChrsMark @crobert-1