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

[processor/resourcedetection] Fix heroku config interface #24355

Merged
merged 1 commit into from
Jul 17, 2023

Conversation

dmitryax
Copy link
Member

@dmitryax dmitryax commented Jul 17, 2023

Fix Heroku config option for the service.name and service.version attributes. service.name and service.version attributes were mistakenly controlled by heroku.app.name and heroku.release.version options under resource_attributes configuration introduced in #23253. This PR fixes the issue by using the correct config options named the same as the attributes.

@dmitryax dmitryax requested review from a team and atoulme as code owners July 17, 2023 19:27
@github-actions github-actions bot added the processor/resourcedetection Resource detection processor label Jul 17, 2023
@dmitryax dmitryax changed the title [processor/resourcerdetection] Fix heroku config interface [processor/resourcedetection] Fix heroku config interface Jul 17, 2023
Copy link
Member

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

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

Is this technically a breaking change?

@dmitryax
Copy link
Member Author

Is this technically a breaking change?

Technically yes, but it's more like a bug fix of a wrong configuration option introduced in the latest version. Not sure if we have strict guidelines for such case

@@ -5,8 +5,6 @@ all_set:
enabled: true
heroku.app.id:
enabled: true
heroku.app.name:
Copy link
Contributor

Choose a reason for hiding this comment

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

I know this was broken behavior, but would it make sense to transition out this option since removing it is a breaking change?

Copy link
Member Author

@dmitryax dmitryax Jul 17, 2023

Choose a reason for hiding this comment

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

Like keeping it as no-op with a warning for a couple of versions? It'll be just a few manual changes to support that. Resource attributes don't yet have this if_enabled_set stuff. I was actually working towards adding that when I found this issue. I don't believe anyone applied this since it was introduced only last version. If you and @TylerHelmuth think that it's worth the effort, I can apply the suggestion.

Copy link
Contributor

Choose a reason for hiding this comment

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

If it was only applied in the last release, you're right that it's unlikely to be used, so I'm okay breaking it. The closest thing I can find that would document what we should do here is the stability guarantees for scraping receivers, which only says we SHOULD follow the transition process for beta components.

Copy link
Contributor

@atoulme atoulme left a comment

Choose a reason for hiding this comment

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

Thank you for the fix!

@atoulme
Copy link
Contributor

atoulme commented Jul 17, 2023

I appreciate the fix, happy to follow up if we release it in stages

Fix config option for `service.name` attribute set by heroku detector. It was added under mismatching `heroku.app.name` config option
@dmitryax dmitryax merged commit 529c41b into open-telemetry:main Jul 17, 2023
82 checks passed
@github-actions github-actions bot added this to the next release milestone Jul 17, 2023
@dmitryax dmitryax deleted the fix-heroku-attribute branch July 18, 2023 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
processor/resourcedetection Resource detection processor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants