oncall-engine/docs/sources/integrations/sentry/index.md
Jack Baldry 1735db4c3b
Update all links to use docs/reference style (#2456)
# What this PR does

The `docs/reference` shortcode supports contextual destinations and
version inference.

`<ONCALL VERSION>` is inferred to match the version of the documentation
set. For example, the inferred version for the page
/docs/grafana/oncall/latest/get-started/ is "latest". It can also be
overriden using front matter.
Given the same page, but with the additional front matter
`oncall_version: next`, the variable is substituted with "next" rather
than "latest".

Contextual destinations are achieved using repeated labels in the
shortcode inner text. The format is [<LABEL>]: "<PAGE PATH PREFIX> ->
<HUGO REFERENCE>".

- _`<LABEL>`_ matches the reference style link label used in the rest of
the text.
- _`<PAGE PATH PREFIX>`_ is matched against the page during the
production build. If the match is successful, the destination that is
used is _`<HUGO REFERENCE>`_. The first matching prefix is used, not the
longest matching prefix.

## Which issue(s) this PR fixes

- Broken links due to ambiguous relref resolution. Any relref parameter
that does not start with either `/`, `./`, or `../` can resolve
ambiguously and is resulting in broken link behavior on the current
site.
- Broken links in Grafana Cloud. We mount OnCall documentation in
Grafana Cloud. In https://github.com/grafana/website/pull/13872 the
location will become /docs/grafana-cloud/alerting-and-irm/oncall. This
PR is intended to be merged alongside that PR.

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
2023-07-13 14:38:35 +00:00

2.3 KiB

aliases canonical keywords title weight
add-sentry/
/docs/oncall/latest/integrations/available-integrations/configure-Sentry/
https://grafana.com/docs/oncall/latest/integrations/available-integrations/configure-sentry/
Grafana Cloud
Alerts
Notifications
on-call
sentry
Sentry 500

Sentry integration for Grafana OnCall

The Sentry integration for Grafana OnCall handles ticket events sent from Sentry webhooks. The integration provides grouping, auto-acknowledge and auto-resolve logic via customizable alert templates.

You must have the [role of Admin][user-and-team-management] to be able to create integrations in Grafana OnCall.

Configuring Grafana OnCall to Receive Alerts from Sentry

  1. In the Integrations tab, click + New integration.
  2. Select Sentry from the list of available integrations.
  3. Enter a name and description for the integration, click Create
  4. A new page will open with the integration details. Copy the OnCall Integration URL from HTTP Endpoint section.

Configuring Sentry to Send Alerts to Grafana OnCall

To send a webhook alert from Sentry, you can follow these steps:

  1. Log in to your Sentry account.

  2. Navigate to your project's settings.

  3. Click on "Alerts" in the sidebar menu.

  4. Click on "New Alert Rule" to create a new alert rule.

  5. Configure the conditions for the alert rule based on your requirements. For example, you can set conditions based on issue level, event frequency, or specific tags.

  6. In the "Actions" section, select "Webhook" as the action type.

  7. Provide the necessary details for the webhook:

    • URL: OnCall Integration URL
    • Method: POST
    • Payload: Define the payload structure and content that you want to send to the webhook endpoint. You can use Sentry's dynamic variables to include relevant information in the payload.
  8. Save the alert rule.

Once the alert conditions are met, Sentry will trigger the webhook action and send a request to the Grafana OnCall.

{{% docs/reference %}} [user-and-team-management]: "/docs/oncall/ -> /docs/oncall//user-and-team-management" [user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/user-and-team-management" {{% /docs/reference %}}