refactor(tracing): unify event span emission methods and update tests

Author: torosent

client/src/main/java/com/microsoft/durabletask/DurableTaskGrpcClient.java

@@ -170,7 +170,7 @@ public void raiseEvent(String instanceId, String eventName, Object eventPayload)
         Helpers.throwIfArgumentNull(eventName, "eventName");
 
         // Emit an event span  StartActivityForNewEventRaisedFromClient
-        TracingHelper.emitEventRaisedFromClientSpan(eventName, instanceId);
+        TracingHelper.emitEventSpan(eventName, null, instanceId);
 
         RaiseEventRequest.Builder builder = RaiseEventRequest.newBuilder()
                 .setInstanceId(instanceId)

client/src/main/java/com/microsoft/durabletask/TaskOrchestrationExecutor.java

@@ -320,13 +320,7 @@ public <V> Task<V> callActivity(
                 TraceContext propagatedCtx = this.orchestrationSpanContext != null
                         ? this.orchestrationSpanContext : this.parentTraceContext;
                 if (propagatedCtx != null && !this.isReplaying) {
-                    TraceContext clientCtx = TracingHelper.createClientSpan(
-                            "activity:" + name,
-                            propagatedCtx,
-                            TracingHelper.TYPE_ACTIVITY,
-                            name,
-                            this.instanceId,
-                            id);
+                    TraceContext clientCtx = TracingHelper.createSyntheticClientContext(propagatedCtx);
                     if (clientCtx != null) {
                         scheduleTaskBuilder.setParentTraceContext(clientCtx);
                     }
@@ -414,7 +408,7 @@ public void sendEvent(String instanceId, String eventName, Object eventData) {
                         serializedEventData != null ? serializedEventData : "(null)"));
 
                 // Emit an event span  StartTraceActivityForEventRaisedFromWorker
-                TracingHelper.emitEventRaisedFromWorkerSpan(eventName, this.instanceId, instanceId);
+                TracingHelper.emitEventSpan(eventName, this.instanceId, instanceId);
             }
         }
 
@@ -452,22 +446,14 @@ public <V> Task<V> callSubOrchestrator(
                 createSubOrchestrationActionBuilder.setVersion(StringValue.of(this.getDefaultVersion()));
             }
 
