From f7a1bff6dd5b0f1ccc7c78c629987c2367dbc323 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Thu, 24 Apr 2025 11:07:43 -0400 Subject: [PATCH] feat: More clearly document log envelope item in logs spec --- develop-docs/sdk/telemetry/logs.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/develop-docs/sdk/telemetry/logs.mdx b/develop-docs/sdk/telemetry/logs.mdx index 616e5345f7780..6c65155aa8be7 100644 --- a/develop-docs/sdk/telemetry/logs.mdx +++ b/develop-docs/sdk/telemetry/logs.mdx @@ -17,9 +17,24 @@ There are two ways to send logs to Sentry: via the `log` envelope and Sentry Log All SDKs are required to send logs via the `log` envelope and Sentry Log protocol. The `otel_log` envelope and OpenTelemetry Log protocol are just documented for completeness and to provide a reference for SDK authors. See the [Appendix A](#appendix-a-otel_log-envelope-item-payload) for the `otel_log` envelope item payload. +### `log` Envelope Item + +The `log` envelope item is an object that contains an array of log payloads encoded as JSON. This allows for multiple log payloads to be sent in a single envelope item. For more details on the `log` envelope item, see the [Log Envelope Item](/sdk/data-model/envelope-items/#log) documentation. + +```json +{ + "type": "log", + "item_count": 5, + "content_type": "application/vnd.sentry.items.log+json" +} +{ + "items": [{..log..}, {..log..}, {..log..}, {..log..}, {..log..}] +} +``` + ### `log` Envelope Item Payload -The `log` envelope item payload is a JSON object that represents a Sentry Log. Multiple `log` envelope items can be sent in a single envelope. +The `log` envelope item payload is a JSON object that represents a Sentry Log. ```json {