Skip to content

Log test errors on spans #21

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

Merged
vito merged 1 commit into from
May 15, 2026
Merged

Log test errors on spans #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
56 changes: 33 additions & 23 deletions src/wrapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,20 @@ function __emitConsoleTelemetry(stream: ConsoleStream, body: string): void {
return;
}

const activeContext = context.active();
const activeSpan = trace.getSpan(activeContext);
__emittingConsoleTelemetry = true;
try {
__emitStdioTelemetry(context.active(), stream, body);
} finally {
__emittingConsoleTelemetry = false;
}
}

function __emitStdioTelemetry(logContext: Context, stream: ConsoleStream, body: string): void {
const activeSpan = trace.getSpan(logContext);
if (!activeSpan || !isSpanContextValid(activeSpan.spanContext())) {
return;
}

__emittingConsoleTelemetry = true;
try {
__logger().emit({
timestamp: Date.now(),
Expand All @@ -96,15 +103,17 @@ function __emitConsoleTelemetry(stream: ConsoleStream, body: string): void {
attributes: {
[STDIO_STREAM_ATTR]: stream === "stderr" ? STDIO_STREAM_STDERR : STDIO_STREAM_STDOUT,
},
context: activeContext,
context: logContext,
});
} catch {
// Do not let telemetry log emission affect the test run.
} finally {
__emittingConsoleTelemetry = false;
}
}

function __formatErrorForLog(error: Error): string {
return `${(error.stack || error.message || String(error)).trimEnd()}\n`;
}

// A function that take any jest environment and add otel instrumentation on existing tests.
export function wrapEnvironmentClass(BaseEnv: typeof TestEnvironment): any {
return class OtelJestEnvironment extends BaseEnv {
Expand Down Expand Up @@ -224,16 +233,18 @@ export function wrapEnvironmentClass(BaseEnv: typeof TestEnvironment): any {
if (hasErrors) {
span.setAttribute(ATTR_TEST_CASE_RESULT_STATUS, TEST_CASE_RESULT_STATUS_VALUE_FAIL);

const err = this.firstJestError(event.test.errors);
if (err) {
span.recordException(err);
span.setStatus({
code: SpanStatusCode.ERROR,
message: err.message,
});
} else {
span.setStatus({ code: SpanStatusCode.ERROR });
const testContext = trace.setSpan(context.active(), span);
for (const error of event.test.errors) {
const err = this.jestError(error);
if (err) {
span.recordException(err);
__emitStdioTelemetry(testContext, "stderr", __formatErrorForLog(err));
}
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: "test failed",
});

this.setParentAsFailed(event.test.parent);
} else {
Expand Down Expand Up @@ -497,23 +508,22 @@ export function wrapEnvironmentClass(BaseEnv: typeof TestEnvironment): any {
}

/**
* Unwrap the first Jest Error that triggered a test failure.
* Unwrap a Jest Error that triggered a test failure.
*/
firstJestError(errors: any[]): Error | null {
if (!errors || !errors.length) return null;
jestError(error: any): Error | null {
if (!error) return null;

const first = errors[0];
if (Array.isArray(first)) {
const [original, asyncErr] = first;
if (Array.isArray(error)) {
const [original, asyncErr] = error;
if (original?.stack) return original;
if (typeof original === "string") return new Error(original);

return asyncErr || new Error("Unknown Jest error");
}

if (typeof first === "string") return new Error(first);
if (typeof error === "string") return new Error(error);

return first;
return error;
}

/**
Expand Down