From 0c123899672a5852b3285b9a37bc7dd3635006b6 Mon Sep 17 00:00:00 2001 From: Charly Gomez Date: Thu, 18 Jul 2024 11:24:53 +0200 Subject: [PATCH 1/4] fix: remove link to no-existent file note: I have checked the repo and could not find anything that would correnspond to this file --- develop-docs/sdk/event-payloads/contexts.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/event-payloads/contexts.mdx b/develop-docs/sdk/event-payloads/contexts.mdx index ad067d72903976..b193f4d66e95d0 100644 --- a/develop-docs/sdk/event-payloads/contexts.mdx +++ b/develop-docs/sdk/event-payloads/contexts.mdx @@ -277,7 +277,7 @@ system. For some well-known runtimes, Sentry will attempt to parse `name` and : _Optional_. An object that provides meta-data for Linux distributions. The values correspond to entries from the [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#Options) configuration. Contains the following keys: -- `name`: A stable name for each distribution. This maps to `ID` in `/etc/os-release` (examples: `ubuntu`, `rhel`, `alpine`; a full list of tested identifiers is available in the [Native SDK repository](https://github.com/getsentry/sentry-native/blob/master/tests/fixtures/os_releases/distribution_names.txt). +- `name`: A stable name for each distribution. This maps to `ID` in `/etc/os-release` (examples: `ubuntu`, `rhel`, `alpine`). - `version`: _Optional_. Typically identifies at least the major release version number. This maps to `VERSION_ID` in `/etc/os-release`. Distributions with rolling releases only, will not provide a version. - `pretty_name`: _Optional_. Typically provides the full name, full version, and release alias. This maps to `PRETTY_NAME` in `/etc/os-release` (examples: `Ubuntu 22.04.4 LTS`, `Raspian GNU/Linux 10 (buster)`). From 891ef4d10bc010e3eed4374428dc53bd65e472c2 Mon Sep 17 00:00:00 2001 From: Charly Gomez Date: Thu, 18 Jul 2024 12:32:09 +0200 Subject: [PATCH 2/4] fix: get rid of outdated link --- develop-docs/sdk/performance/span-operations.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/performance/span-operations.mdx b/develop-docs/sdk/performance/span-operations.mdx index 1c45065e86f09a..66b57ee6c49675 100644 --- a/develop-docs/sdk/performance/span-operations.mdx +++ b/develop-docs/sdk/performance/span-operations.mdx @@ -6,7 +6,7 @@ Span operations are a short code identifying the type of operation the span is m Operations are expected to follow [OpenTelemetry's semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md) as much as possible. -It's important to keep categories consistent between SDKs and integrations as they are used by Sentry in the [Operations Breakdown](https://docs.sentry.io/product/sentry-basics/tracing/event-detail/#operations-breakdown) feature. For example, both `db.init` and `db.query` will be categorized as database operations (`db`). The default operations breakdown config can be seen [here](https://github.com/getsentry/sentry/blob/9f36200d665209c9328f5ccc21135d3de9b65318/src/sentry/projectoptions/defaults.py#L80). +It's important to keep categories consistent between SDKs and integrations as they are used by Sentry in various parts of the platform. For example, both `db.init` and `db.query` will be categorized as database operations (`db`). The default operations breakdown config can be seen [here](https://github.com/getsentry/sentry/blob/9f36200d665209c9328f5ccc21135d3de9b65318/src/sentry/projectoptions/defaults.py#L80). Span operations should be lower case and use snake_case From b448414d1ee5ed57463068b75998a55c27cdb6fb Mon Sep 17 00:00:00 2001 From: Charly Gomez Date: Thu, 18 Jul 2024 13:18:22 +0200 Subject: [PATCH 3/4] fix otel links --- develop-docs/sdk/performance/opentelemetry.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/develop-docs/sdk/performance/opentelemetry.mdx b/develop-docs/sdk/performance/opentelemetry.mdx index c311384a10de87..fc3e9077fac571 100644 --- a/develop-docs/sdk/performance/opentelemetry.mdx +++ b/develop-docs/sdk/performance/opentelemetry.mdx @@ -265,8 +265,7 @@ function updateTransactionWithOtelData( } ``` -A reference implementation to parse the OTEL span descriptions can be found here: -[parse-otel-span-description.ts](https://github.com/getsentry/sentry-javascript/blob/master/packages/opentelemetry-node/src/utils/parse-otel-span-description.ts) +A reference implementation to parse the OTEL span descriptions can be found [here](https://github.com/getsentry/sentry-javascript/blob/master/packages/opentelemetry/src/utils/parseSpanDescription.ts). ### Step 5: Add OpenTelemetry Context @@ -401,7 +400,7 @@ function generateSentryErrorsFromOtelSpan(otelSpan) { ## Span Protocol -Below describe the transformations between an OpenTelemetry span and a Sentry Span. Related: [the interface for a Sentry Span](https://develop.sentry.dev/sdk/event-payloads/span/), [the Relay spec for a Sentry Span](https://github.com/getsentry/relay/blob/master/relay-general/src/protocol/span.rs) and the spec for an [OpenTelemetry span](https://github.com/open-telemetry/opentelemetry-proto/blob/724e427879e3d2bae2edc0218fff06e37b9eb46e/opentelemetry/proto/trace/v1/trace.proto#L80-L256). +Below describe the transformations between an OpenTelemetry span and a Sentry Span. Related: [the interface for a Sentry Span](https://develop.sentry.dev/sdk/event-payloads/span/), [the Relay spec for a Sentry Span](https://github.com/getsentry/relay/blob/master/relay-event-schema/src/protocol/span.rs) and the spec for an [OpenTelemetry span](https://github.com/open-telemetry/opentelemetry-proto/blob/724e427879e3d2bae2edc0218fff06e37b9eb46e/opentelemetry/proto/trace/v1/trace.proto#L80-L256). This is based on a mapping done as part of work on the [OpenTelemetry Sentry Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sentryexporter/docs/transformation.md). From 79cbde65ed94262040ee610f6b4ce5e88c9a541c Mon Sep 17 00:00:00 2001 From: Charly Gomez Date: Thu, 18 Jul 2024 13:58:46 +0200 Subject: [PATCH 4/4] add operations breakdown redirect --- src/middleware.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/middleware.ts b/src/middleware.ts index 5deb41b4d49f72..f9cf9d814fe389 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -3370,6 +3370,10 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ from: '/performance/instrumentation/automatic-instrumentation/', to: '/tracing/instrumentation/automatic-instrumentation', }, + { + from: '/concepts/key-terms/key-terms/tracing/trace-view/#operations-breakdown/', + to: '/product/insights/', + }, ]; const DEVELOPER_DOCS_REDIRECTS: Redirect[] = [