Add Sentry Log feature to Java SDK #4372

adinauer · 2025-05-06T10:13:17Z

📜 Description

Add API for capturing logs.

💡 Motivation and Context

Partial implementation for #4350

💚 How did you test it?

📝 Checklist

I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

Rate limit
Buffering / Batching
Options: Add options for Logs #4374
- to enable/disable
- beforeSend
- sampleRate
more attributes

sentry.sdk.name: The name of the SDK that sent the log
sentry.sdk.version: The version of the SDK that sent the log
[BACKEND SDKS ONLY] server.address: The address of the server that sent the log. Equivalent to server_name we attach to errors and transactions.

github-actions · 2025-05-06T10:13:45Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Add Sentry Log feature to Java SDK ([#4372](https://github.com/getsentry/sentry-java/pull/4372))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against 0627186

sentry/src/main/java/io/sentry/logger/LoggerApi.java

sentry/src/main/java/io/sentry/SentryLogEvents.java

sentry/src/main/java/io/sentry/logger/LoggerApi.java

sentry/src/main/java/io/sentry/SentryLogEvent.java

lcian

Left some comments, otherwise LGTM as a first implementation

adinauer · 2025-05-07T09:01:20Z

Thanks @lcian I changed the code in #4374 in order to reduce merge conflicts.

buenaflor

doing a drive by review since we also implement logs for Dart :)

buenaflor · 2025-05-07T13:55:35Z

sentry/src/main/java/io/sentry/SentryLogEvent.java

+public final class SentryLogEvent implements JsonUnknown, JsonSerializable {
+
+  private @NotNull SentryId traceId;
+  private @NotNull Double timestamp;
+
+  private @NotNull String body;
+
+  private @Nullable SentryLevel level;
+  private @Nullable Map<String, SentryLogEventAttributeValue> attributes;
+  private @Nullable Map<String, Object> unknown;


I think the optional severity_number is missing which later on is inferred by the SDK if not set, e.g

https://github.com/getsentry/sentry-javascript/blob/caa13167c5d6e35dd2a5dbc08b86f0f0f40681eb/packages/core/src/logs/constants.ts#L8

Do you mean for other SDKs using the Java SDK? That should land in unknown if Java SDK doesn't have it directly.

I can add it in a follow up PR.

There is also the severity number field that is optional. If it is not set (by the user) then the SDK will use the default values like in the link above

See here

lbloder

LGTM 👍
Left some comments to be addressed in later prs

lbloder · 2025-05-09T07:47:23Z

sentry/src/main/java/io/sentry/logger/LoggerApi.java

+      final @NotNull SpanId spanId =
+          span == null ? propagationContext.getSpanId() : span.getSpanContext().getSpanId();
+      final SentryLogEvent logEvent = new SentryLogEvent(traceId, timestampToUse, messageToUse);
+      logEvent.setLevel(level);


Also update baggage here

lbloder · 2025-05-09T08:07:23Z

sentry/src/main/java/io/sentry/logger/LoggerApi.java

+          "sentry.message.template", new SentryLogEventAttributeValue("string", message));
+      int i = 0;
+      for (Object arg : args) {
+        final @NotNull String type = getType(arg);


arg could be null

lbloder · 2025-05-09T08:42:18Z

sentry/src/main/java/io/sentry/SentryLogEvents.java

+  public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger logger)
+      throws IOException {
+    writer.beginObject();
+    writer.name("items").value(logger, items);


use JsonKeys.ITEMS here

Add Log feature to Java SDK

0627186

adinauer requested review from romtsn, stefanosiano, markushi and lcian as code owners May 6, 2025 10:13