Skip to content
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.

Sign up for GitHub

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

Fix span setStatus #6990

Merged
merged 2 commits into from
Jan 7, 2025
Merged

Fix span setStatus #6990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30a080d
Fix span setStatus
jack-berg Jan 6, 2025
5cddee5
Fix typo
jack-berg Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkSpan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,10 +434,26 @@ public ReadWriteSpan setStatus(StatusCode statusCode, @Nullable String descripti
if (!isModifiableByCurrentThread()) {
logger.log(Level.FINE, "Calling setStatus() on an ended Span.");
return this;
} else if (this.status.getStatusCode() == StatusCode.OK) {
}

// If current status is OK, ignore further attempts to change it
if (this.status.getStatusCode() == StatusCode.OK) {
logger.log(Level.FINE, "Calling setStatus() on a Span that is already set to OK.");
return this;
}

// Ignore attempts to set status to UNSET
if (statusCode == StatusCode.UNSET) {
logger.log(Level.FINE, "Ignoring call to setStatus() with status UNSET.");
return this;
}

// Ignore description when status is not ERROR
if (description != null && statusCode != StatusCode.ERROR) {
logger.log(Level.FINE, "Ignoring setStatus() description since status is not ERROR.");
description = null;
}

this.status = StatusData.create(statusCode, description);
}
return this;
Expand Down
67 changes: 59 additions & 8 deletions sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkSpanTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,16 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.Consumer;
import java.util.stream.IntStream;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.jupiter.MockitoExtension;
Expand Down Expand Up @@ -1336,15 +1341,61 @@ void onStartOnEndNotRequired() {
verify(spanProcessor, never()).onEnd(any());
}

@Test
void setStatusCannotOverrideStatusOK() {
@ParameterizedTest
@MethodSource("setStatusArgs")
void setStatus(Consumer<Span> spanConsumer, StatusData expectedSpanData) {
SdkSpan testSpan = createTestRootSpan();
testSpan.setStatus(StatusCode.OK);
assertThat(testSpan.toSpanData().getStatus().getStatusCode()).isEqualTo(StatusCode.OK);
testSpan.setStatus(StatusCode.ERROR);
assertThat(testSpan.toSpanData().getStatus().getStatusCode()).isEqualTo(StatusCode.OK);
testSpan.setStatus(StatusCode.UNSET);
assertThat(testSpan.toSpanData().getStatus().getStatusCode()).isEqualTo(StatusCode.OK);
spanConsumer.accept(testSpan);
assertThat(testSpan.toSpanData().getStatus()).isEqualTo(expectedSpanData);
}

private static Stream<Arguments> setStatusArgs() {
return Stream.of(
// Default status is UNSET
Arguments.of(spanConsumer(span -> {}), StatusData.unset()),
// Simple cases
Arguments.of(spanConsumer(span -> span.setStatus(StatusCode.OK)), StatusData.ok()),
Arguments.of(spanConsumer(span -> span.setStatus(StatusCode.ERROR)), StatusData.error()),
// UNSET is ignored
Arguments.of(
spanConsumer(span -> span.setStatus(StatusCode.OK).setStatus(StatusCode.UNSET)),
StatusData.ok()),
Arguments.of(
spanConsumer(span -> span.setStatus(StatusCode.ERROR).setStatus(StatusCode.UNSET)),
StatusData.error()),
// Description is ignored unless status is ERROR
Arguments.of(
spanConsumer(span -> span.setStatus(StatusCode.UNSET, "description")),
StatusData.unset()),
Arguments.of(
spanConsumer(span -> span.setStatus(StatusCode.OK, "description")), StatusData.ok()),
Arguments.of(
spanConsumer(span -> span.setStatus(StatusCode.ERROR, "description")),
StatusData.create(StatusCode.ERROR, "description")),
// ERROR is ignored if status is OK
Arguments.of(
spanConsumer(
span -> span.setStatus(StatusCode.OK).setStatus(StatusCode.ERROR, "description")),
StatusData.ok()),
// setStatus ignored after span is ended
Arguments.of(
spanConsumer(
span -> {
span.end();
span.setStatus(StatusCode.OK);
}),
StatusData.unset()),
Arguments.of(
spanConsumer(
span -> {
span.end();
span.setStatus(StatusCode.ERROR);
}),
StatusData.unset()));
}

private static Consumer<Span> spanConsumer(Consumer<Span> spanConsumer) {
return spanConsumer;
}

private SdkSpan createTestSpanWithAttributes(Map<AttributeKey, Object> attributes) {
Expand Down
Loading