From 48b642679466b03ea25b6ebadd386159be2515ba Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Fri, 14 Jun 2024 11:50:22 +0200 Subject: [PATCH 1/4] fix: Clarify context keys --- src/docs/sdk/unified-api/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/unified-api/index.mdx b/src/docs/sdk/unified-api/index.mdx index 9d7450c4e8..cf7ed1c3b1 100644 --- a/src/docs/sdk/unified-api/index.mdx +++ b/src/docs/sdk/unified-api/index.mdx @@ -61,7 +61,7 @@ meant that certain integrations (such as breadcrumbs) were often not possible. - **client options**: Are parameters that are language and runtime specific and used to configure the client. This can be release and environment but also things like which integrations to configure, how in-app works etc. -- **context**: Contexts give extra data to Sentry. There are the special contexts (user and similar) and the generic ones (`runtime`, `os`, `device`), etc. Check out Contexts for valid keys. *Note: In older SDKs, you might encounter an unrelated concept of context, which is now deprecated by scopes* +- **context**: Contexts give extra data to Sentry. There are the special contexts (user and similar) and the generic ones (`runtime`, `os`, `device`), etc. Check out Contexts for some predefined keys - users can also add arbitrary context keys. *Note: In older SDKs, you might encounter an unrelated concept of context, which is now deprecated by scopes* - **tags**: Tags can be arbitrary string→string pairs by which events can be searched. Contexts are converted into tags. From 1e005a6c4617d7c89c2ee06d93c3bb698ccc4c9e Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Fri, 14 Jun 2024 12:07:18 +0200 Subject: [PATCH 2/4] clarify contexts --- src/docs/sdk/unified-api/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/unified-api/index.mdx b/src/docs/sdk/unified-api/index.mdx index cf7ed1c3b1..d44d55f0ae 100644 --- a/src/docs/sdk/unified-api/index.mdx +++ b/src/docs/sdk/unified-api/index.mdx @@ -65,7 +65,7 @@ meant that certain integrations (such as breadcrumbs) were often not possible. - **tags**: Tags can be arbitrary string→string pairs by which events can be searched. Contexts are converted into tags. -- **extra**: Truly arbitrary data attached by client users. This is a deprecated feature but will continue to be supported for the foreseeable future. Users are encouraged to use contexts instead. +- **extra**: Truly arbitrary data attached by client users. In most cases, this should not be used, and instead structured `context` or `tags` should be used instead. - **transport**: The transport is an internal construct of the client that abstracts away the event sending. Typically the transport runs in a separate thread and gets events to send via a queue. The transport is responsible for sending, retrying and handling rate limits. The transport might also persist unsent events across restarts if needed. From 08645024b208fe05932f3ac73870b88dd418f810 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Fri, 14 Jun 2024 12:08:44 +0200 Subject: [PATCH 3/4] wording adjustment --- src/docs/sdk/unified-api/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/unified-api/index.mdx b/src/docs/sdk/unified-api/index.mdx index d44d55f0ae..b065e99312 100644 --- a/src/docs/sdk/unified-api/index.mdx +++ b/src/docs/sdk/unified-api/index.mdx @@ -65,7 +65,7 @@ meant that certain integrations (such as breadcrumbs) were often not possible. - **tags**: Tags can be arbitrary string→string pairs by which events can be searched. Contexts are converted into tags. -- **extra**: Truly arbitrary data attached by client users. In most cases, this should not be used, and instead structured `context` or `tags` should be used instead. +- **extra**: Truly arbitrary data attached by client users. Extra should be avoided where possible, and instead structured `context` or `tags` should be used - as these can be queried and visualized in a better way. - **transport**: The transport is an internal construct of the client that abstracts away the event sending. Typically the transport runs in a separate thread and gets events to send via a queue. The transport is responsible for sending, retrying and handling rate limits. The transport might also persist unsent events across restarts if needed. From 89b0e391aa0c70b263501612ffe58a5553f1d5be Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Mon, 17 Jun 2024 13:53:21 +0200 Subject: [PATCH 4/4] Update src/docs/sdk/unified-api/index.mdx --- src/docs/sdk/unified-api/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/unified-api/index.mdx b/src/docs/sdk/unified-api/index.mdx index b065e99312..c9dfc6b331 100644 --- a/src/docs/sdk/unified-api/index.mdx +++ b/src/docs/sdk/unified-api/index.mdx @@ -65,7 +65,7 @@ meant that certain integrations (such as breadcrumbs) were often not possible. - **tags**: Tags can be arbitrary string→string pairs by which events can be searched. Contexts are converted into tags. -- **extra**: Truly arbitrary data attached by client users. Extra should be avoided where possible, and instead structured `context` or `tags` should be used - as these can be queried and visualized in a better way. +- **extra**: Truly arbitrary data attached by client users. Extra should be avoided where possible, and instead structured `context` should be used - as these can be queried and visualized in a better way. - **transport**: The transport is an internal construct of the client that abstracts away the event sending. Typically the transport runs in a separate thread and gets events to send via a queue. The transport is responsible for sending, retrying and handling rate limits. The transport might also persist unsent events across restarts if needed.