mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-08 18:06:54 +00:00
Sentry integration enhancements (#14278)
This commit is contained in:
parent
4a0372e32a
commit
fffe014db0
@ -8,6 +8,7 @@ ha_release: 0.104
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@dcramer'
|
||||
- '@frenck'
|
||||
ha_domain: sentry
|
||||
---
|
||||
|
||||
@ -19,30 +20,9 @@ ha_domain: sentry
|
||||
|
||||
The `sentry` integration integrates with [Sentry](https://sentry.io/) to capture both logged errors as well as unhandled exceptions in Home Assistant.
|
||||
|
||||
## Configuration
|
||||
## Preparation
|
||||
|
||||
To use the `sentry` integration in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sentry:
|
||||
dsn: SENTRY_DSN
|
||||
```
|
||||
|
||||
Then navigate to Configuration -> Integrations and add the DSN provided to you by Sentry where prompted.
|
||||
|
||||
{% configuration %}
|
||||
dsn:
|
||||
description: The DSN provided to you by Sentry.
|
||||
required: true
|
||||
type: string
|
||||
environment:
|
||||
description: An environment name to associate with events.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Getting the DSN
|
||||
Before configuring the Sentry integration, you'll need to get Sentry account and a DSN.
|
||||
|
||||
Follow these steps to get the DSN:
|
||||
|
||||
@ -51,3 +31,25 @@ Follow these steps to get the DSN:
|
||||
- Fill out **Give your project a name** and **choose Assign a Team** fields and click Create project button.
|
||||
- Click **Get your DSN** link in top of the page.
|
||||
- Your DSN is now visible and looks like <https://sdasdasdasdsadsadas@sentry.io/sdsdfsdf>
|
||||
|
||||
## Configuration
|
||||
|
||||
Add the Sentry integration by going into: **Configuration** -> **Integrations**.
|
||||
|
||||
Click on the `+` sign to add an integration and click on **Sentry** and follow the steps shown on screen. The DSN you've
|
||||
retrieved in the preparation step above, will be prompted.
|
||||
|
||||
## Options
|
||||
|
||||
The Sentry integration provides settings to:
|
||||
|
||||
- Set an environment name for your instance.
|
||||
- Limit the event log level to trigger on, and the log level of the breadcrumbs.
|
||||
- Ability to send out error events that are handled.
|
||||
- Ability to send out events caused by custom integrations (custom components).
|
||||
- Ability to send out events originating from third-party Python packages.
|
||||
- Enable performance tracing and tune the tracing sample rate used.
|
||||
|
||||
To change the settings go in **Configuration** -> **Integrations**, find the already installed **Sentry** box and click on **Options**.
|
||||
|
||||
After changing Sentry settings, you'll need to restart Home Assistant in order to make them effective.
|
||||
|
Loading…
x
Reference in New Issue
Block a user