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

[connector/*] generate status from metadata.yaml #22800

Merged
merged 6 commits into from
Jun 1, 2023

Conversation

mwear
Copy link
Member

@mwear mwear commented May 26, 2023

Description:
This PR adds the ability to generate status from metadata.yaml for connectors. The format for connectors differs in that stability is per connection rather than per signal as it is for other components. In addition to the code to generate status, this uses the count connector as a demonstration of how this will work in the real world.

The auto-generated code looks something like this (also, take a look at the count connector readme):

Status
Distributions contrib, sumo

Supported Pipeline Types

Exporter Pipeline Type Receiver Pipeline Type Stability Level
traces metrics development
metrics metrics development
logs metrics development

Link to tracking Issue:
This will help with the connector part of #21213.

Testing:
Manual

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this up @mwear! Add some comments, would love @djaglowski's input on this as well

connector/countconnector/README.md Show resolved Hide resolved
cmd/mdatagen/templates/readme.connector.md.tmpl Outdated Show resolved Hide resolved
@atoulme atoulme added the Skip Changelog PRs that do not require a CHANGELOG.md entry label May 31, 2023
Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If #22962 is merged before this one, we should document this on the schema file

@djaglowski
Copy link
Member

Thanks for putting this together @mwear

@mwear mwear force-pushed the connectors_gen_status branch from 695a2f6 to b160ea7 Compare June 1, 2023 16:15
@mwear mwear marked this pull request as ready for review June 1, 2023 16:18
@mwear mwear requested a review from a team June 1, 2023 16:18
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @mwear, thanks for addressing my comments.

@codeboten codeboten merged commit 921e850 into open-telemetry:main Jun 1, 2023
@github-actions github-actions bot added this to the next release milestone Jun 1, 2023
Caleb-Hurshman pushed a commit to observIQ/opentelemetry-collector-contrib that referenced this pull request Jul 6, 2023
This PR adds the ability to generate status from metadata.yaml for connectors. The format for connectors differs in that stability is per connection rather than per signal as it is for other components. In addition to the code to generate status, this uses the count connector as a demonstration of how this will work in the real world.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd/mdatagen mdatagen command connector/count Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants