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

Commit

Permalink
feat(ddm): Document ddm alerts and dashboards + sample rate
Browse files Browse the repository at this point in the history
  • Loading branch information
matejminar committed Dec 6, 2023
1 parent 56e1437 commit 11554e8
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 6 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ To learn more about `MetricsBackend`, visit [Internal Metrics](/services/metrics

## Using the `MetricsBackend`

<Alert title="Warning" level="warning">

In order to slowly roll out the new metrics extraction, we have designed an allow list mechanism that will forward metrics to DDM only if the metric name is put in the allow list. You can view and modify the allow list [here](https://github.com/getsentry/getsentry/blob/27dc1c77551276661ca17913abb96de4f7d14284/getsentry/conf/settings/prod.py#L341)

</Alert>

To use the metrics backend you will first have to import it:

```python
Expand Down Expand Up @@ -79,6 +73,12 @@ with metrics.timer("my_func_speed"):
my_func()
```

<Alert title="Warning" level="warning">

The current metrics sample rate is 5% with the goal of getting to 100% soon.

</Alert>



## Details about the `MetricsBackend`
Expand Down
6 changes: 6 additions & 0 deletions src/docs/delightful-developer-metrics/sending-metrics-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ def my_function():
pass
```

<Alert title="Warning" level="warning">

The current metrics sample rate is 5% with the goal of getting to 100% soon.

</Alert>

<Alert title="Note" level="note">
As of now, only the Python SDK is supporting the new metrics features but we are working on supporting metrics in the JavaScript and Rust SDKs next.
</Alert>
Expand Down
10 changes: 10 additions & 0 deletions src/docs/delightful-developer-metrics/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,14 @@ The UI is quite straightforward. You will see an option to add a widget, and eac

You will also be able to **save your scratchpad**. This means that Sentry will store the representation of the scratchpad in your local storage. This allows you to maintain multiple scratchpads during an exploration.

## Dashboards and Alerts

You can alert on custom metrics. As always, you can create these alerts either from the DDM page or by using the Alerts Wizard.

DDM also plays nicely with Dashboards. You can plot custom metrics either in DDM and then later save them to a dashboard or go through the Dashboards directly.

![DDM Dashboards and Alerts](/images/ddm-dashboards-alers.png)



## 🙏 Now have fun and don’t forget to give us feedback on [GitHub](https://github.com/getsentry/sentry/discussions/58584)

1 comment on commit 11554e8

@vercel
Copy link

@vercel vercel bot commented on 11554e8 Dec 6, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

develop – ./

develop-git-master.sentry.dev
develop.sentry.dev

Please sign in to comment.