Add inherited attributes preview #1854
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
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,78 @@ | ||
| /* | ||
| * ApplicationInsights-Java | ||
| * Copyright (c) Microsoft Corporation | ||
| * All rights reserved. | ||
| * | ||
| * MIT License | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this | ||
| * software and associated documentation files (the ""Software""), to deal in the Software | ||
| * without restriction, including without limitation the rights to use, copy, modify, merge, | ||
| * publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
| * persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| * The above copyright notice and this permission notice shall be included in all copies or | ||
| * substantial portions of the Software. | ||
| * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, | ||
| * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR | ||
| * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE | ||
| * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| * DEALINGS IN THE SOFTWARE. | ||
| */ | ||
|
|
||
| package com.microsoft.applicationinsights.agent.internal.init; | ||
|
|
||
| import com.microsoft.applicationinsights.agent.internal.configuration.Configuration; | ||
| import io.opentelemetry.api.common.AttributeKey; | ||
| import io.opentelemetry.api.trace.Span; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.sdk.trace.ReadWriteSpan; | ||
| import io.opentelemetry.sdk.trace.ReadableSpan; | ||
| import io.opentelemetry.sdk.trace.SpanProcessor; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class InheritedAttributesSpanProcessor implements SpanProcessor { | ||
|
|
||
| private final List<AttributeKey<?>> inheritAttributeKeys; | ||
|
|
||
| public InheritedAttributesSpanProcessor( | ||
| List<Configuration.InheritedAttribute> inheritedAttributes) { | ||
| this.inheritAttributeKeys = | ||
| inheritedAttributes.stream() | ||
| .map(Configuration.InheritedAttribute::getAttributeKey) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| @Override | ||
| @SuppressWarnings("unchecked") | ||
| public void onStart(Context parentContext, ReadWriteSpan span) { | ||
| Span parentSpan = Span.fromContextOrNull(parentContext); | ||
| if (parentSpan == null) { | ||
| return; | ||
| } | ||
| if (!(parentSpan instanceof ReadableSpan)) { | ||
| return; | ||
| } | ||
| ReadableSpan parentReadableSpan = (ReadableSpan) parentSpan; | ||
|
|
||
| for (AttributeKey<?> inheritAttributeKey : inheritAttributeKeys) { | ||
| Object value = TempGetAttribute.getAttribute(parentReadableSpan, inheritAttributeKey); | ||
| if (value != null) { | ||
| span.setAttribute((AttributeKey<Object>) inheritAttributeKey, value); | ||
|
Contributor
There was a problem hiding this comment. are inheritAttributes part of the customDimensions in the payload? |
||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isStartRequired() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public void onEnd(ReadableSpan span) {} | ||
|
|
||
| @Override | ||
| public boolean isEndRequired() { | ||
| return false; | ||
| } | ||
| } | ||
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,170 @@ | ||
| /* | ||
| * ApplicationInsights-Java | ||
| * Copyright (c) Microsoft Corporation | ||
| * All rights reserved. | ||
| * | ||
| * MIT License | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this | ||
| * software and associated documentation files (the ""Software""), to deal in the Software | ||
| * without restriction, including without limitation the rights to use, copy, modify, merge, | ||
| * publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
| * persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| * The above copyright notice and this permission notice shall be included in all copies or | ||
| * substantial portions of the Software. | ||
| * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, | ||
| * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR | ||
| * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE | ||
| * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| * DEALINGS IN THE SOFTWARE. | ||
| */ | ||
|
|
||
| package com.microsoft.applicationinsights.agent.internal.init; | ||
|
|
||
| import static io.opentelemetry.api.trace.SpanKind.INTERNAL; | ||
| import static io.opentelemetry.sdk.testing.assertj.TracesAssert.assertThat; | ||
| import static org.assertj.core.api.Assertions.entry; | ||
| import static org.awaitility.Awaitility.await; | ||
|
|
||
| import com.microsoft.applicationinsights.agent.internal.configuration.Configuration; | ||
| import io.opentelemetry.api.common.AttributeKey; | ||
| import io.opentelemetry.api.trace.Span; | ||
| import io.opentelemetry.api.trace.Tracer; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.sdk.OpenTelemetrySdk; | ||
| import io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions; | ||
| import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter; | ||
| import io.opentelemetry.sdk.trace.SdkTracerProvider; | ||
| import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class InheritedAttributesSpanProcessorTest { | ||
|
|
||
| private final InMemorySpanExporter exporter = InMemorySpanExporter.create(); | ||
|
|
||
| private final AttributeKey<String> oneStringKey = AttributeKey.stringKey("one"); | ||
| private final AttributeKey<Long> oneLongKey = AttributeKey.longKey("one"); | ||
|
|
||
| @AfterEach | ||
| public void afterEach() { | ||
| exporter.reset(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotInheritAttribute() { | ||
| Tracer tracer = newTracer(Collections.emptyList()); | ||
| Span span = | ||
| tracer.spanBuilder("parent").setNoParent().setAttribute(oneStringKey, "1").startSpan(); | ||
| Context context = Context.root().with(span); | ||
| try { | ||
| tracer.spanBuilder("child").setParent(context).startSpan().end(); | ||
| } finally { | ||
| span.end(); | ||
| } | ||
|
|
||
| await().until(() -> exporter.getFinishedSpanItems().size() == 2); | ||
|
|
||
| assertThat(Collections.singleton(exporter.getFinishedSpanItems())) | ||
| .hasTracesSatisfyingExactly( | ||
| trace -> | ||
| trace.hasSpansSatisfyingExactly( | ||
| childSpan -> | ||
| childSpan.hasName("child").hasKind(INTERNAL).hasTotalAttributeCount(0), | ||
| parentSpan -> | ||
| parentSpan | ||
| .hasName("parent") | ||
| .hasKind(INTERNAL) | ||
| .hasAttributesSatisfying( | ||
| attributes -> | ||
| OpenTelemetryAssertions.assertThat(attributes) | ||
| .containsOnly(entry(oneStringKey, "1"))))); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldInheritAttribute() { | ||
| Configuration.InheritedAttribute inheritedAttribute = new Configuration.InheritedAttribute(); | ||
| inheritedAttribute.key = "one"; | ||
| inheritedAttribute.type = Configuration.SpanAttributeType.STRING; | ||
|
|
||
| Tracer tracer = newTracer(Collections.singletonList(inheritedAttribute)); | ||
| Span span = | ||
| tracer.spanBuilder("parent").setNoParent().setAttribute(oneStringKey, "1").startSpan(); | ||
| Context context = Context.root().with(span); | ||
| try { | ||
| tracer.spanBuilder("child").setParent(context).startSpan().end(); | ||
| } finally { | ||
| span.end(); | ||
| } | ||
|
|
||
| await().until(() -> exporter.getFinishedSpanItems().size() == 2); | ||
|
|
||
| assertThat(Collections.singleton(exporter.getFinishedSpanItems())) | ||
| .hasTracesSatisfyingExactly( | ||
| trace -> | ||
| trace.hasSpansSatisfyingExactly( | ||
| childSpan -> | ||
| childSpan | ||
| .hasName("child") | ||
| .hasKind(INTERNAL) | ||
| .hasAttributesSatisfying( | ||
| attributes -> | ||
| OpenTelemetryAssertions.assertThat(attributes) | ||
| .containsOnly(entry(oneStringKey, "1"))), | ||
| parentSpan -> | ||
| parentSpan | ||
| .hasName("parent") | ||
| .hasKind(INTERNAL) | ||
| .hasAttributesSatisfying( | ||
| attributes -> | ||
| OpenTelemetryAssertions.assertThat(attributes) | ||
| .containsOnly(entry(oneStringKey, "1"))))); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotInheritAttributeWithSameNameButDifferentType() { | ||
| Configuration.InheritedAttribute inheritedAttribute = new Configuration.InheritedAttribute(); | ||
| inheritedAttribute.key = "one"; | ||
| inheritedAttribute.type = Configuration.SpanAttributeType.STRING; | ||
|
|
||
| Tracer tracer = newTracer(Collections.singletonList(inheritedAttribute)); | ||
| Span span = tracer.spanBuilder("parent").setNoParent().setAttribute(oneLongKey, 1L).startSpan(); | ||
| Context context = Context.root().with(span); | ||
| try { | ||
| tracer.spanBuilder("child").setParent(context).startSpan().end(); | ||
| } finally { | ||
| span.end(); | ||
| } | ||
|
|
||
| await().until(() -> exporter.getFinishedSpanItems().size() == 2); | ||
|
|
||
| assertThat(Collections.singleton(exporter.getFinishedSpanItems())) | ||
| .hasTracesSatisfyingExactly( | ||
| trace -> | ||
| trace.hasSpansSatisfyingExactly( | ||
| childSpan -> | ||
| childSpan.hasName("child").hasKind(INTERNAL).hasTotalAttributeCount(0), | ||
| parentSpan -> | ||
| parentSpan | ||
| .hasName("parent") | ||
| .hasKind(INTERNAL) | ||
| .hasAttributesSatisfying( | ||
| attributes -> | ||
| OpenTelemetryAssertions.assertThat(attributes) | ||
| .containsOnly(entry(oneLongKey, 1L))))); | ||
| } | ||
|
|
||
| private Tracer newTracer(List<Configuration.InheritedAttribute> inheritedAttributes) { | ||
| OpenTelemetrySdk sdk = | ||
| OpenTelemetrySdk.builder() | ||
| .setTracerProvider( | ||
| SdkTracerProvider.builder() | ||
| .addSpanProcessor(new InheritedAttributesSpanProcessor(inheritedAttributes)) | ||
| .addSpanProcessor(SimpleSpanProcessor.create(exporter)) | ||
| .build()) | ||
| .build(); | ||
| return sdk.getTracer("test"); | ||
| } | ||
| } |
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.
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.
i checked out #1743, the way they send extra attributes are through part C. Breeze accepts key/value pair string only. how other datatypes here will get used?
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.
they are all converted to strings, see
Exporter.getStringValue()