This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 019445a1d078 CAMEL-23712: Add traceCustomIdOnly option to only trace
processors with custom IDs (#23862)
019445a1d078 is described below
commit 019445a1d078448cdb9276d5c52f64b9b723f02b
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Jun 9 15:41:16 2026 +0200
CAMEL-23712: Add traceCustomIdOnly option to only trace processors with
custom IDs (#23862)
* CAMEL-23712: Add traceCustomIdOnly option to only trace processors with
custom IDs
Co-Authored-By: Claude Opus 4.6 <[email protected]>
Signed-off-by: Claus Ibsen <[email protected]>
* CAMEL-23712: Fix camel-telemetry-dev tests for reduced endpoint-sending
spans
Update EnableProcessorsTest and SpanBeanTest to account for the
CAMEL-23709 change where SendProcessor (EndpointSending) no longer
produces redundant EVENT_PROCESS processor spans.
Co-Authored-By: Claude <[email protected]>
Signed-off-by: Claus Ibsen <[email protected]>
* CAMEL-23712: Extend traceCustomIdOnly to filter at the route level
Routes without an explicit .routeId() are now excluded entirely from
tracing when traceCustomIdOnly=true — no route span, no processor
spans, and no endpoint send spans are created within them.
Co-Authored-By: Claude <[email protected]>
Signed-off-by: Claus Ibsen <[email protected]>
---------
Signed-off-by: Claus Ibsen <[email protected]>
Co-authored-by: Claude Opus 4.6 <[email protected]>
---
.../MicrometerObservabilityTracerConfigurer.java | 6 +
.../OpenTelemetryTracerConfigurer.java | 6 +
.../src/main/docs/opentelemetry2.adoc | 1 +
.../telemetrydev/TelemetryDevTracerConfigurer.java | 6 +
.../camel/telemetrydev/EnableProcessorsTest.java | 7 +-
.../apache/camel/telemetrydev/SpanBeanTest.java | 12 +-
.../camel-telemetry/src/main/docs/telemetry.adoc | 1 +
.../TraceProcessorsInterceptStrategy.java | 10 ++
.../java/org/apache/camel/telemetry/Tracer.java | 33 +++++
.../camel/telemetry/TraceCustomIdOnlyTest.java | 141 +++++++++++++++++++++
.../src/main/java/org/apache/camel/NamedNode.java | 9 ++
.../ROOT/pages/camel-4x-upgrade-guide-4_21.adoc | 11 ++
12 files changed, 229 insertions(+), 14 deletions(-)
diff --git
a/components/camel-micrometer-observability/src/generated/java/org/apache/camel/micrometer/observability/MicrometerObservabilityTracerConfigurer.java
b/components/camel-micrometer-observability/src/generated/java/org/apache/camel/micrometer/observability/MicrometerObservabilityTracerConfigurer.java
index 24459132c651..aa5b235acc4c 100644
---
a/components/camel-micrometer-observability/src/generated/java/org/apache/camel/micrometer/observability/MicrometerObservabilityTracerConfigurer.java
+++
b/components/camel-micrometer-observability/src/generated/java/org/apache/camel/micrometer/observability/MicrometerObservabilityTracerConfigurer.java
@@ -36,6 +36,8 @@ public class MicrometerObservabilityTracerConfigurer extends
org.apache.camel.su
case "propagator": target.setPropagator(property(camelContext,
io.micrometer.tracing.propagation.Propagator.class, value)); return true;
case "spanlifecyclemanager":
case "spanLifecycleManager":
target.setSpanLifecycleManager(property(camelContext,
org.apache.camel.telemetry.SpanLifecycleManager.class, value)); return true;
+ case "tracecustomidonly":
+ case "traceCustomIdOnly":
target.setTraceCustomIdOnly(property(camelContext, boolean.class, value));
return true;
case "traceheadersinclusion":
case "traceHeadersInclusion":
target.setTraceHeadersInclusion(property(camelContext, boolean.class, value));
return true;
case "traceprocessors":
@@ -61,6 +63,8 @@ public class MicrometerObservabilityTracerConfigurer extends
org.apache.camel.su
case "propagator": return
io.micrometer.tracing.propagation.Propagator.class;
case "spanlifecyclemanager":
case "spanLifecycleManager": return
org.apache.camel.telemetry.SpanLifecycleManager.class;
+ case "tracecustomidonly":
+ case "traceCustomIdOnly": return boolean.class;
case "traceheadersinclusion":
case "traceHeadersInclusion": return boolean.class;
case "traceprocessors":
@@ -87,6 +91,8 @@ public class MicrometerObservabilityTracerConfigurer extends
org.apache.camel.su
case "propagator": return target.getPropagator();
case "spanlifecyclemanager":
case "spanLifecycleManager": return target.getSpanLifecycleManager();
+ case "tracecustomidonly":
+ case "traceCustomIdOnly": return target.isTraceCustomIdOnly();
case "traceheadersinclusion":
case "traceHeadersInclusion": return target.isTraceHeadersInclusion();
case "traceprocessors":
diff --git
a/components/camel-opentelemetry2/src/generated/java/org/apache/camel/opentelemetry2/OpenTelemetryTracerConfigurer.java
b/components/camel-opentelemetry2/src/generated/java/org/apache/camel/opentelemetry2/OpenTelemetryTracerConfigurer.java
index fddc7e80639a..d95fcc3ab8a5 100644
---
a/components/camel-opentelemetry2/src/generated/java/org/apache/camel/opentelemetry2/OpenTelemetryTracerConfigurer.java
+++
b/components/camel-opentelemetry2/src/generated/java/org/apache/camel/opentelemetry2/OpenTelemetryTracerConfigurer.java
@@ -35,6 +35,8 @@ public class OpenTelemetryTracerConfigurer extends
org.apache.camel.support.comp
case "includePatterns":
target.setIncludePatterns(property(camelContext, java.lang.String.class,
value)); return true;
case "spanlifecyclemanager":
case "spanLifecycleManager":
target.setSpanLifecycleManager(property(camelContext,
org.apache.camel.telemetry.SpanLifecycleManager.class, value)); return true;
+ case "tracecustomidonly":
+ case "traceCustomIdOnly":
target.setTraceCustomIdOnly(property(camelContext, boolean.class, value));
return true;
case "traceheadersinclusion":
case "traceHeadersInclusion":
target.setTraceHeadersInclusion(property(camelContext, boolean.class, value));
return true;
case "traceprocessors":
@@ -58,6 +60,8 @@ public class OpenTelemetryTracerConfigurer extends
org.apache.camel.support.comp
case "includePatterns": return java.lang.String.class;
case "spanlifecyclemanager":
case "spanLifecycleManager": return
org.apache.camel.telemetry.SpanLifecycleManager.class;
+ case "tracecustomidonly":
+ case "traceCustomIdOnly": return boolean.class;
case "traceheadersinclusion":
case "traceHeadersInclusion": return boolean.class;
case "traceprocessors":
@@ -82,6 +86,8 @@ public class OpenTelemetryTracerConfigurer extends
org.apache.camel.support.comp
case "includePatterns": return target.getIncludePatterns();
case "spanlifecyclemanager":
case "spanLifecycleManager": return target.getSpanLifecycleManager();
+ case "tracecustomidonly":
+ case "traceCustomIdOnly": return target.isTraceCustomIdOnly();
case "traceheadersinclusion":
case "traceHeadersInclusion": return target.isTraceHeadersInclusion();
case "traceprocessors":
diff --git a/components/camel-opentelemetry2/src/main/docs/opentelemetry2.adoc
b/components/camel-opentelemetry2/src/main/docs/opentelemetry2.adoc
index f87baf46f3b6..16687556b4ce 100644
--- a/components/camel-opentelemetry2/src/main/docs/opentelemetry2.adoc
+++ b/components/camel-opentelemetry2/src/main/docs/opentelemetry2.adoc
@@ -27,6 +27,7 @@ The configuration properties for the OpenTelemetry2 tracer
are:
|`enabled`| false | Turn the tracing on/off.
|`traceProcessors`| false | Trace inner custom processors (i.e., any `process`
configured in the route). When disabled, custom processors are not visible from
the OpenTelemetry perspective and have no active span or context.
|`disableCoreProcessors`| false | Disable any inner core processors (any core
DSL processor provided in the route, for example `bean`, `log`, ...).
+|`traceCustomIdOnly`| false | When enabled, only trace routes and processors
where the author explicitly assigned a custom ID. Routes without a custom
`.routeId()` are excluded entirely — no route span, no processor spans, and no
endpoint send spans are created within them. Within traced routes, only
processors with a custom `.id()` produce spans (requires
`traceProcessors=true`). This provides intent-based filtering: name the routes
and steps you care about, and only those appear in you [...]
| `excludePatterns` | | A comma-separated list of patterns (e.g.,
`log*,direct*,setBody*`) to exclude from tracing. Spans matching these patterns
will be disabled. If nothing is specified, no processors are excluded by
default.
| `includePatterns` | | A comma-separated list of patterns (e.g.,
`log*,direct*,setBody*`) to explicitly include in a trace. Spans matching these
patterns will be enabled. If nothing is specified, all processors are included
by default.
| `traceHeadersInclusion`| `false` | If set to `true`, adds the generated
telemetry `CAMEL_TRACE_ID` and `CAMEL_SPAN_ID` Exchange headers.
diff --git
a/components/camel-telemetry-dev/src/generated/java/org/apache/camel/telemetrydev/TelemetryDevTracerConfigurer.java
b/components/camel-telemetry-dev/src/generated/java/org/apache/camel/telemetrydev/TelemetryDevTracerConfigurer.java
index 47fb2d5a9040..da78a684e0e8 100644
---
a/components/camel-telemetry-dev/src/generated/java/org/apache/camel/telemetrydev/TelemetryDevTracerConfigurer.java
+++
b/components/camel-telemetry-dev/src/generated/java/org/apache/camel/telemetrydev/TelemetryDevTracerConfigurer.java
@@ -33,6 +33,8 @@ public class TelemetryDevTracerConfigurer extends
org.apache.camel.support.compo
case "includePatterns":
target.setIncludePatterns(property(camelContext, java.lang.String.class,
value)); return true;
case "spanlifecyclemanager":
case "spanLifecycleManager":
target.setSpanLifecycleManager(property(camelContext,
org.apache.camel.telemetry.SpanLifecycleManager.class, value)); return true;
+ case "tracecustomidonly":
+ case "traceCustomIdOnly":
target.setTraceCustomIdOnly(property(camelContext, boolean.class, value));
return true;
case "traceformat":
case "traceFormat": target.setTraceFormat(property(camelContext,
java.lang.String.class, value)); return true;
case "traceheadersinclusion":
@@ -56,6 +58,8 @@ public class TelemetryDevTracerConfigurer extends
org.apache.camel.support.compo
case "includePatterns": return java.lang.String.class;
case "spanlifecyclemanager":
case "spanLifecycleManager": return
org.apache.camel.telemetry.SpanLifecycleManager.class;
+ case "tracecustomidonly":
+ case "traceCustomIdOnly": return boolean.class;
case "traceformat":
case "traceFormat": return java.lang.String.class;
case "traceheadersinclusion":
@@ -80,6 +84,8 @@ public class TelemetryDevTracerConfigurer extends
org.apache.camel.support.compo
case "includePatterns": return target.getIncludePatterns();
case "spanlifecyclemanager":
case "spanLifecycleManager": return target.getSpanLifecycleManager();
+ case "tracecustomidonly":
+ case "traceCustomIdOnly": return target.isTraceCustomIdOnly();
case "traceformat":
case "traceFormat": return target.getTraceFormat();
case "traceheadersinclusion":
diff --git
a/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/EnableProcessorsTest.java
b/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/EnableProcessorsTest.java
index 9c0a4b922631..2c86f142eba4 100644
---
a/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/EnableProcessorsTest.java
+++
b/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/EnableProcessorsTest.java
@@ -55,14 +55,14 @@ public class EnableProcessorsTest extends
TelemetryDevTracerTestSupport {
private void checkTrace(DevTrace trace) {
List<DevSpanAdapter> spans = trace.getSpans();
- assertEquals(6, spans.size());
+ // to("log:info") no longer produces a processor span (SendProcessor
implements EndpointSending)
+ assertEquals(5, spans.size());
DevSpanAdapter testProducer = spans.get(0);
DevSpanAdapter direct = spans.get(1);
DevSpanAdapter innerLog = spans.get(2);
DevSpanAdapter innerProcessor = spans.get(3);
DevSpanAdapter log = spans.get(4);
- DevSpanAdapter innerToLog = spans.get(5);
// Validate span completion
assertEquals("true", testProducer.getTag("isDone"));
@@ -70,14 +70,12 @@ public class EnableProcessorsTest extends
TelemetryDevTracerTestSupport {
assertEquals("true", innerLog.getTag("isDone"));
assertEquals("true", innerProcessor.getTag("isDone"));
assertEquals("true", log.getTag("isDone"));
- assertEquals("true", innerToLog.getTag("isDone"));
// Validate same trace
assertEquals(testProducer.getTag("traceid"), direct.getTag("traceid"));
assertEquals(testProducer.getTag("traceid"),
innerLog.getTag("traceid"));
assertEquals(testProducer.getTag("traceid"),
innerProcessor.getTag("traceid"));
assertEquals(testProducer.getTag("traceid"), log.getTag("traceid"));
- assertEquals(testProducer.getTag("traceid"),
innerToLog.getTag("traceid"));
// Validate op
assertEquals(Op.EVENT_RECEIVED.toString(), direct.getTag("op"));
@@ -89,7 +87,6 @@ public class EnableProcessorsTest extends
TelemetryDevTracerTestSupport {
assertEquals(direct.getTag("spanid"), innerLog.getTag("parentSpan"));
assertEquals(direct.getTag("spanid"),
innerProcessor.getTag("parentSpan"));
assertEquals(direct.getTag("spanid"), log.getTag("parentSpan"));
- assertEquals(log.getTag("spanid"), innerToLog.getTag("parentSpan"));
}
@Override
diff --git
a/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/SpanBeanTest.java
b/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/SpanBeanTest.java
index b0f02f990bda..c530ec1d5eb3 100644
---
a/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/SpanBeanTest.java
+++
b/components/camel-telemetry-dev/src/test/java/org/apache/camel/telemetrydev/SpanBeanTest.java
@@ -60,14 +60,14 @@ public class SpanBeanTest extends
TelemetryDevTracerTestSupport {
private void checkTrace(DevTrace trace, String expectedBody) {
List<DevSpanAdapter> spans = trace.getSpans();
- assertEquals(7, spans.size());
+ // to("log:info") no longer produces a processor span (SendProcessor
implements EndpointSending)
+ assertEquals(6, spans.size());
DevSpanAdapter testProducer = spans.get(0);
DevSpanAdapter direct = spans.get(1);
DevSpanAdapter logProcessor = spans.get(2);
DevSpanAdapter beanProcessor = spans.get(3);
DevSpanAdapter beanMySpan = spans.get(4);
DevSpanAdapter to = spans.get(5);
- DevSpanAdapter toProcessor = spans.get(6);
// Validate span completion
assertEquals("true", testProducer.getTag("isDone"));
@@ -76,15 +76,13 @@ public class SpanBeanTest extends
TelemetryDevTracerTestSupport {
assertEquals("true", beanProcessor.getTag("isDone"));
assertEquals("true", beanMySpan.getTag("isDone"));
assertEquals("true", to.getTag("isDone"));
- assertEquals("true", toProcessor.getTag("isDone"));
// Validate same trace
assertEquals(testProducer.getTag("traceid"), direct.getTag("traceid"));
- assertEquals(direct.getTag("traceid"), to.getTag("traceid"));
assertEquals(testProducer.getTag("traceid"),
logProcessor.getTag("traceid"));
- assertEquals(testProducer.getTag("traceid"),
toProcessor.getTag("traceid"));
assertEquals(testProducer.getTag("traceid"),
beanProcessor.getTag("traceid"));
assertEquals(testProducer.getTag("traceid"),
beanMySpan.getTag("traceid"));
+ assertEquals(testProducer.getTag("traceid"), to.getTag("traceid"));
// Validate hierarchy
assertNull(testProducer.getTag("parentSpan"));
@@ -93,7 +91,6 @@ public class SpanBeanTest extends
TelemetryDevTracerTestSupport {
assertEquals(direct.getTag("spanid"),
beanProcessor.getTag("parentSpan"));
assertEquals(beanProcessor.getTag("spanid"),
beanMySpan.getTag("parentSpan"));
assertEquals(direct.getTag("spanid"), to.getTag("parentSpan"));
- assertEquals(to.getTag("spanid"), toProcessor.getTag("parentSpan"));
// Validate operations
assertEquals(Op.EVENT_SENT.toString(), testProducer.getTag("op"));
@@ -101,9 +98,6 @@ public class SpanBeanTest extends
TelemetryDevTracerTestSupport {
// Validate message logging
assertEquals("A message",
logProcessor.getLogEntries().get(0).getFields().get("message"));
- assertEquals(
- "Exchange[ExchangePattern: InOut, BodyType: null, Body: [Body
is null]]",
- toProcessor.getLogEntries().get(0).getFields().get("message"));
}
diff --git a/components/camel-telemetry/src/main/docs/telemetry.adoc
b/components/camel-telemetry/src/main/docs/telemetry.adoc
index 72c3c8a43231..a2208448e630 100644
--- a/components/camel-telemetry/src/main/docs/telemetry.adoc
+++ b/components/camel-telemetry/src/main/docs/telemetry.adoc
@@ -28,6 +28,7 @@ The configuration properties for the Telemetry component are:
|Option |Default |Description
|`traceProcessors`| false | Trace inner custom processors (i.e., any `process`
configured in the route).
|`disableCoreProcessors`| false | Disable any inner core processors (any core
DSL processor provided in the route, for example `bean`, `log`, ...).
+|`traceCustomIdOnly`| false | When enabled, only trace routes and processors
where the author explicitly assigned a custom ID. Routes without a custom
`.routeId()` are excluded entirely — no route span, no processor spans, and no
endpoint send spans are created within them. Within traced routes, only
processors with a custom `.id()` produce spans (requires
`traceProcessors=true`). This provides intent-based filtering: name the routes
and steps you care about, and only those appear in you [...]
| `excludePatterns` | | A comma-separated list of patterns (e.g.,
`log*,direct*,setBody*`) to exclude from tracing. Spans matching these patterns
will be disabled. If nothing is specified, no processors are excluded by
default.
| `includePatterns` | | A comma-separated list of patterns (e.g.,
`log*,direct*,setBody*`) to explicitly include in a trace. Spans matching these
patterns will be enabled. If nothing is specified, all processors are included
by default.
|`traceHeadersInclusion`| false | Add the generated telemetry `CAMEL_TRACE_ID`
and `CAMEL_SPAN_ID` Exchange headers.
diff --git
a/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/TraceProcessorsInterceptStrategy.java
b/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/TraceProcessorsInterceptStrategy.java
index 2185881e7077..dc75cc4bd13c 100644
---
a/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/TraceProcessorsInterceptStrategy.java
+++
b/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/TraceProcessorsInterceptStrategy.java
@@ -111,6 +111,16 @@ public class TraceProcessorsInterceptStrategy implements
InterceptStrategy {
if (isEndpointSending(processor)) {
return false;
}
+ if (tracer.isTraceCustomIdOnly()) {
+ // skip all processors in routes without a custom routeId
+ if (!tracer.isCustomIdRoute(exchange.getFromRouteId())) {
+ return false;
+ }
+ // within custom-id routes, only trace processors with an
explicit .id()
+ if (!processorDefinition.hasCustomIdAssigned()) {
+ return false;
+ }
+ }
String shortName = processorDefinition.getShortName();
boolean enabled = isCoreProcessEnabled(shortName) ||
isCustomProcessEnabled(shortName);
return enabled && tracer.match(processorName,
exchange.getContext());
diff --git
a/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/Tracer.java
b/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/Tracer.java
index f3bf066d0bcb..40d148fd5c88 100644
---
a/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/Tracer.java
+++
b/components/camel-telemetry/src/main/java/org/apache/camel/telemetry/Tracer.java
@@ -18,6 +18,8 @@ package org.apache.camel.telemetry;
import java.util.HashMap;
import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
@@ -59,8 +61,10 @@ public abstract class Tracer extends ServiceSupport
implements CamelTracingServi
private String includePatterns;
private boolean traceProcessors;
private boolean disableCoreProcessors;
+ private boolean traceCustomIdOnly;
private boolean traceHeadersInclusion;
+ private final Set<String> customIdRoutes = ConcurrentHashMap.newKeySet();
private final TracingEventNotifier eventNotifier = new
TracingEventNotifier();
private final SpanStorageManager spanStorageManager = new
SpanStorageManagerExchange();
private final SpanDecoratorManager spanDecoratorManager = new
SpanDecoratorManagerImpl();
@@ -127,6 +131,15 @@ public abstract class Tracer extends ServiceSupport
implements CamelTracingServi
this.disableCoreProcessors = disableCoreProcessors;
}
+ @ManagedAttribute
+ public boolean isTraceCustomIdOnly() {
+ return traceCustomIdOnly;
+ }
+
+ public void setTraceCustomIdOnly(boolean traceCustomIdOnly) {
+ this.traceCustomIdOnly = traceCustomIdOnly;
+ }
+
public SpanLifecycleManager getSpanLifecycleManager() {
return this.spanLifecycleManager;
}
@@ -138,9 +151,23 @@ public abstract class Tracer extends ServiceSupport
implements CamelTracingServi
@Override
public RoutePolicy createRoutePolicy(CamelContext camelContext, String
routeId, NamedNode route) {
init(camelContext);
+ if (traceCustomIdOnly) {
+ if (route.hasCustomIdAssigned()) {
+ customIdRoutes.add(routeId);
+ } else {
+ return null;
+ }
+ }
return new TracingRoutePolicy();
}
+ boolean isCustomIdRoute(String routeId) {
+ if (routeId == null) {
+ return true;
+ }
+ return !traceCustomIdOnly || customIdRoutes.contains(routeId);
+ }
+
/**
* Registers this {@link Tracer} on the {@link CamelContext} if not
already registered.
*/
@@ -242,12 +269,18 @@ public abstract class Tracer extends ServiceSupport
implements CamelTracingServi
public void notify(CamelEvent event) throws Exception {
try {
if (event instanceof CamelEvent.ExchangeSendingEvent ese) {
+ if (!isCustomIdRoute(ese.getExchange().getFromRouteId())) {
+ return;
+ }
if (match(ese.getEndpoint().getEndpointUri(),
ese.getExchange().getContext())) {
beginEventSpan(ese.getExchange(), ese.getEndpoint(),
Op.EVENT_SENT);
} else {
LOG.debug("Tracing: endpoint {} is explicitly
excluded, skipping.", ese.getEndpoint());
}
} else if (event instanceof CamelEvent.ExchangeSentEvent ese) {
+ if (!isCustomIdRoute(ese.getExchange().getFromRouteId())) {
+ return;
+ }
if (match(ese.getEndpoint().getEndpointUri(),
ese.getExchange().getContext())) {
endEventSpan(ese.getExchange(), ese.getEndpoint());
} else {
diff --git
a/components/camel-telemetry/src/test/java/org/apache/camel/telemetry/TraceCustomIdOnlyTest.java
b/components/camel-telemetry/src/test/java/org/apache/camel/telemetry/TraceCustomIdOnlyTest.java
new file mode 100644
index 000000000000..3a50ba452bb7
--- /dev/null
+++
b/components/camel-telemetry/src/test/java/org/apache/camel/telemetry/TraceCustomIdOnlyTest.java
@@ -0,0 +1,141 @@
+/*
+ * 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.telemetry;
+
+import java.util.List;
+import java.util.Map;
+
+import org.apache.camel.CamelContext;
+import org.apache.camel.CamelContextAware;
+import org.apache.camel.Exchange;
+import org.apache.camel.Processor;
+import org.apache.camel.RoutesBuilder;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.telemetry.mock.MockSpanAdapter;
+import org.apache.camel.telemetry.mock.MockTrace;
+import org.apache.camel.telemetry.mock.MockTracer;
+import org.apache.camel.test.junit6.ExchangeTestSupport;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+public class TraceCustomIdOnlyTest extends ExchangeTestSupport {
+
+ MockTracer mockTracer;
+
+ @Override
+ protected CamelContext createCamelContext() throws Exception {
+ CamelContext context = super.createCamelContext();
+ this.mockTracer = new MockTracer();
+ mockTracer.setTraceProcessors(true);
+ mockTracer.setTraceCustomIdOnly(true);
+ CamelContextAware.trySetCamelContext(mockTracer, context);
+ mockTracer.init(context);
+ return context;
+ }
+
+ @Test
+ void testOnlyCustomIdProcessorsTraced() {
+ template.sendBody("direct:start", "my-body");
+ Map<String, MockTrace> traces = mockTracer.traces();
+ assertEquals(1, traces.size());
+ checkTrace(traces.values().iterator().next());
+ }
+
+ @Test
+ void testRouteWithoutCustomIdProducesNoSpans() {
+ template.sendBody("direct:background", "bg-body");
+ Map<String, MockTrace> traces = mockTracer.traces();
+ // The route has no custom routeId, so no route span, no processor
spans,
+ // and no endpoint send spans are created within it — even though
bgProcessor has a custom .id().
+ // Only the producer-side EVENT_SENT span from the test template is
created (sender is outside any route).
+ assertEquals(1, traces.size());
+ MockTrace trace = traces.values().iterator().next();
+ assertEquals(1, trace.spans().size());
+ MockSpanAdapter span = (MockSpanAdapter) trace.spans().get(0);
+ assertEquals(Op.EVENT_SENT.toString(), span.getTag("op"));
+ }
+
+ private void checkTrace(MockTrace trace) {
+ List<Span> spans = trace.spans();
+ // Expected spans:
+ // 1. EVENT_SENT (direct:start) — event span from sending
+ // 2. EVENT_RECEIVED (direct:start) — event span from route policy
+ // 3. EVENT_PROCESS (myProcessor) — custom .id("myProcessor") processor
+ // 4. EVENT_SENT (log:info) — event span from to("log:info")
+ // Processors WITHOUT custom id (log, setHeader) should NOT produce
spans
+ assertEquals(4, spans.size());
+
+ MockSpanAdapter testProducer = (MockSpanAdapter) spans.get(0);
+ MockSpanAdapter direct = (MockSpanAdapter) spans.get(1);
+ MockSpanAdapter customProcessor = (MockSpanAdapter) spans.get(2);
+ MockSpanAdapter log = (MockSpanAdapter) spans.get(3);
+
+ // Validate span completion
+ assertEquals("true", testProducer.getTag("isDone"));
+ assertEquals("true", direct.getTag("isDone"));
+ assertEquals("true", customProcessor.getTag("isDone"));
+ assertEquals("true", log.getTag("isDone"));
+
+ // Validate same trace
+ assertEquals(testProducer.getTag("traceid"), direct.getTag("traceid"));
+ assertEquals(testProducer.getTag("traceid"),
customProcessor.getTag("traceid"));
+ assertEquals(testProducer.getTag("traceid"), log.getTag("traceid"));
+
+ // Validate op types
+ assertEquals(Op.EVENT_RECEIVED.toString(), direct.getTag("op"));
+ assertEquals(Op.EVENT_PROCESS.toString(),
customProcessor.getTag("op"));
+
+ // Validate hierarchy
+ assertNull(testProducer.getTag("parentSpan"));
+ assertEquals(testProducer.getTag("spanid"),
direct.getTag("parentSpan"));
+ assertEquals(direct.getTag("spanid"),
customProcessor.getTag("parentSpan"));
+ }
+
+ @Override
+ protected RoutesBuilder createRouteBuilder() {
+ return new RouteBuilder() {
+ @Override
+ public void configure() {
+ from("direct:start")
+ .routeId("start")
+ .log("A message")
+ .setHeader("foo", constant("bar"))
+ .process(new Processor() {
+ @Override
+ public void process(Exchange exchange) throws
Exception {
+ exchange.getIn().setHeader("operation",
"fake");
+ }
+ }).id("myProcessor")
+ .to("log:info");
+
+ // route without custom routeId — should be entirely excluded
from tracing
+ from("direct:background")
+ .log("Background processing")
+ .process(new Processor() {
+ @Override
+ public void process(Exchange exchange) throws
Exception {
+ exchange.getIn().setHeader("bg", "done");
+ }
+ }).id("bgProcessor")
+ .to("log:background");
+ }
+ };
+ }
+
+}
diff --git a/core/camel-api/src/main/java/org/apache/camel/NamedNode.java
b/core/camel-api/src/main/java/org/apache/camel/NamedNode.java
index 2716a839829d..87578be91ca7 100644
--- a/core/camel-api/src/main/java/org/apache/camel/NamedNode.java
+++ b/core/camel-api/src/main/java/org/apache/camel/NamedNode.java
@@ -116,6 +116,15 @@ public interface NamedNode extends LineNumberAware {
return Collections.emptyList();
}
+ /**
+ * Returns whether a custom id has been assigned (vs auto-generated by
Camel).
+ *
+ * @since 4.21
+ */
+ default boolean hasCustomIdAssigned() {
+ return false;
+ }
+
/**
* Special methods for Choice EIP
*/
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
index 37048c4a06ed..20a49cc4a5b6 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
@@ -535,6 +535,17 @@ If you have custom telemetry code that relies on the
processor span existing as
endpoint span for `to`, `toD`, `wireTap`, or `enrich`, you will need to adjust
your span hierarchy
expectations.
+==== Route-level filtering with `traceCustomIdOnly`
+
+The `traceCustomIdOnly` option now also applies at the route level. Routes
without an explicit
+`.routeId()` are excluded entirely from tracing — no route span, no processor
spans, and no
+endpoint send spans are created within them. Previously, `traceCustomIdOnly`
only filtered
+individual processors within all routes.
+
+This means that if you relied on `traceCustomIdOnly=true` while leaving routes
with auto-generated
+IDs, those routes will now produce zero spans. To restore tracing for a route,
assign it an explicit
+`.routeId()`.
+
=== camel-opentelemetry2
In order to prevent a potential leak when running asynchronous components we
need to rethink the implementation details of `camel-opentelemetry2` and remove
the `Scope` wrapping that, when asynchronous, was opening the `Scope` in a
thread and closing in another (what we had called "dirty" context). We are now
removing this wrapping and moving this part exclusively in the custom Camel
`Processors`. Here Camel will take care to open the Opentelemetry scope and
close it within the same thread.
