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] Generate documentation for components with resource attributes only #11242

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ChrsMark
Copy link
Member

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.

Link to tracking issue

Fixes #10705

Testing

Tuned tests and added a sample processor component which only defines resource attributes.

Documentation

@ChrsMark ChrsMark requested a review from a team as a code owner September 23, 2024 08:42
Copy link

codecov bot commented Sep 23, 2024

Codecov Report

Attention: Patch coverage is 92.04545% with 7 lines in your changes missing coverage. Please review.

Project coverage is 91.47%. Comparing base (52e11ec) to head (b3e22ec).

Files with missing lines Patch % Lines
...pleprocessor/internal/metadata/generated_config.go 88.23% 2 Missing and 2 partials ⚠️
...eprocessor/internal/metadata/generated_resource.go 91.42% 3 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11242   +/-   ##
=======================================
  Coverage   91.47%   91.47%           
=======================================
  Files         424      427    +3     
  Lines       20206    20293   +87     
=======================================
+ Hits        18484    18564   +80     
- Misses       1339     1344    +5     
- Partials      383      385    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…utes only

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark force-pushed the metagen_resource_attrs_only_doc branch from cc2566e to fd38c70 Compare September 27, 2024 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[mdatagen] Documentation is not generated for resource attributes without metrics
1 participant