Skip to content

Add docs for Elixir/Telemetry integration #13725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all 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
27 changes: 27 additions & 0 deletions docs/platforms/elixir/integrations/telemetry/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Telemetry
description: "Sentry supports monitoring Telemetry handler errors and reporting them."
sidebar_order: 40
---

The [Telemetry](https://github.com/beam-telemetry/telemetry) integration supports:

* Capturing errors that happen in Telemetry handlers and reporting them.

This integration is built into the Sentry SDK starting with *v10.10.0*.

## Configure

You can configure the Telemetry integration in your Sentry configuration, under the `:integrations` key:

```elixir {filename:config/config.exs} {diff}
config :sentry,
# ...,
integrations: [
+ telemetry: [
+ report_handler_failures: true,
+ ]
]
```

This configuration will report failed Telemetry handler errors to Sentry. It's usually important to report these errors, as Telemetry *detaches* failing handlers. If you don't monitor these errors, you may not know that a handler failed and is not going to execute anymore until it's re-attached (usually when the application restarts).