Implement SDK metrics for trace #7895
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,10 @@ | ||
| Comparing source compatibility of opentelemetry-sdk-trace-1.58.0-SNAPSHOT.jar against opentelemetry-sdk-trace-1.57.0.jar | ||
| *** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder (not serializable) | ||
| === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 | ||
| +++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder setInternalTelemetryVersion(io.opentelemetry.sdk.common.InternalTelemetryVersion) | ||
| *** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.export.SimpleSpanProcessorBuilder (not serializable) | ||
| === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 | ||
| +++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.export.SimpleSpanProcessorBuilder setMeterProvider(io.opentelemetry.api.metrics.MeterProvider) | ||
| *** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.SdkTracerProviderBuilder (not serializable) | ||
| === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 | ||
| +++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.SdkTracerProviderBuilder setMeterProvider(io.opentelemetry.api.metrics.MeterProvider) |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.sdk.trace; | ||
|
|
||
| import static io.opentelemetry.api.common.AttributeKey.stringKey; | ||
|
|
||
| import io.opentelemetry.api.common.AttributeKey; | ||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.api.metrics.LongCounter; | ||
| import io.opentelemetry.api.metrics.LongUpDownCounter; | ||
| import io.opentelemetry.api.metrics.Meter; | ||
| import io.opentelemetry.api.metrics.MeterProvider; | ||
| import io.opentelemetry.api.trace.SpanContext; | ||
| import io.opentelemetry.sdk.trace.samplers.SamplingDecision; | ||
|
|
||
| /** | ||
| * SDK metrics exported for started and ended spans as defined in the <a | ||
| * href="https://opentelemetry.io/docs/specs/semconv/otel/sdk-metrics/#span-metrics">semantic | ||
| * conventions</a>. | ||
| */ | ||
| final class SdkTracerMetrics { | ||
|
|
||
| // Visible for testing | ||
| static final AttributeKey<String> OTEL_SPAN_PARENT_ORIGIN = stringKey("otel.span.parent.origin"); | ||
| // Visible for testing | ||
| static final AttributeKey<String> OTEL_SPAN_SAMPLING_RESULT = | ||
|
Contributor
There was a problem hiding this comment. You should probably move those into SemConvAttributes with the corresponding tests for up-to-date-ness. |
||
| stringKey("otel.span.sampling_result"); | ||
|
|
||
| private static final Attributes noParentDrop = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, "none", OTEL_SPAN_SAMPLING_RESULT, SamplingDecision.DROP.name()); | ||
| private static final Attributes noParentRecordOnly = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "none", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.RECORD_ONLY.name()); | ||
| private static final Attributes noParentRecordAndSample = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "none", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.RECORD_AND_SAMPLE.name()); | ||
|
|
||
| private static final Attributes remoteParentDrop = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "remote", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.DROP.name()); | ||
| private static final Attributes remoteParentRecordOnly = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "remote", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.RECORD_ONLY.name()); | ||
| private static final Attributes remoteParentRecordAndSample = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "remote", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.RECORD_AND_SAMPLE.name()); | ||
|
|
||
| private static final Attributes localParentDrop = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "local", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.DROP.name()); | ||
| private static final Attributes localParentRecordOnly = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "local", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.RECORD_ONLY.name()); | ||
| private static final Attributes localParentRecordAndSample = | ||
| Attributes.of( | ||
| OTEL_SPAN_PARENT_ORIGIN, | ||
| "local", | ||
| OTEL_SPAN_SAMPLING_RESULT, | ||
| SamplingDecision.RECORD_AND_SAMPLE.name()); | ||
|
|
||
| private static final Attributes recordOnly = | ||
| Attributes.of(OTEL_SPAN_SAMPLING_RESULT, SamplingDecision.RECORD_ONLY.name()); | ||
| private static final Attributes recordAndSample = | ||
| Attributes.of(OTEL_SPAN_SAMPLING_RESULT, SamplingDecision.RECORD_AND_SAMPLE.name()); | ||
|
|
||
| private final LongCounter startedSpans; | ||
| private final LongUpDownCounter liveSpans; | ||
|
|
||
| SdkTracerMetrics(MeterProvider meterProvider) { | ||
| Meter meter = meterProvider.get("io.opentelemetry.sdk.trace"); | ||
|
|
||
| startedSpans = | ||
| meter | ||
| .counterBuilder("otel.sdk.span.started") | ||
| .setUnit("{span}") | ||
| .setDescription("The number of created spans.") | ||
| .build(); | ||
| liveSpans = | ||
| meter | ||
| .upDownCounterBuilder("otel.sdk.span.live") | ||
| .setUnit("{span}") | ||
| .setDescription( | ||
| "The number of created spans with recording=true for which the end operation has not been called yet.") | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Records metrics for when a span starts and returns a {@link Runnable} to execute when ending | ||
| * the span. | ||
| */ | ||
| Runnable startSpan(SpanContext parentSpanContext, SamplingDecision samplingDecision) { | ||
| if (!parentSpanContext.isValid()) { | ||
| switch (samplingDecision) { | ||
| case DROP: | ||
| startedSpans.add(1, noParentDrop); | ||
| return SdkTracerMetrics::noop; | ||
| case RECORD_ONLY: | ||
| startedSpans.add(1, noParentRecordOnly); | ||
| liveSpans.add(1, recordOnly); | ||
| return this::decrementRecordOnly; | ||
| case RECORD_AND_SAMPLE: | ||
| startedSpans.add(1, noParentRecordAndSample); | ||
| liveSpans.add(1, recordAndSample); | ||
| return this::decrementRecordAndSample; | ||
| } | ||
| throw new IllegalArgumentException("Unrecognized sampling decision: " + samplingDecision); | ||
| } else if (parentSpanContext.isRemote()) { | ||
| switch (samplingDecision) { | ||
| case DROP: | ||
| startedSpans.add(1, remoteParentDrop); | ||
| return SdkTracerMetrics::noop; | ||
| case RECORD_ONLY: | ||
| startedSpans.add(1, remoteParentRecordOnly); | ||
| liveSpans.add(1, recordOnly); | ||
| return this::decrementRecordOnly; | ||
| case RECORD_AND_SAMPLE: | ||
| startedSpans.add(1, remoteParentRecordAndSample); | ||
| liveSpans.add(1, recordAndSample); | ||
| return this::decrementRecordAndSample; | ||
| } | ||
| throw new IllegalArgumentException("Unrecognized sampling decision: " + samplingDecision); | ||
| } | ||
| // local parent | ||
| switch (samplingDecision) { | ||
| case DROP: | ||
| startedSpans.add(1, localParentDrop); | ||
| return SdkTracerMetrics::noop; | ||
| case RECORD_ONLY: | ||
| startedSpans.add(1, localParentRecordOnly); | ||
| liveSpans.add(1, recordOnly); | ||
| return this::decrementRecordOnly; | ||
| case RECORD_AND_SAMPLE: | ||
| startedSpans.add(1, localParentRecordAndSample); | ||
| liveSpans.add(1, recordAndSample); | ||
| return this::decrementRecordAndSample; | ||
| } | ||
| throw new IllegalArgumentException("Unrecognized sampling decision: " + samplingDecision); | ||
| } | ||
|
|
||
| private static void noop() {} | ||
|
|
||
| private void decrementRecordOnly() { | ||
| liveSpans.add(-1, recordOnly); | ||
| } | ||
|
|
||
| private void decrementRecordAndSample() { | ||
| liveSpans.add(-1, recordAndSample); | ||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#nit For alignment with
ExporterInstrumentationThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it's possible, I'd like to suggest the
Metricsname, and maybe renaming that other one. I think instrumentation is something else, usually using interceptors or such to add telemetry in a somewhat black-box way. These are just shared state + helper methods and don't seem like instrumentation to me (admittedly a personal take).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fine. Personally, I think any code that records spans, metrics, or logs is instrumentation. With that said, for the foreseeable future, these do only record metrics so
*Metricsprobably does more intuitively capture what's going on. I'm more interested in consistency than the name.