squakez commented on code in PR #22653:
URL: https://github.com/apache/camel/pull/22653#discussion_r3093614839
##########
components/camel-telemetry/src/main/java/org/apache/camel/telemetry/decorators/AbstractHttpSpanDecorator.java:
##########
@@ -105,4 +106,17 @@ public void afterTracingEvent(Span span, Exchange
exchange) {
}
}
}
+
+ @Override
+ public String getSpanKind(String operationName) {
+ try {
+ return switch (Op.valueOf(operationName)) {
+ case EVENT_RECEIVED -> "SERVER";
+ case EVENT_SENT -> "CLIENT";
+ default -> "INTERNAL";
+ };
+ } catch (IllegalArgumentException | NullPointerException e) {
Review Comment:
I think it's better to refactor this code and avoid at all the possibility
to throw any exception.
##########
components/camel-telemetry/src/main/java/org/apache/camel/telemetry/Tracer.java:
##########
@@ -286,7 +287,8 @@ protected void beginProcessorSpan(Exchange exchange, String
processorName) throw
// there is some inconsistency
LOG.warn("Processor tracing parent should not be null!");
}
- Span span = spanLifecycleManager.create(processorName, parentSpan,
spanDecorator.getExtractor(exchange));
+ Span span = spanLifecycleManager.create(processorName,
spanDecorator.getSpanKind(Op.EVENT_PROCESS.toString()),
Review Comment:
ditto
##########
components/camel-opentelemetry2/src/test/java/org/apache/camel/opentelemetry2/SpanKindTest.java:
##########
@@ -0,0 +1,295 @@
+/*
+ * 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.opentelemetry2;
+
+import java.util.List;
+import java.util.Map;
+
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.sdk.trace.data.SpanData;
+import org.apache.camel.CamelContext;
+import org.apache.camel.CamelContextAware;
+import org.apache.camel.RoutesBuilder;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.component.mock.MockEndpoint;
+import org.apache.camel.opentelemetry2.CamelOpenTelemetryExtension.OtelTrace;
+import org.apache.camel.telemetry.Op;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Test that verifies SpanKind is set correctly for different component types.
+ */
+public class SpanKindTest extends OpenTelemetryTracerTestSupport {
+
+ @Override
+ protected CamelContext createCamelContext() throws Exception {
+ OpenTelemetryTracer tst = new OpenTelemetryTracer();
+
tst.setTracer(otelExtension.getOpenTelemetry().getTracer("spanKindTest"));
+
tst.setContextPropagators(otelExtension.getOpenTelemetry().getPropagators());
+ CamelContext context = super.createCamelContext();
+
+ // Register mock HTTP component for testing
+ context.addComponent("mock-http", new MockHttpComponent());
+ // Register mock Kafka component for testing
+ context.addComponent("mock-kafka", new MockKafkaComponent());
+
+ CamelContextAware.trySetCamelContext(tst, context);
+ tst.init(context);
+ return context;
+ }
+
+ @Test
+ void testDirectComponentHasInternalSpanKind() {
+ template.sendBody("direct:start", "test");
+
+ List<OtelTrace> traces =
List.copyOf(otelExtension.getTraces().values());
+ assertEquals(1, traces.size());
+
+ List<SpanData> spans = traces.get(0).getSpans();
+
+ // Find the direct:start EVENT_SENT span
+ SpanData directSentSpan = getSpan(spans, "direct://start",
Op.EVENT_SENT);
+ assertEquals(SpanKind.INTERNAL, directSentSpan.getKind(),
+ "direct:start EVENT_SENT should have INTERNAL SpanKind");
+
+ // Find the direct:start EVENT_RECEIVED span
+ SpanData directReceivedSpan = getSpan(spans, "direct://start",
Op.EVENT_RECEIVED);
+ assertEquals(SpanKind.INTERNAL, directReceivedSpan.getKind(),
+ "direct:start EVENT_RECEIVED should have INTERNAL SpanKind");
+ }
+
+ @Test
+ void testHttpComponentHasClientServerSpanKind() throws Exception {
+ MockEndpoint mockEndpoint = getMockEndpoint("mock:result");
+ mockEndpoint.expectedMessageCount(1);
+
+ template.sendBody("direct:httpClient", "test message");
+
+ mockEndpoint.assertIsSatisfied();
+
+ List<OtelTrace> traces =
List.copyOf(otelExtension.getTraces().values());
+ assertEquals(1, traces.size());
+
+ List<SpanData> spans = traces.get(0).getSpans();
+
+ // Find the mock-http EVENT_SENT span (client side)
+ SpanData httpClientSpan = getSpan(spans, "mock-http://testEndpoint";,
Op.EVENT_SENT);
+ assertEquals(SpanKind.CLIENT, httpClientSpan.getKind(),
+ "HTTP EVENT_SENT should have CLIENT SpanKind");
+ }
+
+ @Test
+ void testKafkaComponentHasProducerSpanKindAndInheritedProperties() throws
Exception {
+ MockEndpoint mockEndpoint = getMockEndpoint("mock:result");
+ mockEndpoint.expectedMessageCount(1);
+
+ // Send with Kafka headers that would normally be set before/during
sending
+ template.sendBodyAndHeaders("direct:kafkaProducer", "test message",
+ Map.of("kafka.KEY", "test-key",
+ "kafka.PARTITION", 0,
+ "kafka.OFFSET", "12345"));
+
+ mockEndpoint.assertIsSatisfied();
+
+ List<OtelTrace> traces =
List.copyOf(otelExtension.getTraces().values());
+ assertEquals(1, traces.size());
+
+ List<SpanData> spans = traces.get(0).getSpans();
+
+ // Find the mock-kafka EVENT_SENT span
+ SpanData kafkaSpan = getSpan(spans, "mock-kafka://testTopic",
Op.EVENT_SENT);
+
+ // Verify OpenTelemetry-specific SpanKind
+ assertEquals(SpanKind.PRODUCER, kafkaSpan.getKind(),
+ "Kafka EVENT_SENT should have PRODUCER SpanKind");
+
+ // Verify inherited properties from camel-telemetry KafkaSpanDecorator
+ assertEquals("0",
kafkaSpan.getAttributes().get(AttributeKey.stringKey("kafka.partition")),
+ "Should have kafka.partition tag from inherited decorator");
+ assertEquals("12345",
kafkaSpan.getAttributes().get(AttributeKey.stringKey("kafka.offset")),
+ "Should have kafka.offset tag from inherited decorator");
+ assertEquals("test-key",
kafkaSpan.getAttributes().get(AttributeKey.stringKey("kafka.key")),
+ "Should have kafka.key tag from inherited decorator");
+ }
+
+ @Override
+ protected RoutesBuilder createRouteBuilder() {
+ return new RouteBuilder() {
+ @Override
+ public void configure() {
+ from("direct:start")
+ .log("Processing message");
+
+ // Mock HTTP client route - tests CLIENT SpanKind
+ from("direct:httpClient")
+ .to("mock-http://testEndpoint";)
+ .to("mock:result");
+
+ // Mock Kafka producer route - tests PRODUCER SpanKind and
inherited properties
+ from("direct:kafkaProducer")
+ .to("mock-kafka://testTopic")
+ .to("mock:result");
+ }
+ };
+ }
+
+ // ========== Mock HTTP Component Classes ==========
+
+ /**
+ * Mock HTTP component for testing SpanKind. This component is recognized
by HttpSpanDecorator based on its class
+ * name.
+ */
+ static class MockHttpComponent extends
org.apache.camel.support.DefaultComponent {
+
+ @Override
+ protected org.apache.camel.Endpoint createEndpoint(String uri, String
remaining, Map<String, Object> parameters)
+ throws Exception {
+ MockHttpEndpoint endpoint = new MockHttpEndpoint(uri, this);
+ setProperties(endpoint, parameters);
+ return endpoint;
+ }
+ }
+
+ /**
+ * Mock HTTP endpoint for testing SpanKind.
+ */
+ static class MockHttpEndpoint extends
org.apache.camel.support.DefaultEndpoint {
Review Comment:
For a better maintainance I'd suggest to move all the Mock classes to a
separate compilation unit.
##########
components/camel-telemetry/src/main/java/org/apache/camel/telemetry/decorators/AbstractMessagingSpanDecorator.java:
##########
@@ -60,4 +61,16 @@ protected String getMessageId(Exchange exchange) {
return null;
}
+ @Override
+ public String getSpanKind(String operationName) {
+ try {
+ return switch (Op.valueOf(operationName)) {
+ case EVENT_RECEIVED -> "CONSUMER";
+ case EVENT_SENT -> "PRODUCER";
+ default -> "INTERNAL";
+ };
+ } catch (IllegalArgumentException | NullPointerException e) {
Review Comment:
Ditto
##########
components/camel-telemetry/src/main/java/org/apache/camel/telemetry/Tracer.java:
##########
@@ -270,7 +270,8 @@ protected void beginEventSpan(Exchange exchange, Endpoint
endpoint, Op op) throw
SpanDecorator spanDecorator = spanDecoratorManager.get(endpoint);
Span parentSpan = spanStorageManager.peek(exchange);
String spanName = spanDecorator.getOperationName(exchange, endpoint);
- Span span = spanLifecycleManager.create(spanName, parentSpan,
spanDecorator.getExtractor(exchange));
+ Span span = spanLifecycleManager.create(spanName,
spanDecorator.getSpanKind(op.toString()), parentSpan,
Review Comment:
Nitpick: I think it's more readable if you extract to a variable as done for
the name
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
