Skip to content

Move SpanStatusExtractor.extract() before OperationListener.onEnd() in Instrumenter.doEnd() #15843

@steverao

Description

@steverao

Background

Currently, in Instrumenter.doEnd(), the execution order is:

  1. AttributesExtractor.onEnd() - sets attributes (e.g., rpc.grpc.status_code, http.response.status_code)
  2. OperationListener.onEnd() - records metrics
  3. SpanStatusExtractor.extract() - sets span status
  4. span.end()

long endNanos = getNanos(endTime);
for (int i = operationListeners.length - 1; i >= 0; i--) {
operationListeners[i].onEnd(context, attributes, endNanos);
}
}
SpanStatusBuilder spanStatusBuilder = new SpanStatusBuilderImpl(span);
spanStatusExtractor.extract(spanStatusBuilder, request, response, error);

This means when OperationListener.onEnd() is invoked, the span's status is still UNSET, even though the SpanStatusExtractor will set it to ERROR shortly after.

We want to record error count metrics based on span status.
When implementing custom OperationListener to record such metrics, developers cannot rely on span.getStatus() because it hasn't been set yet at that point.

Describe the solution you'd like

Move SpanStatusExtractor.extract() to execute before OperationListener.onEnd():

// Set span status FIRST
SpanStatusBuilder spanStatusBuilder = new SpanStatusBuilderImpl(span);
spanStatusExtractor.extract(spanStatusBuilder, request, response, error);

// THEN call OperationListener.onEnd()
long endNanos = getNanos(endTime);
for (int i = operationListeners.length - 1; i >= 0; i--) {
    operationListeners[i].onEnd(context, attributes, endNanos);
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions