From bc105e7c3bc56077f2ac99fa6d3d9d1c1c7bb161 Mon Sep 17 00:00:00 2001 From: Riccardo Busetti Date: Mon, 15 Apr 2024 16:25:08 +0200 Subject: [PATCH] fix(ddm): Remove discouraging of gauges (#1224) --- src/docs/sdk/metrics.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/docs/sdk/metrics.mdx b/src/docs/sdk/metrics.mdx index cf173d1a88..980920fe3e 100644 --- a/src/docs/sdk/metrics.mdx +++ b/src/docs/sdk/metrics.mdx @@ -92,11 +92,11 @@ relay: [`MetricUnit`](https://getsentry.github.io/relay/relay_metrics/enum.Metri ## Span Seeking and Span Creating Mode -When a metric is emitted it shall either determine the current span (span seeking) or +When a metric is emitted it shall either determine the current span (span seeking) or create a new span (span creating). In **span seeking** mode, the span is determined based on the current span on the scope. -APIs such as `.increment()`, `.distribution()`, `.gauge()` and `.set()` operate in span +APIs such as `.increment()`, `.distribution()`, `.gauge()` and `.set()` operate in span seeking mode. In **span creating** mode a new active span is started. @@ -108,7 +108,7 @@ In span creating mode the span should be setup the following way: * the metric tags should be applied to the span as well * the span is finished once the timing callback finishes -From there two things shall be happening unless they are disabled: +From there two things shall be happening unless they are disabled: * **Common tag attaching:** the tags `transaction`, `release` and `environment` shall be automatically added to the metric. * **Span local aggregation:** the metric shall be attached to the determined span @@ -234,7 +234,7 @@ class Distribution: ### Gauges -Gauges (`g`) are generally discouraged. They are often also called "summaries" as they +Gauges (`g`) are often also called "summaries" as they are similar in nature to distributions, but somewhat lossy. They are however emitted per span when metric summaries are enabled. As they are hard to aggregate across different emitters they can be tricky to use properly in practice.