Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Commit

Permalink
fix(ddm): Remove discouraging of gauges (#1224)
Browse files Browse the repository at this point in the history
  • Loading branch information
iambriccardo committed Apr 15, 2024
1 parent 06c702c commit bc105e7
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/docs/sdk/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit bc105e7

Please sign in to comment.