Skip to content

Support custom exception handling #14493

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
merged 4 commits into from
Aug 25, 2025
+42 −45
Merged

Support custom exception handling #14493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27d9902
Support custom exception handling
trask Aug 22, 2025
40c7dd3
Simplify Java agent instrumentation
trask Aug 22, 2025
09f25c5
./gradlew spotlessApply
otelbot[bot] Aug 22, 2025
f1e0ace
fix
trask Aug 22, 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
13 changes: 3 additions & 10 deletions ...t/src/main/java/io/opentelemetry/javaagent/instrumentation/jul/JavaUtilLoggingHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@
import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
import io.opentelemetry.api.logs.LogRecordBuilder;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.context.Context;
import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
import io.opentelemetry.semconv.ExceptionAttributes;
import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.concurrent.TimeUnit;
import java.util.logging.Formatter;
import java.util.logging.Level;
Expand Down Expand Up @@ -85,13 +83,8 @@ private static void mapLogRecord(LogRecordBuilder builder, LogRecord logRecord)
// throwable
Throwable throwable = logRecord.getThrown();
if (throwable != null) {
// TODO (trask) extract method for recording exception into
// io.opentelemetry:opentelemetry-api
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
// this cast is safe within java agent instrumentation
((ExtendedLogRecordBuilder) builder).setException(throwable);
}

if (captureExperimentalAttributes) {
Expand Down
13 changes: 3 additions & 10 deletions ...telemetry/javaagent/instrumentation/jbosslogmanager/appender/v1_1/LoggingEventMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
import io.opentelemetry.api.logs.LogRecordBuilder;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.internal.cache.Cache;
import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
import io.opentelemetry.semconv.ExceptionAttributes;
import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.List;
import java.util.Map;
import org.jboss.logmanager.ExtLogRecord;
Expand Down Expand Up @@ -81,13 +79,8 @@ public void capture(Logger logger, ExtLogRecord record) {

Throwable throwable = record.getThrown();
if (throwable != null) {
// TODO (trask) extract method for recording exception into
// io.opentelemetry:opentelemetry-api
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
// this cast is safe within java agent instrumentation
((ExtendedLogRecordBuilder) builder).setException(throwable);
}
captureMdcAttributes(attributes);

Expand Down
17 changes: 10 additions & 7 deletions ...n/java/io/opentelemetry/javaagent/instrumentation/log4j/appender/v1_2/LogEventMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
import io.opentelemetry.api.logs.LogRecordBuilder;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.context.Context;
Expand Down Expand Up @@ -101,13 +102,15 @@ public void capture(

// throwable
if (throwable != null) {
// TODO (trask) extract method for recording exception into
// io.opentelemetry:opentelemetry-api
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
if (builder instanceof ExtendedLogRecordBuilder) {
((ExtendedLogRecordBuilder) builder).setException(throwable);
} else {
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
}
}

captureMdcAttributes(attributes);
Expand Down
22 changes: 13 additions & 9 deletions ...n/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/internal/LogEventMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
import io.opentelemetry.api.logs.LogRecordBuilder;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.context.Context;
Expand Down Expand Up @@ -117,7 +118,7 @@ public void mapLogEvent(
}

if (throwable != null) {
setThrowable(attributes, throwable);
setThrowable(builder, attributes, throwable);
}

captureContextDataAttributes(attributes, contextData);
Expand Down Expand Up @@ -233,14 +234,17 @@ public static AttributeKey<String> getMapMessageAttributeKey(String key) {
key, k -> AttributeKey.stringKey("log4j.map_message." + k));
}

private static void setThrowable(AttributesBuilder attributes, Throwable throwable) {
// TODO (trask) extract method for recording exception into
// io.opentelemetry:opentelemetry-api
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
private static void setThrowable(
LogRecordBuilder builder, AttributesBuilder attributes, Throwable throwable) {
if (builder instanceof ExtendedLogRecordBuilder) {
((ExtendedLogRecordBuilder) builder).setException(throwable);
} else {
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
}
}

private static Severity levelToSeverity(Level level) {
Expand Down
22 changes: 13 additions & 9 deletions ...a/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
import io.opentelemetry.api.logs.LogRecordBuilder;
import io.opentelemetry.api.logs.LoggerProvider;
import io.opentelemetry.api.logs.Severity;
Expand Down Expand Up @@ -147,7 +148,7 @@ private void mapLoggingEvent(
throwable = ((ThrowableProxy) throwableProxy).getThrowable();
}
if (throwable != null) {
setThrowable(attributes, throwable);
setThrowable(builder, attributes, throwable);
}

captureMdcAttributes(attributes, loggingEvent.getMDCPropertyMap());
Expand Down Expand Up @@ -269,14 +270,17 @@ public static AttributeKey<String> getMdcAttributeKey(String key) {
return mdcAttributeKeys.computeIfAbsent(key, AttributeKey::stringKey);
}

private static void setThrowable(AttributesBuilder attributes, Throwable throwable) {
// TODO (trask) extract method for recording exception into
// io.opentelemetry:opentelemetry-api
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
private static void setThrowable(
LogRecordBuilder builder, AttributesBuilder attributes, Throwable throwable) {
if (builder instanceof ExtendedLogRecordBuilder) {
((ExtendedLogRecordBuilder) builder).setException(throwable);
} else {
attributes.put(ExceptionAttributes.EXCEPTION_TYPE, throwable.getClass().getName());
attributes.put(ExceptionAttributes.EXCEPTION_MESSAGE, throwable.getMessage());
StringWriter writer = new StringWriter();
throwable.printStackTrace(new PrintWriter(writer));
attributes.put(ExceptionAttributes.EXCEPTION_STACKTRACE, writer.toString());
}
}

private static Severity levelToSeverity(Level level) {
Expand Down