# Sentry

[Sentry](https://sentry.io/about/) is a popular error monitoring and reporting tool. It is open source and enables you to monitor and track real-time errors and crashes in your app.

RudderStack supports Sentry as a destination to which you can send your event data directly.

## Connection compatibility

{{< destination-config >}}

{{< info >}}
In the web device mode integration, that is, using [JavaScript SDK]({{< ref "sources/event-streams/sdks/rudderstack-javascript-sdk/_index.md" >}}) as a source, RudderStack loads the Sentry native SDK from the `https://browser.sentry-cdn.com/` domain.

Based on your website's content security policy, you might need to [allowlist this domain]({{< ref "sources/event-streams/sdks/rudderstack-javascript-sdk/load-js-sdk.md#allowlist-destination-domain" >}}) to load the Sentry SDK successfully.
{{< /info >}}

## Get started

Once you have confirmed that the source platform supports sending events to Sentry, follow these steps:

* From your [RudderStack dashboard](https://app.rudderstack.com/), add the source. Then, select **Sentry** from the list of destinations.
* Assign a name to the destination and click **Next**. You will then see the following screen:

{{< image src="images/sentry.webp" alt="Configuration settings for sentry" >}}
<span class="imageTitle">Configuration Settings for Sentry</span>

### Connection Settings

To successfully configure Sentry as a destination, configure the following settings:

* **Public DSN:** Enter the public DSN of your Sentry project here. **This is a mandatory field**.

{{< info >}}

Refer to the [FAQ](#faq) section below for more information on getting your public DSN.
{{< /info >}}

* **Environment:** Enter the value you want RudderStack to set as the environment configuration in your Sentry dashboard. For more information on the use of environments in Sentry, refer to their [documentation](https://docs.sentry.io/product/sentry-basics/environments/#creating-environments).

{{< warning >}}

If you enter the value for the **Environment** field as a forward slash \(`/`\), new line character, space \(` `), or the string `None`, Sentry will silently discard the environment configuration information without sending any error.
{{< /warning >}}

* **Set Release By Property:** This field helps you dynamically track the application version in Sentry. The property set here will be searched in the global window object. If found, RudderStack will use that particular version. Otherwise, the value set in the **Release** field will be used by default.

{{< info >}}

Suppose you have set the **Set Release By Property** field to the value `new_custom_version` and RudderStack finds `window.new_custom_version=2.4.5` in the `window` object. In this case, RudderStack will send the value `2.4.5` as the app version to Sentry. Otherwise, it will look for the value input in the **Release** field and send it as the app version.
{{< /info >}}

{{< warning >}}

Sentry needs the `release` value for every single session. If neither **Set Release By Property** or **Release fields** are specified in the dashboard while configuring the destination, the particular session will be discarded.
{{< /warning >}}

* **Release:** This field is used for tracking your application's version in Sentry.
* **Server Name:** This option is used to track the host on which the client is running. You can enter the server name or even the Device ID in this field.
* **Logger:** The name you want Sentry to use as logger. For more information on Sentry's logging feature, refer to their [docs](https://docs.sentry.io/platforms/python/guides/logging/).
* **Ignore Errors:** This option refers to a list of error messages that you do not want Sentry to notify you. You can enter this list as a string or a regular expression.
* **Include Paths:** This field should contain the regex patterns of URLs that are part of the app in the stack trace. The other frames will appear as collapsed in the Sentry dashboard.
* **Allow URLs:** This is the list of the regex patterns or exact URL strings - from which the errors need to be exclusively sent to Sentry. The URLs of the actual JavaScript files should match this list.
* **Deny URLs:** This field refers to the list of regex patterns or exact URL strings for which the errors need to be ignored.
* **Debug Mode:** In debug mode, no events are sent to your Sentry instance. You can set this option to **true** or **false** to enable or disable this feature. By default, it is set to **false**.

A sample configuration looks like the following:

{{< image src="images/sentry.webp" alt="Configuration" >}}

## Identify

When an `identify` call is made, RudderStack calls [`Sentry.setUser`](https://docs.sentry.io/platforms/javascript/enriching-events/identify-user/) by passing the user traits.

{{< info >}}

RudderStack discards the `identify` call if none of the `userId`, `userName`, `email`, or `ip_address` is present. Atleast one of these four fields is needed to capture the user information. For more information, refer to the [Sentry documentation](https://docs.sentry.io/platforms/javascript/enriching-events/identify-user/).
{{< /info >}}

{{< info >}}

RudderStack maps `userId` to `id` while setting the user in Sentry.
{{< /info >}}

A sample `identify` call is as shown:

```javascript
rudderanalytics.identify("userid", {
  name: "Name",
  email: "name@website.com",
});
```

## FAQ 

#### How do I get the public DSN of my Sentry Project?

To get your public DSN, follow these steps:

* Log into your [Sentry account](https://sentry.io/auth/login/).
* In the left navigation bar, go to **Projects** .
* Click the right-most settings icon. This will open the settings window.
* Click **Client Keys \(DSN\)** under **SDK Setup**.
* Copy the DSN and use it in your RudderStack destination configuration.