-            // Need final copy for lambda capture
-            final String subInstanceId = instanceId;
             TaskFactory<V> taskFactory = () -> {
                 int id = this.sequenceNumber++;
 
                 // Create a Client-kind span for scheduling and propagate its context.
                 TraceContext propagatedCtx = this.orchestrationSpanContext != null
                         ? this.orchestrationSpanContext : this.parentTraceContext;
                 if (propagatedCtx != null && !this.isReplaying) {
-                    TraceContext clientCtx = TracingHelper.createClientSpan(
-                            "orchestration:" + name,
-                            propagatedCtx,
-                            TracingHelper.TYPE_ORCHESTRATION,
-                            name,
-                            subInstanceId,
-                            id);
+                    TraceContext clientCtx = TracingHelper.createSyntheticClientContext(propagatedCtx);
                     if (clientCtx != null) {
                         createSubOrchestrationActionBuilder.setParentTraceContext(clientCtx);
                     }

client/src/main/java/com/microsoft/durabletask/TracingHelper.java

@@ -311,9 +311,9 @@ static void endSpan(@Nullable Span span, @Nullable Throwable error) {
     }
 
     /**
-     * Creates a synthetic Client-kind trace context for scheduling an activity or sub-orchestration.
-     * Does NOT create or export a real span — just generates a new span ID under the parent trace.
-     * The returned context is propagated as {@code parentTraceContext} on the action so the
+     * Creates a synthetic trace context with a new span ID under the parent trace.
+     * Does NOT create or export a real span — just generates a new span ID for propagation.
+     * The returned context is set as {@code parentTraceContext} on the action so the
      * server-side span becomes a child of the synthetic client span ID.
      * At completion time, {@link #emitRetroactiveClientSpan} creates a real span with this
      * span ID (via {@link #setSpanId}) to provide proper duration and attributes.
@@ -323,13 +323,7 @@ static void endSpan(@Nullable Span span, @Nullable Throwable error) {
      *         the parent context is invalid.
      */
     @Nullable
-    static TraceContext createClientSpan(
-            String spanName,
-            @Nullable TraceContext parentContext,
-            String type,
-            String taskName,
-            @Nullable String instanceId,
-            int taskId) {
+    static TraceContext createSyntheticClientContext(@Nullable TraceContext parentContext) {
         if (parentContext == null || parentContext.getTraceParent() == null
                 || parentContext.getTraceParent().isEmpty()) {
             return null;
@@ -454,14 +448,15 @@ static void emitTimerSpan(
     }
 
     /**
-     * Emits a short-lived Producer span for an event raised from the orchestrator (worker side).
-     * Matches .NET SDK's {@code StartTraceActivityForEventRaisedFromWorker}.
+     * Emits a short-lived Producer span for an event raised from orchestrator (worker) or client.
+     * Matches .NET SDK's {@code StartTraceActivityForEventRaisedFromWorker} and
+     * {@code StartActivityForNewEventRaisedFromClient}.
      *
      * @param eventName         The name of the event being raised.
-     * @param instanceId        The orchestration instance ID sending the event.
+     * @param instanceId        The orchestration instance ID (worker-side), may be {@code null}.
      * @param targetInstanceId  The target orchestration instance ID, may be {@code null}.
      */
-    static void emitEventRaisedFromWorkerSpan(
+    static void emitEventSpan(
             String eventName,
             @Nullable String instanceId,
             @Nullable String targetInstanceId) {
@@ -479,32 +474,6 @@ static void emitEventRaisedFromWorkerSpan(
             spanBuilder.setAttribute(ATTR_EVENT_TARGET_INSTANCE_ID, targetInstanceId);
         }
 
-        Span span = spanBuilder.startSpan();
-        span.end();
-    }
-
-    /**
-     * Emits a short-lived Producer span for an event raised from the client.
-     * Matches .NET SDK's {@code StartActivityForNewEventRaisedFromClient}.
-     *
-     * @param eventName         The name of the event being raised.
-     * @param targetInstanceId  The target orchestration instance ID.
-     */
-    static void emitEventRaisedFromClientSpan(
-            String eventName,
-            @Nullable String targetInstanceId) {
-        Tracer tracer = GlobalOpenTelemetry.getTracer(TRACER_NAME);
-        SpanBuilder spanBuilder = tracer.spanBuilder(
-                TYPE_ORCHESTRATION_EVENT + ":" + eventName)
-                .setSpanKind(SpanKind.PRODUCER)
-                .setAttribute(ATTR_TYPE, TYPE_EVENT)
-                .setAttribute(ATTR_TASK_NAME, eventName);
-
-        if (targetInstanceId != null) {
-            spanBuilder.setAttribute(ATTR_EVENT_TARGET_INSTANCE_ID, targetInstanceId);
-        }
-
-        Span span = spanBuilder.startSpan();
-        span.end();
+        spanBuilder.startSpan().end();
     }
 }

client/src/test/java/com/microsoft/durabletask/TracingHelperTest.java

@@ -332,8 +332,8 @@ void extractSpanIdFromTraceparent_null_returnsNull() {
     }
 
     @Test
-    void emitEventRaisedFromWorkerSpan_createsProducerSpan() {
-        TracingHelper.emitEventRaisedFromWorkerSpan("ApprovalEvent", "orch-1", "target-orch-2");
+    void emitEventSpan_fromWorker_createsProducerSpan() {
+        TracingHelper.emitEventSpan("ApprovalEvent", "orch-1", "target-orch-2");
 
         List<SpanData> spans = spanExporter.getFinishedSpanItems();
         assertEquals(1, spans.size());
@@ -347,8 +347,8 @@ void emitEventRaisedFromWorkerSpan_createsProducerSpan() {
     }
 
     @Test
-    void emitEventRaisedFromClientSpan_createsProducerSpan() {
-        TracingHelper.emitEventRaisedFromClientSpan("ApprovalEvent", "target-orch-1");
+    void emitEventSpan_fromClient_createsProducerSpan() {
+        TracingHelper.emitEventSpan("ApprovalEvent", null, "target-orch-1");
 
         List<SpanData> spans = spanExporter.getFinishedSpanItems();
         assertEquals(1, spans.size());