Fix tracer ignoring value for service tag (service name) in DD_TAGS #1543
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
No behavior changes yet.
As documented in <https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#environment-and-tags>: > If `DD_ENV`, `DD_SERVICE` or `DD_VERSION` are NOT set, tags defined in > `DD_TAGS` will be used to populate `env`/`service`/`version` respectively. Unfortunately, the previous implementation was missing a weird corner case: the `service`/`env`/`version` in the settings object were only set as a side-effect of trying to access or write to the tags option. This meant that in a situation where `service`/`env`/`version` were defined in `DD_TAGS` only AND those values were accessed BEFORE `tags`, the accessing code would not see the correct values (it would still see them as nil). In particular, this happened during tracer initialization inside `Components#build_tracer`, and meant that rather than using the service name defined in `DD_TAGS`, the fallback default from `Tracer#default_service` would be used instead. I'm not very happy with the fix (hence it's more of a workaround), see the huge comment I left on the code for more details on why I'm not happy and why it works.
|
Does this impact any resolution priority that should be given to DD_ENV,DD_SERVICE,DD_VERSION like we mention here? https://github.com/DataDog/dd-trace-rb/blob/b05fddf41ac844152b00cf834ea0e76e3fb86e9a/docs/GettingStarted.md#environment-and-tags |
marcotc
approved these changes
Jun 4, 2021
|
@ericmustin it now respects correctly what's documented in the |
Yeap, what Marco said: up until now, the docs weren't actually being respected for setting the service name from |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As documented in https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#environment-and-tags:
Unfortunately, the previous implementation was missing a weird corner case: the
service/env/versionin the settings object were only set as a side-effect of trying to access or write to thetagsoption.This meant that in a situation where
service/env/versionwere defined inDD_TAGSonly AND those values were accessed BEFORE callingtags, the accessing code would not see the correct values (it would still see them asnil).In particular, this happened during tracer initialization inside
Components#build_tracer, and meant that rather than using the service name defined inDD_TAGS, the fallback default fromTracer#default_servicewould be used instead.I'm not very happy with the fix (hence it's more of a workaround), see the huge comment I left on the code for more details on why I'm not happy and why it works.