[Logs 1] 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: [Logs 3] 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

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

Generated by 🚫 dangerJS against 3f20c35

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

Added in #4391 but it cannot be passed in via API yet.

lbloder

LGTM 👍
Left some comments to be addressed in later prs

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

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

github-actions · 2025-05-12T14:32:52Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	401.04 ms	451.06 ms	50.02 ms
Size	1.58 MiB	2.08 MiB	508.27 KiB

Previous results on branch: feat/java-log-feature

Startup times

Revision	Plain	With Sentry	Diff
`04e25fb`	469.47 ms	528.80 ms	59.33 ms

App size

Revision	Plain	With Sentry	Diff
`04e25fb`	1.58 MiB	2.08 MiB	508.27 KiB

romtsn · 2025-05-13T09:55:40Z

CHANGELOG.md

+        - `options.getLogs().setEnabled(true)` in `Sentry.init` / `SentryAndroid.init`
+        - `logs.enabled=true` in `sentry.properties`
+        - `sentry.logs.enabled=true` in `application.properties`
+        - `sentry.logs.enabled: true` in `application.yml`


manifest or no manifest? 👀

Ah yeah we should add it to manifest as well.

Added in #4395

stefanosiano

nice!

romtsn · 2025-05-13T13:57:37Z

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

+public final class SentryLogEvent implements JsonUnknown, JsonSerializable {
+
+  private @NotNull SentryId traceId;
+  private @NotNull Double timestamp;


could've been a primitive since it's required?

romtsn · 2025-05-13T13:59:34Z

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

+  private @NotNull SentryId traceId;
+  private @NotNull Double timestamp;
+
+  private @NotNull String body;


haven't seen it in the docs, but maybe you know - do we need to do any truncation here? E.g. if there's a requirement that relay will drop logs with body longer than XXX or something

The same limit that applies to error envelopes also applies here. Not truncation needed / wanted. We probably want to implement a weight based approach in the future to only send a lower batch size in some cases.

And the limit applies to the whole batch, since it's a single envelope.

Add Log feature to Java SDK

0627186

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