fix: Coerce aggregation_temporality value to a symbol #1741
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
The OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE env var sets the temporality as a string. However, checks throughout the metrics SDK and the OTLP exporter expect the temporality to be a symbol. Now, when aggregations that use this env var are initialized, the temporality will be coerced into a symbol.
kaylareopelle
changed the title
:aggregation_temporality to symbol
kaylareopelle
changed the title
:aggregation_temporality to symbol
kaylareopelle
requested review from
fbogsany,
mwear,
robertlaurin,
dazuma,
ericmustin,
arielvalentin,
ahayworth,
plantfansam and
robbkidd
as code owners
arielvalentin
approved these changes
Oct 7, 2024
| @@ -15,7 +15,7 @@ class Sum | |||
|
|
|||
| def initialize(aggregation_temporality: ENV.fetch('OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE', :delta)) | |||
| # TODO: the default should be :cumulative, see issue #1555 | |||
| @aggregation_temporality = aggregation_temporality | |||
| @aggregation_temporality = aggregation_temporality.to_sym | |||
There was a problem hiding this comment.
Non-Blocking Comment:
Can this be user specified or is there a constraint on the temporality preference?
I.e. should this be open ended or should it be a sort of enum object?
There was a problem hiding this comment.
Great point! I think an enum would be a good addition here.
According to the spec, the only valid values here are :delta or :cumulative. The OTLP exporter will fall back to unspecified otherwise.
We don't have support for :cumulative aggregation yet, so really, the only true option should just be :delta.
There was a problem hiding this comment.
I opened an issue to fix this as a follow-up: #1742
mwear
approved these changes
Oct 7, 2024
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.
Fetching the
OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCEenvironment variable when setting the:aggregation_temporalityon some aggregation classes (sum, explicit bucket histogram) sets the temporality as a string. However, checks throughout the metrics SDK and the OTLP exporter expect the temporality to be a symbol.This would cause applications that set the environment variable and used the OTLP exporter to have the aggregation temporality set to
Unspecified.Now, when aggregations that use this environment variable are initialized, the temporality will be coerced into a symbol.