opentelemetry-collector
opentelemetry-collector copied to clipboard
open-telemetry
Validate that any change to default metrics defined in metadata.yaml are accompanied by a "breaking" changelog
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
Pinging code owners:
- cmd/mdatagen: @dmitryax
See Adding Labels via Comments if you do not have permissions to add labels yourself.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
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.
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.
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
See Adding Labels via Comments if you do not have permissions to add labels yourself.
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
See Adding Labels via Comments if you do not have permissions to add labels yourself.
@atoulme Since mdatagen is moving to core, should this issue be moved there as well?
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.
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.
