Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/platforms/python/metrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ This feature is currently in open beta. Please reach out on [GitHub](https://git

</Alert>

With Sentry Metrics, you can send counters, gauges and distributions from your applications to Sentry. Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes.
Sentry metrics help you pinpoint and solve issues that impact user experience and app performance by measuring the data points that are important to you. You can track things like processing time, event size, user signups, and conversion rates, then correlate them back to tracing data in order to get deeper insights and solve issues faster.

Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes.

## Requirements

Expand Down
12 changes: 9 additions & 3 deletions platform-includes/metrics/options/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,22 @@

To filter metrics, or update them before they are sent to Sentry, you can use the `before_send_metric` option.

The `before_send_metric` argument is a callback function that is called before a metric is emitted. If the callback returns `None`, the metric is not emitted. Attributes can also be updated in the callback function.

```python
import sentry_sdk
from sentry_sdk.types import Metric, Hint
from typing import Optional

def before_metric(metric: Metric, _hint: Hint) -> Optional[Metric]:
# Filter out all failed checkouts on the acme tenant
if metric["name"] == "checkout.failed" and metric["attributes"].get("tenant") == "acme":
def before_metric(metric: Metric, hint: Hint) -> Optional[Metric]:
if metric["name"] == "removed-metric":
return None

metric["attributes"]["extra"] = "foo"

if "browser" in metric["attributes"]:
del metric["attributes"]["browser"]

return metric

sentry_sdk.init(
Expand Down
66 changes: 51 additions & 15 deletions platform-includes/metrics/usage/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,62 @@ Once the feature is enabled on the SDK and the SDK is initialized, you can send

The `metrics` namespace exposes three methods that you can use to capture different types of metric information: `count`, `gauge`, and `distribution`.

## Emit a Counter

Counters are one of the more basic types of metrics and can be used to count certain event occurrences.

To emit a counter, do the following:

```python
from sentry_sdk import metrics
import sentry_sdk

metrics.count("checkout.failed", 1)
metrics.gauge("queue.depth", 42)
metrics.distribution("cart.amount_usd", 187.5)
# Record five total button clicks
sentry_sdk.metrics.count(
name="button_click",
value=5,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just passing name and value in as simple args makes this a bit more straightforward to read IMO, and it also communicates right away which args are required and which are optional:

Suggested change
name="button_click",
value=5,
"button_click",
5,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed and changed, these were artifacts of the old metrics docs I copied the examples from.

attributes={
"browser": "Firefox",
"app_version": "1.0.0"
},
)
```

You can also pass additional attributes directly to `count`, `gauge`, and `distribution` via the `attributes` kwarg.
## Emit a Distribution

Distributions help you get the most insights from your data by allowing you to obtain aggregations such as `p90`, `min`, `max`, and `avg`.

To emit a distribution, do the following:

```python
from sentry_sdk import metrics

metrics.count(
"checkout.failed",
1,
attributes={
"route": "/checkout",
"tenant": "acme",
"provider": "stripe",
},
import sentry_sdk

# Add '15.0' to a distribution used for tracking the loading times per page.
sentry_sdk.metrics.distribution(
name="page_load",
value=15.0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name="page_load",
value=15.0,
"page_load",
15.0,

unit="millisecond",
attributes={
"page": "/home"
},
)
```

## Emit a Gauge

Gauges let you obtain aggregates like `min`, `max`, `avg`, `sum`, and `count`. They can be represented in a more space-efficient way than distributions, but they can't be used to get percentiles. If percentiles aren't important to you, we recommend using gauges.

To emit a gauge, do the following:

```python
import sentry_sdk

# Add '15.0' to a gauge used for tracking the loading times for a page.
sentry_sdk.metrics.gauge(
name="page_load",
value=15.0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name="page_load",
value=15.0,
"page_load",
15.0,

unit="millisecond",
attributes={
"page": "/home"
},
)
```
Loading