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

Validate that any change to default metrics defined in metadata.yaml are accompanied by a "breaking" changelog #10902

Open
atoulme opened this issue Jun 2, 2023 · 10 comments
Labels
cmd/mdatagen enhancement New feature or request

Comments

@atoulme
Copy link
Contributor

atoulme commented Jun 2, 2023

Component(s)

cmd/mdatagen

Is your feature request related to a problem? Please describe.

I want to make sure that every time we change the default metrics associated with a receiver, we can validate that this results in a breaking change called out in a changelog message.

Describe the solution you'd like

Add to the generated files created by mdatagen the hash of the default metrics, as a base64 encoded string.
Add a warning above the hash explaining that the hash is here to explicitly need to be changed when a change to default metrics is made, and that this qualifies the component to report a "breaking" changelog.

Add a github action build with the following algorithm:
record the changelog type - if breaking, exit early
runs git diff, greps for any occurrence of the hash change.
if any change found, check that the changelog type is "breaking".
If not exit 1.

Describe alternatives you've considered

No response

Additional context

No response

@atoulme atoulme added the enhancement New feature or request label Jun 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2023

Pinging code owners:

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

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

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:

  • cmd/mdatagen: @dmitryax
  • needs: Github issue template generation code needs this to generate the corresponding labels.

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

@crobert-1
Copy link
Member

Removing needs triage as it makes sense to me and I think it's a good idea.

To add justification, backends often charge users based on how many metrics are being ingested. New metrics being sent to backends result in billing changes. From this, I believe customer impact is high enough to warrant the breaking change label.

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 Dec 11, 2023
@crobert-1 crobert-1 removed the Stale label Dec 11, 2023
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 Feb 12, 2024
@crobert-1 crobert-1 removed the Stale label Feb 26, 2024
@crobert-1
Copy link
Member

@atoulme Since mdatagen is moving to core, should this issue be moved there as well?

@atoulme
Copy link
Contributor Author

atoulme commented Feb 26, 2024

yes please

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.

@github-actions github-actions bot added the Stale label Apr 29, 2024
@crobert-1 crobert-1 removed the Stale label Apr 29, 2024
Copy link
Contributor

github-actions bot commented Jul 1, 2024

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.

@github-actions github-actions bot added the Stale label Jul 1, 2024
@crobert-1 crobert-1 removed the Stale label Jul 1, 2024
@codeboten codeboten transferred this issue from open-telemetry/opentelemetry-collector-contrib Aug 16, 2024
@codeboten
Copy link
Contributor

transferred issue as mdatagen lives in the core repo now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd/mdatagen enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants