From 1a438ff2df75ed2864a7ec7dfc2f42d5b6b1996f Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Fri, 3 Oct 2025 12:42:27 -0400 Subject: [PATCH 1/5] ref(logs): Change documentation for logs `sentry.origin` consolidation --- develop-docs/sdk/telemetry/logs.mdx | 19 +++++++++++++------ .../sdk/telemetry/traces/span-operations.mdx | 1 + 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/develop-docs/sdk/telemetry/logs.mdx b/develop-docs/sdk/telemetry/logs.mdx index 68787b42352e5..acfe175281877 100644 --- a/develop-docs/sdk/telemetry/logs.mdx +++ b/develop-docs/sdk/telemetry/logs.mdx @@ -305,13 +305,20 @@ If there are no `sentry.message.parameter.X` attributes included in the log, the #### SDK Integration Attributes -If a log is generated by an SDK integration, the SDK should also set the `sentry.origin` attribute, as per the [Trace Origin](/sdk/telemetry/traces/trace-origin/) documentation. It is assumed that logs without a `sentry.origin` attribute are manually created by the user. +If a log is generated by an SDK integration, the SDK should also set the `sentry.origin` attribute, as per the [Trace Origin](/sdk/telemetry/traces/trace-origin/) documentation. -```json -{ - "sentry.origin": "auto.db.graphql" -} -``` +Logs can be generated in three ways: + +1. User calls Sentry’s Logging API directly: No `sentry.origin`. + +2. Captured from a 3rd-party logging library: Use `auto.log[...]` format. + ```json + { "sentry.origin": "auto.log.serilog" } + ``` +3. Auto-emitted logs from other instrumented systems: Use the matching trace origin category (e.g. db, http, etc.). + ```json + { "sentry.origin": "auto.db.prisma" } + ``` #### User Attributes diff --git a/develop-docs/sdk/telemetry/traces/span-operations.mdx b/develop-docs/sdk/telemetry/traces/span-operations.mdx index 37c1566ebb88d..bd401be6a0237 100644 --- a/develop-docs/sdk/telemetry/traces/span-operations.mdx +++ b/develop-docs/sdk/telemetry/traces/span-operations.mdx @@ -265,6 +265,7 @@ Messages/Queue spans are expected follow OpenTelemetry's [Messaging](https://git | graphql | | | grpc | | | http | | +| log | | | mark | | | measure | | | middleware | | From c28aa579a5ee677b242d440a2132bc3f0c9244ff Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Fri, 3 Oct 2025 12:57:40 -0400 Subject: [PATCH 2/5] clarify the part about logging libraries --- develop-docs/sdk/telemetry/logs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/telemetry/logs.mdx b/develop-docs/sdk/telemetry/logs.mdx index acfe175281877..6294716f592e0 100644 --- a/develop-docs/sdk/telemetry/logs.mdx +++ b/develop-docs/sdk/telemetry/logs.mdx @@ -311,7 +311,7 @@ Logs can be generated in three ways: 1. User calls Sentry’s Logging API directly: No `sentry.origin`. -2. Captured from a 3rd-party logging library: Use `auto.log[...]` format. +2. Captured from a logging library: Use `auto.log[...]` format. ```json { "sentry.origin": "auto.log.serilog" } ``` From 6bd747845445683b4ab2752b4057cbe1c6910542 Mon Sep 17 00:00:00 2001 From: Alex Sohn <44201357+alexsohn1126@users.noreply.github.com> Date: Fri, 3 Oct 2025 14:46:22 -0400 Subject: [PATCH 3/5] Update develop-docs/sdk/telemetry/logs.mdx Co-authored-by: Bruno Garcia --- develop-docs/sdk/telemetry/logs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/telemetry/logs.mdx b/develop-docs/sdk/telemetry/logs.mdx index 6294716f592e0..0d0f25dab5bd8 100644 --- a/develop-docs/sdk/telemetry/logs.mdx +++ b/develop-docs/sdk/telemetry/logs.mdx @@ -311,7 +311,7 @@ Logs can be generated in three ways: 1. User calls Sentry’s Logging API directly: No `sentry.origin`. -2. Captured from a logging library: Use `auto.log[...]` format. +2. Captured from a logging library: Use `auto.log.` format. where is the relevant integration. For example, the .NET Serilog library emits: ```json { "sentry.origin": "auto.log.serilog" } ``` From 82516ee587168b163983d618be74b6b8c32d8361 Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Fri, 3 Oct 2025 14:53:57 -0400 Subject: [PATCH 4/5] fix being recognized as JSX in the docs --- develop-docs/sdk/telemetry/logs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/telemetry/logs.mdx b/develop-docs/sdk/telemetry/logs.mdx index 0d0f25dab5bd8..9324c5b871937 100644 --- a/develop-docs/sdk/telemetry/logs.mdx +++ b/develop-docs/sdk/telemetry/logs.mdx @@ -311,7 +311,7 @@ Logs can be generated in three ways: 1. User calls Sentry’s Logging API directly: No `sentry.origin`. -2. Captured from a logging library: Use `auto.log.` format. where is the relevant integration. For example, the .NET Serilog library emits: +2. Captured from a logging library: Use `auto.log.` format. where `` is the relevant integration. For example, the .NET Serilog library emits: ```json { "sentry.origin": "auto.log.serilog" } ``` From e73cb13bf6cabf9b29d639e127a45dd83b1bef01 Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Tue, 7 Oct 2025 11:42:25 -0400 Subject: [PATCH 5/5] clarify reasoning for no origin on manual log creation and clarify automatically emitted logs origin --- develop-docs/sdk/telemetry/logs.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/develop-docs/sdk/telemetry/logs.mdx b/develop-docs/sdk/telemetry/logs.mdx index 9324c5b871937..21b519512c624 100644 --- a/develop-docs/sdk/telemetry/logs.mdx +++ b/develop-docs/sdk/telemetry/logs.mdx @@ -309,13 +309,13 @@ If a log is generated by an SDK integration, the SDK should also set the `sentry Logs can be generated in three ways: -1. User calls Sentry’s Logging API directly: No `sentry.origin`. +1. User calls Sentry’s Logging API directly: No `sentry.origin`. Users are charged by how many bytes are used, therefore we want to minimize the size of each log. 2. Captured from a logging library: Use `auto.log.` format. where `` is the relevant integration. For example, the .NET Serilog library emits: ```json { "sentry.origin": "auto.log.serilog" } ``` -3. Auto-emitted logs from other instrumented systems: Use the matching trace origin category (e.g. db, http, etc.). +3. Auto-emitted logs from other instrumented systems: Use the `auto..` format as outlined in [Trace Origin](/sdk/telemetry/traces/trace-origin/) documentation. ```json { "sentry.origin": "auto.db.prisma" } ```