-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #97 from appoptics/release-0.15.4
Add trace-options to span attributes
- Loading branch information
Showing
7 changed files
with
167 additions
and
68 deletions.
There are no files selected for viewing
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
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
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
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
59 changes: 59 additions & 0 deletions
59
custom/src/main/java/com/appoptics/opentelemetry/extensions/SamplingUtil.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| package com.appoptics.opentelemetry.extensions; | ||
|
|
||
| import com.tracelytics.joboe.TraceDecision; | ||
| import com.tracelytics.joboe.TraceDecisionUtil; | ||
| import com.tracelytics.joboe.XTraceOption; | ||
| import com.tracelytics.joboe.XTraceOptions; | ||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import io.opentelemetry.api.trace.TraceState; | ||
|
|
||
| public class SamplingUtil { | ||
| private SamplingUtil(){} | ||
| public static final String SW_TRACESTATE_KEY = "sw"; | ||
| public static final String SW_XTRACE_OPTIONS_RESP_KEY = "xtrace_options_response"; | ||
| public static final String SW_SPAN_PLACEHOLDER = "SWSpanIdPlaceHolder"; | ||
| public static final String SW_SPAN_PLACEHOLDER_SAMPLED = SW_SPAN_PLACEHOLDER + "-01"; | ||
| public static final String SW_SPAN_PLACEHOLDER_NOT_SAMPLED = SW_SPAN_PLACEHOLDER + "-00"; | ||
|
|
||
|
|
||
| public static boolean isValidSWTraceState(String swVal) { | ||
| if (swVal == null || !swVal.contains("-")) { | ||
| return false; | ||
| } | ||
| final String[] swTraceState = swVal.split("-"); | ||
| if (swTraceState.length != 2) { | ||
| return false; | ||
| } | ||
|
|
||
| // 16 is the hex length of the Otel trace id | ||
| return (swTraceState[0].equals(SW_SPAN_PLACEHOLDER) || swTraceState[0].length() == 16) | ||
| && (swTraceState[1].equals("00") || swTraceState[1].equals("01")); | ||
| } | ||
|
|
||
| public static boolean isSwSpanPlaceHolder(TraceState traceState){ | ||
| String swTracestate = traceState.get(SW_TRACESTATE_KEY); | ||
| return swTracestate != null && SW_SPAN_PLACEHOLDER.equals(swTracestate.split("-")[0]); | ||
| } | ||
|
|
||
| public static boolean isValidSWTraceState(TraceState traceState) { | ||
| return isValidSWTraceState(traceState.get(SW_TRACESTATE_KEY)); | ||
| } | ||
|
|
||
| public static void addXtraceOptionsToAttribute(TraceDecision traceDecision, XTraceOptions xTraceOptions, | ||
| AttributesBuilder attributesBuilder) { | ||
| if (xTraceOptions != null) { | ||
| xTraceOptions.getCustomKvs().forEach( | ||
| ((stringXTraceOption, s) -> attributesBuilder.put(stringXTraceOption.getKey(), s))); | ||
|
|
||
| if (traceDecision.getRequestType() == TraceDecisionUtil.RequestType.AUTHENTICATED_TRIGGER_TRACE || | ||
| traceDecision.getRequestType() == TraceDecisionUtil.RequestType.UNAUTHENTICATED_TRIGGER_TRACE) { | ||
| attributesBuilder.put("TriggeredTrace", true); | ||
| } | ||
|
|
||
| String swKeys = xTraceOptions.getOptionValue(XTraceOption.SW_KEYS); | ||
| if (swKeys != null) { | ||
| attributesBuilder.put("SWKeys", swKeys); | ||
| } | ||
| } | ||
| } | ||
| } |
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
64 changes: 64 additions & 0 deletions
64
custom/src/test/java/com/appoptics/opentelemetry/extensions/SamplingUtilTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| package com.appoptics.opentelemetry.extensions; | ||
|
|
||
| import com.tracelytics.joboe.TraceDecision; | ||
| import com.tracelytics.joboe.TraceDecisionUtil; | ||
| import com.tracelytics.joboe.XTraceOptions; | ||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
|
|
||
| import static io.opentelemetry.api.common.AttributeKey.booleanKey; | ||
| import static io.opentelemetry.api.common.AttributeKey.stringKey; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| class SamplingUtilTest { | ||
|
|
||
| @Mock | ||
| private TraceDecision traceDecisionMock; | ||
|
|
||
| @Test | ||
| void verifyThatTriggeredTraceAttributeIsAddedForAuthenticatedTriggerTrace() { | ||
| AttributesBuilder builder = Attributes.builder(); | ||
| XTraceOptions xTraceOptions = XTraceOptions.getXTraceOptions("trigger-trace", null); | ||
| when(traceDecisionMock.getRequestType()).thenReturn(TraceDecisionUtil.RequestType.AUTHENTICATED_TRIGGER_TRACE); | ||
|
|
||
| SamplingUtil.addXtraceOptionsToAttribute(traceDecisionMock, xTraceOptions, builder); | ||
| assertEquals(Boolean.TRUE, builder.build().get(booleanKey("TriggeredTrace"))); | ||
| } | ||
|
|
||
|
|
||
| @Test | ||
| void verifyThatTriggeredTraceAttributeIsAddedForUnauthenticatedTriggerTrace() { | ||
| AttributesBuilder builder = Attributes.builder(); | ||
| XTraceOptions xTraceOptions = XTraceOptions.getXTraceOptions("trigger-trace", null); | ||
| when(traceDecisionMock.getRequestType()).thenReturn(TraceDecisionUtil.RequestType.UNAUTHENTICATED_TRIGGER_TRACE); | ||
|
|
||
| SamplingUtil.addXtraceOptionsToAttribute(traceDecisionMock, xTraceOptions, builder); | ||
| assertEquals(Boolean.TRUE, builder.build().get(booleanKey("TriggeredTrace"))); | ||
| } | ||
|
|
||
| @Test | ||
| void verifyThatCustomKvAttributesAreAdded() { | ||
| AttributesBuilder builder = Attributes.builder(); | ||
| XTraceOptions xTraceOptions = XTraceOptions.getXTraceOptions("custom-chubi=chubby;", null); | ||
| when(traceDecisionMock.getRequestType()).thenReturn(TraceDecisionUtil.RequestType.UNAUTHENTICATED_TRIGGER_TRACE); | ||
|
|
||
| SamplingUtil.addXtraceOptionsToAttribute(traceDecisionMock, xTraceOptions, builder); | ||
| assertEquals("chubby", builder.build().get(stringKey("custom-chubi"))); | ||
| } | ||
|
|
||
| @Test | ||
| void verifyThatSwKeysAttributeIsAdded() { | ||
| AttributesBuilder builder = Attributes.builder(); | ||
| XTraceOptions xTraceOptions = XTraceOptions.getXTraceOptions("sw-keys=lo:se,check-id:123", null); | ||
| when(traceDecisionMock.getRequestType()).thenReturn(TraceDecisionUtil.RequestType.AUTHENTICATED_TRIGGER_TRACE); | ||
|
|
||
| SamplingUtil.addXtraceOptionsToAttribute(traceDecisionMock, xTraceOptions, builder); | ||
| assertEquals("lo:se,check-id:123", builder.build().get(stringKey("SWKeys"))); | ||
| } | ||
| } |