-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Camel 23283 micrometer span scope #22410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
beskow
wants to merge
3
commits into
apache:main
Choose a base branch
from
beskow:CAMEL-23283-micrometer-span-scope
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
97 changes: 97 additions & 0 deletions
97
...-observability/src/test/java/org/apache/camel/micrometer/observability/SpanScopeTest.java
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,97 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.camel.micrometer.observability; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
|
|
||
| import io.opentelemetry.sdk.trace.data.SpanData; | ||
| import org.apache.camel.RoutesBuilder; | ||
| import org.apache.camel.builder.RouteBuilder; | ||
| import org.apache.camel.micrometer.observability.CamelOpenTelemetryExtension.OtelTrace; | ||
| import org.apache.camel.telemetry.Op; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
|
|
||
| /** | ||
| * Verifies that spans are properly put in scope during route execution. This is critical for routes triggered by | ||
| * consumers that don't have framework-level tracing (e.g., JMS), where Camel must manage the span scope itself. | ||
| * | ||
| * Without proper scope management, {@code tracer.currentSpan()} returns null during route execution, which prevents the | ||
| * trace from being exported and for downstream instrumentation from attaching to the Camel trace. | ||
| */ | ||
| public class SpanScopeTest extends MicrometerObservabilityTracerPropagationTestSupport { | ||
|
|
||
| private final AtomicReference<io.micrometer.tracing.Span> capturedCurrentSpan = new AtomicReference<>(); | ||
|
|
||
| @Test | ||
| void testSpanIsInScopeDuringRouteExecution() { | ||
| template.sendBody("direct:start", "Test Message"); | ||
|
|
||
| // The processor captured tracer.currentSpan() during route execution. | ||
| io.micrometer.tracing.Span current = capturedCurrentSpan.get(); | ||
| assertNotNull(current); | ||
| } | ||
|
|
||
| @Test | ||
| void testCapturedSpanMatchesTraceId() { | ||
| template.sendBody("direct:start", "Test Message"); | ||
|
|
||
| io.micrometer.tracing.Span current = capturedCurrentSpan.get(); | ||
| assertNotNull(current); | ||
|
|
||
| // The captured current span should belong to the same trace as the recorded spans | ||
| Map<String, OtelTrace> traces = otelExtension.getTraces(); | ||
| assertEquals(1, traces.size()); | ||
| String expectedTraceId = traces.keySet().iterator().next(); | ||
| List<SpanData> spans = traces.get(expectedTraceId).getSpans(); | ||
|
|
||
| SpanData receivedSpan = getSpan(spans, "direct://start", Op.EVENT_RECEIVED); | ||
| assertEquals(expectedTraceId, current.context().traceId()); | ||
| assertEquals(receivedSpan.getSpanId(), current.context().spanId()); | ||
| } | ||
|
|
||
| @Test | ||
| void testSpanScopeIsCleanedUpAfterRouteExecution() { | ||
| template.sendBody("direct:start", "Test Message"); | ||
|
|
||
| // After the route completes, the scope should be closed and | ||
| // tracer.currentSpan() should return null | ||
| io.micrometer.tracing.Span afterRoute = micrometerTracer.currentSpan(); | ||
| assertNull(afterRoute); | ||
| } | ||
|
|
||
| @Override | ||
| protected RoutesBuilder createRouteBuilder() { | ||
| return new RouteBuilder() { | ||
| @Override | ||
| public void configure() { | ||
| from("direct:start") | ||
| .routeId("start") | ||
| .process(exchange -> { | ||
| capturedCurrentSpan.set(micrometerTracer.currentSpan()); | ||
| }) | ||
| .to("log:info"); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| } | ||
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.
This is something you're not allowed to do by design. The point is that, for consistency reasons, Camel has to be seen as a black box and the only context propagation is via standard
traceparent(see https://github.com/apache/camel/blob/main/proposals/tracing.adoc#context-propagation)