centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Replace docs/reference shortcode with ref URIs (#4301)

Browse source 
You can use `ref` URIs in admonitions (or any shortcodes) because they
are inline and not subject to the issues noted in the [`admonition`
shortcode](https://grafana.com/docs/writers-toolkit/write/shortcodes/#code-shortcode:~:text=to%20core%20understanding.-,WARNING,For%20more%20information%2C%20refer%20to%20Markdown%20Reference%20Links%20in%20Shortcodes.,-Examples).

The `ref` URIs perform the same pattern matching as `docs/reference` but
don't require the use of reference-style links and the destinations are
ordinary (full) URLs that can include version substitution. Unlike
`docs/reference`, the implementation doesn't use `relref` so you don't
have to be careful with omitting trailing slashes and the links will
follow redirects.

Documentation:
https://grafana.com/docs/writers-toolkit/write/links/#link-from-source-content-thats-used-in-multiple-projects

To check the links, refer to the deploy preview in
https://github.com/grafana/website/pull/19630.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Jack Baldry 2024-07-29 15:13:24 +01:00 • committed by GitHub
parent 5a9f124ba7
commit 9ae442faa6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
43 changed files with 616 additions and 459 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/sources/configure/_index.md
View file

@ -13,6 +13,22 @@ keywords:
canonical: https://grafana.com/docs/oncall/latest/configure/
aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/
refs:
integrations:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/
jinja2-templating:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
escalation-chains-and-routes:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes/
---
# Configure Grafana OnCall
@ -28,26 +44,15 @@ Explore key settings and integrations that allow you to customize your incident
Integrate with your tools and alert sources to begin routing alerts with Grafana OnCall.
For detailed information on configuring integrations, refer to the [Integrations][integrations] documentation.
For detailed information on configuring integrations, refer to the [Integrations](ref:integrations) documentation.
### Configure Escalation chains and routes
Escalation chains allow you to customize alert routing to align with your team's processes and workflows.
You have the flexibility to define how and when to escalate to different teams for different alerts.
For information on configuration options, refer to [Escalation chains and routes][escalation-chains-and-routes].
For information on configuration options, refer to [Escalation chains and routes](ref:escalation-chains-and-routes).
### Customize alert templates
For detailed information on customizing alert templates, refer to the [Jinja2 templating][jinja2-templating] documentation.
{{% docs/reference %}}
[integrations]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations"
[integrations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations"
[escalation-chains-and-routes]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes"
[escalation-chains-and-routes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes"
[jinja2-templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[jinja2-templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
{{% /docs/reference %}}
For detailed information on customizing alert templates, refer to the [Jinja2 templating](ref:jinja2-templating) documentation.

27
docs/sources/configure/escalation-chains-and-routes/index.md
View file

@ -16,6 +16,22 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes/
- /docs/grafana-cloud/alerting-and-irm/oncall/escalation-chains-and-routes/
- ../escalation-chains-and-routes/ # /docs/oncall/<ONCALL_VERSION>/escalation-chains-and-routes/
refs:
notify-people:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/notify/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/
routing-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#routing-template
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#routing-template
outgoing-webhook:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
---
# Escalation Chains and Routes
@ -135,14 +151,3 @@ For more information, refer to [Notify people].
> **Important:** Linked Integrations and Routes are displayed in the right panel. Any change in the Escalation Chain will
affect all linked Integrations and Routes.
{{% docs/reference %}}
[Notify people]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/notify"
[Notify people]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify"
[outgoing webhook]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[outgoing webhook]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
[Routing Templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#routing-template"
[Routing Templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#routing-template"
{{% /docs/reference %}}

96
docs/sources/configure/integrations/_index.md
View file

@ -14,6 +14,58 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/
refs:
integration-references:
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/
group-id-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#grouping-id-template
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#grouping-id-template
intergration-references:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/
appearance-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#appearance-templates
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#appearance-templates
inbound-email:
- pattern: /docs/oncall
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email/
- pattern: /docs/grafana-cloud
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email/
alert-workflow:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/set-up/get-started/#learn-about-the-alert-workflow
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/set-up/get-started/#learn-about-the-alert-workflow
integration-labels:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/
routing-template:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#routing-template
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#routing-template
behavioral-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#behavioral-templates
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#behavioral-templates
webhooks:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
jinja2-templating:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
---
# Grafana OnCall integrations
@ -26,52 +78,20 @@ For more information about how to configure an integration, refer to [Configure
## Understand the integration alert flow
- An alert is received on an integration’s **Unique URL** as an HTTP POST request with a JSON payload (or via [Inbound email][inbound-email] for email integrations).
- An alert is received on an integration’s **Unique URL** as an HTTP POST request with a JSON payload (or via [Inbound email](ref:inbound-email) for email integrations).
- The incoming alert is routed according to the [Routing Template][routing-template].
- The incoming alert is routed according to the [Routing Template](ref:routing-template).
- Alerts are grouped based on the [Grouping ID Template][group-id-templates] and rendered using [Appearance Templates][appearance-templates].
- Alerts are grouped based on the [Grouping ID Template](ref:group-id-templates) and rendered using [Appearance Templates](ref:appearance-templates).
- The alert group can be published to messaging platforms, based on the **Publish to Chatops** configuration.
- The alert group is escalated to users according to the Escalation Chains selected for the route.
- An alert group can be acknowledged or resolved with status updates based on its [Behavioral Templates][behavioral-templates].
- An alert group can be acknowledged or resolved with status updates based on its [Behavioral Templates](ref:behavioral-templates).
- Users can perform actions listed in the [Alert Workflow][alert-workflow] section.
- Users can perform actions listed in the [Alert Workflow](ref:alert-workflow) section.
## Explore available integrations
Refer to [Integration references][intergration-references] for a list of available integrations and specific set up instructions.
{{% docs/reference %}}
[appearance-templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#appearance-templates"
[appearance-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#appearance-templates"
[behavioral-templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#behavioral-templates"
[behavioral-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#behavioral-templates"
[group-id-templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#grouping-id-template"
[group-id-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#grouping-id-template"
[inbound-email]: "/docs/oncall -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email"
[inbound-email]: "/docs/grafana-cloud -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email"
[jinja2-templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[jinja2-templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
[alert-workflow]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/set-up/get-started#learn-about-the-alert-workflow"
[alert-workflow]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/set-up/get-started#learn-about-the-alert-workflow"
[routing-template]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#routing-template"
[routing-template]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#routing-template"
[Webhooks]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[Webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
[integration-labels]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels"
[integration-labels]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels"
[intergration-references]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references"
[integration-references]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references"
{{% /docs/reference %}}
Refer to [Integration references](ref:intergration-references) for a list of available integrations and specific set up instructions.

85
docs/sources/configure/integrations/integration-management/index.md
View file

@ -14,6 +14,52 @@ canonical: https://grafana.com/docs/oncall/latest/configure/integrations/integra
aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/integration-management/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/integration-management/
refs:
webhooks:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
behavioral-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#behavioral-templates
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#behavioral-templates
routing-template:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#routing-template
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#routing-template
integration-labels:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/
jinja2-templating:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
configure-labels:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/
integration-references:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/
integration-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
appearance-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#appearance-templates
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#appearance-templates
---
# Configure and manage integrations
@ -29,7 +75,7 @@ You can manage or view your integrations current configuration at any time in th
To integrate Grafana OnCall with your chosen tools, follow these steps:
1. Navigate to the **Integrations** tab in Grafana OnCall, and click **+ New integration**.
1. Select your desired integration type from the [list of available integrations][integration-references].
1. Select your desired integration type from the [list of available integrations](ref:integration-references).
If your desired integration is not listed, select **Webhook**.
1. Provide a title and a description for your integration, assign it to a team, and click **Create Integration**.
1. The Integration page will open, displaying details about the Integration.
@ -42,7 +88,7 @@ The provided HTTP Endpoint URL can be used to send events from an external monit
Explore ways to customize the behavior of your alerts from a specific integration:
- Customize alerting grouping, auto-resolution, and auto-acknowledge templates to tailor the alert behavior for your team.
- Modify [Appearance templates][appearance-templates] to customize how alert groups are displayed in various parts of Grafana OnCall, such as the UI, phone and
- Modify [Appearance templates](ref:appearance-templates) to customize how alert groups are displayed in various parts of Grafana OnCall, such as the UI, phone and
SMS, email, notifications, etc.
- Add routes to your integration to direct alerts to different users and teams based on labels or other data.
- Connect your escalation chains to routes to ensure the right people are notified at the right time.
@ -51,8 +97,8 @@ to avoid sending real notifications to your team.
For detailed instructions, refer to:
- [Integration templates][integration-templates]
- [Configure labels][configure-labels]
- [Integration templates](ref:integration-templates)
- [Configure labels](ref:configure-labels)
## Manage Maintenance Mode
@ -99,33 +145,4 @@ To edit the name of an integration:
## Explore available integrations
Specific guidance and configuration options for each integration are available at [Integration references][integration-references].
{{% docs/reference %}}
[appearance-templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#appearance-templates"
[appearance-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#appearance-templates"
[behavioral-templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#behavioral-templates"
[behavioral-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#behavioral-templates"
[jinja2-templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[jinja2-templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
[routing-template]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#routing-template"
[routing-template]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#routing-template"
[Webhooks]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[Webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
[integration-labels]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels"
[integration-labels]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels"
[integration-templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[integration-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
[configure-labels]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels"
[configure-labels]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels"
[integration-references]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references"
[integration-references]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references"
{{% /docs/reference %}}
Specific guidance and configuration options for each integration are available at [Integration references](ref:integration-references).

49
docs/sources/configure/integrations/outgoing-webhooks/index.md
View file

@ -14,6 +14,32 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/outgoing-webhooks/
- /docs/grafana-cloud/alerting-and-irm/oncall/outgoing-webhooks/
- ../outgoing-webhooks/ # /docs/oncall/<ONCALL_VERSION>/outgoing-webhooks/
refs:
alert-group-labels:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/#alert-group-labels
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/#alert-group-labels
integration-labels:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/
jira:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/jira/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/jira/
zendesk:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/zendesk/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/zendesk/
servicenow:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/servicenow/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/servicenow/
---
@ -554,23 +580,6 @@ the `id` of that ticket to keep its status synchronized with the state changes b
Integrate with third-party services:
- [JIRA][jira]
- [ServiceNow][ServiceNow]
- [Zendesk][Zendesk]
{{% docs/reference %}}
[Alert group labels]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels#alert-group-labels"
[Alert group labels]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels#alert-group-labels"
[Integration labels]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels"
[Integration labels]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels"
[jira]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/jira"
[jira]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/jira"
[ServiceNow]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/servicenow"
[ServiceNow]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/servicenow"
[Zendesk]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/zendesk"
[Zendesk]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/zendesk"
{{% /docs/reference %}}
- [JIRA](ref:jira)
- [ServiceNow](ref:servicenow)
- [Zendesk](ref:zendesk)

41
docs/sources/configure/integrations/references/alertmanager/index.md
View file

@ -16,6 +16,27 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/alertmanager
- add-alertmanager/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/alertmanager
refs:
complete-the-integration-configuration:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/integration-management/#customize-the-integration
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/integrations/#customize-the-integration
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
data_webhook_template:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks/#outgoing-webhook-templates
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/#outgoing-webhook-templates
trigger_webhook_template:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks/#using-trigger-template-field
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks/#using-trigger-template-field
---
# Alertmanager integration for Grafana OnCall
@ -66,7 +87,7 @@ receivers:
## Complete the Integration Configuration
Complete configuration by setting routes, templates, maintenances, etc. Read more in
[this section][complete-the-integration-configuration]
[this section](ref:complete-the-integration-configuration)
## Note about grouping and autoresolution
@ -179,23 +200,9 @@ You can read more about AlertManager Data model [here](https://prometheus.io/doc
1. Send a new demo alert to the migrated integration.
2. Adjust routes to the new shape of payload. You can use payload of the demo alert from previous step as an example.
3. If outgoing webhooks utilized the alerts payload from the migrated integration in the [trigger][trigger_webhook_template]
or [data][data_webhook_template] template it's needed to adjust them as well.
3. If outgoing webhooks utilized the alerts payload from the migrated integration in the [trigger](ref:trigger_webhook_template)
or [data](ref:data_webhook_template) template it's needed to adjust them as well.
<img width="1646" alt="Screenshot 2023-12-14 at 1 14 21 PM" src="https://github.com/grafana/oncall/assets/85312870/7e281416-edbc-4384-8d15-7efaec2de311">
<img width="1644" alt="Screenshot 2023-12-14 at 1 14 32 PM" src="https://github.com/grafana/oncall/assets/85312870/b62cfa1d-2ff6-4b46-9cec-459b14cd1996">
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
[complete-the-integration-configuration]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/integration-management#customize-the-integration"
[complete-the-integration-configuration]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/integrations#customize-the-integration"
[data_webhook_template]: "/docs/oncall/ -> /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks#outgoing-webhook-templates"
[data_webhook_template]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks#outgoing-webhook-templates"
[trigger_webhook_template]: "/docs/oncall/ -> /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks#using-trigger-template-field"
[trigger_webhook_template]: "/docs/oncall/ -> /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks#using-trigger-template-field"
{{% /docs/reference %}}

13
docs/sources/configure/integrations/references/amazon-sns/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/amazon-sns
- add-amazon-sns/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/amazon-sns
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Amazon SNS integration for Grafana OnCall
@ -27,7 +33,7 @@ aliases:
The Amazon SNS integration for Grafana OnCall handles ticket events sent from Amazon SNS 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
> You must have the [role of Admin](ref:user-and-team-management) to be able to create integrations
in Grafana OnCall.
## Configuring Grafana OnCall to Receive Alerts from Amazon SNS
@ -44,8 +50,3 @@ in Grafana OnCall.
2. Open this topic, then create a new subscription
3. Choose the protocol HTTPS
4. Add the **OnCall Integration URL** to the Amazon SNS Endpoint
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

21
docs/sources/configure/integrations/references/appdynamics/index.md
View file

@ -18,6 +18,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/appdynamics
- add-appdynamics/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/appdynamics
refs:
complete-the-integration-configuration:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/integration-management/#customize-the-integration
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/integration-management/#customize-the-integration
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# AppDynamics integration for Grafana OnCall
@ -112,12 +123,4 @@ Grafana OnCall provides grouping and auto-resolve logic for the AppDynamics inte
## Complete the Integration Configuration
Complete configuration by setting routes, templates, maintenances, etc. Read more in
[this section][complete-the-integration-configuration]
{{% docs/reference %}}
[complete-the-integration-configuration]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/integration-management#customize-the-integration"
[complete-the-integration-configuration]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/integration-management#customize-the-integration"
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}
[this section](ref:complete-the-integration-configuration)

11
docs/sources/configure/integrations/references/datadog/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/datadog
- add-datadog/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/datadog
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Datadog integration for Grafana OnCall
@ -45,8 +51,3 @@ The integration provides grouping, auto-acknowledge and auto-resolve logic via c
5. Navigate to the Events page from the sidebar to send the test alert
6. Type @webhook-grafana-oncall-alerts test alert
7. Click the post button
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

13
docs/sources/configure/integrations/references/elastalert/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/elastalert
- add-elastalert/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/elastalert
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# ElastAlert integration for Grafana OnCall
@ -22,7 +28,7 @@ aliases:
The ElastAlert integration for Grafana OnCall handles ticket events sent from ElastAlert 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.
> You must have the [role of Admin](ref:user-and-team-management) to be able to create integrations in Grafana OnCall.
## Configuring Grafana OnCall to Receive Alerts from ElastAlert
@ -78,8 +84,3 @@ Add the following rule to ElastAlert
alert_text: elastalert is still running
alert_text_type: alert_text_only
```
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/fabric/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/fabric
- add-fabric/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/fabric
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Fabric integration for Grafana OnCall
@ -44,8 +50,3 @@ The integration provides grouping, auto-acknowledge and auto-resolve logic via c
4. Enter URL: **OnCall Integration URL**
5. Click Verify
6. Choose "SEND IMPACT CHANGE ALERTS" and "ALSO SEND NON-FATAL ALERTS"
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

23
docs/sources/configure/integrations/references/grafana-alerting/index.md
View file

@ -15,6 +15,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/grafana-alerting
- add-grafana-alerting/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/grafana-alerting
refs:
trigger-webhook-template:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
data-webhook-template:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
---
# Grafana Alerting integration for Grafana OnCall
@ -129,13 +140,5 @@ You can read more about AlertManager Data model [here](https://prometheus.io/doc
1. Send a new demo alert to the migrated integration.
2. Adjust routes to the new shape of payload. You can use payload of the demo alert from previous step as an example.
3. If outgoing webhooks utilized the alerts payload from the migrated integration in the [trigger][trigger-webhook-template]
or [data][data-webhook-template] template it's needed to adjust them as well.
{{% docs/reference %}}
[data-webhook-template]: "/docs/oncall/ -> /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks"
[data-webhook_template]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
[trigger-webhook-template]: "/docs/oncall/ -> /docs/oncall/<ONCALL VERSION>/configure/integrations/outgoing-webhooks"
[trigger-webhook-template]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
{{% /docs/reference %}}
3. If outgoing webhooks utilized the alerts payload from the migrated integration in the [trigger](ref:trigger-webhook-template)
or [data](ref:data-webhook-template) template it's needed to adjust them as well.

21
docs/sources/configure/integrations/references/inbound-email/index.md
View file

@ -15,6 +15,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/inbound-email
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/inbound-email
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email
refs:
inbound-email-setup:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/set-up/open-source/#inbound-email-setup
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source/#inbound-email-setup
jinja2-templating:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
---
# Inbound Email integration for Grafana OnCall
@ -36,7 +47,7 @@ You must have an Admin role to create integrations in Grafana OnCall.
## Grouping and auto-resolve
Alert groups will be grouped by email subject and auto-resolved if the email message text equals "OK".
This behaviour can be modified via [custom templates][jinja2-templating].
This behaviour can be modified via [custom templates](ref:jinja2-templating).
Alerts from Inbound Email integration have the following payload:
@ -47,11 +58,3 @@ Alerts from Inbound Email integration have the following payload:
"sender": "<your_email_sender_address>"
}
```
{{% docs/reference %}}
[jinja2-templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[jinja2-templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
[Inbound Email Setup]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/set-up/open-source#inbound-email-setup"
[Inbound Email Setup]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source#inbound-email-setup"
{{% /docs/reference %}}

23
docs/sources/configure/integrations/references/jira/index.md
View file

@ -17,6 +17,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/jira
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/jira
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/jira
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
outgoing-webhooks:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
---
# Jira integration for Grafana OnCall
@ -61,7 +72,7 @@ To customize this behaviour, consider modifying alert templates in integration s
## Configuring Grafana OnCall to send data to Jira
Grafana OnCall can automatically create and resolve issues in Jira via [outgoing webhooks][outgoing-webhooks].
Grafana OnCall can automatically create and resolve issues in Jira via [outgoing webhooks](ref:outgoing-webhooks).
This guide provides example webhook configurations for common use cases, as well as information on how to set up a user in Jira to be used by Grafana OnCall.
### Prerequisites
@ -175,14 +186,6 @@ to get the list of available transitions.
The examples above describe how to create outgoing webhooks in Grafana OnCall that will allow to automatically create and resolve issues in Jira.
Consider modifying example templates to fit your use case (e.g. to include more information on alert groups).
Refer to [outgoing webhooks documentation][outgoing-webhooks] for more information on available template variables and webhook configuration.
Refer to [outgoing webhooks documentation](ref:outgoing-webhooks) for more information on available template variables and webhook configuration.
For more information on Jira REST API, refer to [Jira REST API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues).
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
[outgoing-webhooks]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[outgoing-webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/kapacitor/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/kapacitor
- add-kapacitor/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/kapacitor
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Kapacitor integration for Grafana OnCall
@ -61,8 +67,3 @@ To send an alert from Kapacitor, you can follow these steps:
When the condition defined in the TICKscript is met, Kapacitor will trigger the alert and send
a POST request to the specified webhook URL with the necessary information. Make sure your webhook
endpoint is configured to receive and process the incoming alerts from Kapacitor.
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

53
docs/sources/configure/integrations/references/manual/index.md
View file

@ -15,13 +15,39 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/manual
- /docs/oncall/latest/integrations/manual/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/manual
refs:
integrations:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/
notify:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/notify/#configure-user-notification-policies
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/#configure-user-notification-policies
manage-teams:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/#manage-teams-in-grafana-oncall
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/#manage-teams-in-grafana-oncall
slack-escalate:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/notify/slack/#slack-escalate-command
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/slack/#slack-escalate-command
escalation-chains-and-routes:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes/
---
# Page people manually
Grafana OnCall relies on automated and pre-configured workflows, such as [integrations][integrations],
[routes, and escalation chains][escalation-chains-and-routes] to handle most of the incident response process.
However, sometimes you might need to page a [team][manage-teams] or request assistance from specific people that
Grafana OnCall relies on automated and pre-configured workflows, such as [integrations](ref:integrations),
[routes, and escalation chains](ref:escalation-chains-and-routes) to handle most of the incident response process.
However, sometimes you might need to page a [team](ref:manage-teams) or request assistance from specific people that
are not part of these pre-defined rules.
For such ad-hoc scenarios, Grafana OnCall allows you to create an alert group, input necessary information, and decide
@ -38,9 +64,9 @@ From there, you can configure the alert group to notify a particular team and op
see teams that have a "contactable" direct paging integration (ie. it has an escalation chain assigned to it, or has
at least one Chatops integration connected to send notifications to).
- **Users**: Include more users to the alert group. For each additional user, you can select a notification policy:
[default or important][notify].
[default or important](ref:notify).
> The same feature is also available as [**/escalate**][slack-escalate] Slack command.
> The same feature is also available as [**/escalate**](ref:slack-escalate) Slack command.
## Add users to an existing alert group
@ -73,20 +99,3 @@ Navigate to the **Integrations** page and find the "Direct paging" integration f
integration's detail page, you can customize its settings, link it to an escalation chain, and configure associated
ChatOps channels. To confirm that the integration is functioning as intended, [create a new alert group](#page-a-team)
and select the same team for a test run.
{{% docs/reference %}}
[integrations]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations"
[integrations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations"
[escalation-chains-and-routes]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes"
[escalation-chains-and-routes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes"
[notify]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/notify#configure-user-notification-policies"
[notify]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify#configure-user-notification-policies"
[slack-escalate]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/notify/slack#slack-escalate-command"
[slack-escalate]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/slack#slack-escalate-command"
[manage-teams]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management#manage-teams-in-grafana-oncall"
[manage-teams]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management#manage-teams-in-grafana-oncall"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/newrelic/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/newrelic
- add-newrelic/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/newrelic
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# New Relic integration for Grafana OnCall
@ -43,8 +49,3 @@ The integration provides grouping, auto-acknowledge and auto-resolve logic via c
3. Create "Webhook" notification channel.
4. Set the following URL: **OnCall Integration URL**
5. Check "Payload type" is JSON.
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/pingdom/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/pingdom
- add-pingdom/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/pingdom
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Pingdom integration for Grafana OnCall
@ -44,8 +50,3 @@ The integration provides grouping, auto-acknowledge and auto-resolve logic via c
4. Go to "Reports" -> "Uptime" -> "Edit Check".
5. Select `Grafana OnCall` integration in the bottom.
6. Click "Modify Check" to save.
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/prtg/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/prtg
- add-prtg/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/prtg
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# PRTG integration for Grafana OnCall
@ -120,8 +126,3 @@ Catch
}
```
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/sentry/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/sentry
- add-sentry/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/sentry
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Sentry integration for Grafana OnCall
@ -63,8 +69,3 @@ level, event frequency, or specific tags.
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/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

21
docs/sources/configure/integrations/references/servicenow/index.md
View file

@ -18,6 +18,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/servicenow
- /docs/oncall/latest/integrations/servicenow/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/servicenow
refs:
alert-group-labels:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/#alert-group-labels
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/#alert-group-labels
outgoing-webhook-templates:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/#outgoing-webhook-templates
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/#outgoing-webhook-templates
---
# ServiceNow integration for Grafana OnCall
@ -141,12 +152,4 @@ Example: Set the "urgency" field based on alert group labels, add the provided J
}
```
For more information, refer to [Outgoing webhook templates] and [Alert group labels].
{{% docs/reference %}}
[Alert group labels]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels#alert-group-labels"
[Alert group labels]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels#alert-group-labels"
[Outgoing webhook templates]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks#outgoing-webhook-templates"
[Outgoing webhook templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks#outgoing-webhook-templates"
{{% /docs/reference %}}
For more information, refer to [Outgoing webhook templates](ref:outgoing-webhook-templates) and [Alert group labels](ref:alert-group-labels).

11
docs/sources/configure/integrations/references/stackdriver/index.md
View file

@ -18,6 +18,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/integrations/stackdriver
- /docs/oncall/latest/integrations/stackdriver/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/stackdriver
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Stackdriver integration for Grafana OnCall
@ -41,8 +47,3 @@ The integration provides grouping, auto-acknowledge and auto-resolve logic via c
1. Create a notification channel in Stackdriver by navigating to Workspace Settings -> WEBHOOKS -> Add Webhook **OnCall Integration URL**
2. Create and alert in Stackdriver by navigating to Alerting -> Policies -> Add Policy -> Choose Notification Channel using the channel set up in step 1
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

11
docs/sources/configure/integrations/references/uptimerobot/index.md
View file

@ -19,6 +19,12 @@ aliases:
- /docs/oncall/latest/integrations/available-integrations/configure-uptimerobot
- add-uptimerobot/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/uptimerobot
refs:
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
@ -71,8 +77,3 @@ The integration provides grouping, auto-acknowledge and auto-resolve logic via c
1. Set URL to <http://devnull.oncall.io> or any other non-existent domain
1. Click Checkbox next to OnCall Alert Contact (created in the previous step)
1. Click Create Monitor
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}

13
docs/sources/configure/integrations/references/webhook/index.md
View file

@ -19,6 +19,12 @@ aliases:
- /docs/oncall/latest/integrations/webhook/
- /add-webhook-integration/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/webhook
refs:
jinja2-templating:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
---
# Inbound Webhook integrations for Grafana OnCall
@ -68,9 +74,4 @@ https://a-prod-us-central-0.grafana.net/integrations/v1/formatted_webhook/m12xmI
```
To learn how to use custom alert templates for formatted webhooks, see
[Configure alerts templates][jinja2-templating].
{{% docs/reference %}}
[jinja2-templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[jinja2-templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
{{% /docs/reference %}}
[Configure alerts templates](ref:jinja2-templating).

23
docs/sources/configure/integrations/references/zendesk/index.md
View file

@ -19,6 +19,17 @@ aliases:
- /docs/oncall/latest/integrations/zendesk/
- /add-zendesk/
- ../integrations/ # /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/zendesk
refs:
outgoing-webhooks:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
---
# Zendesk integration for Grafana OnCall
@ -74,7 +85,7 @@ To customize this behaviour, consider modifying alert templates in integration s
## Configuring Grafana OnCall to send data to Zendesk
Grafana OnCall can automatically create and resolve tickets in Zendesk via [outgoing webhooks][outgoing-webhooks].
Grafana OnCall can automatically create and resolve tickets in Zendesk via [outgoing webhooks](ref:outgoing-webhooks).
This guide provides example webhook configurations for common use cases, as well as information on how to set up a user in Zendesk to be used by Grafana OnCall.
### Prerequisites
@ -165,14 +176,6 @@ Use the following JSON template as webhook data:
The examples above describe how to create outgoing webhooks in Grafana OnCall that will allow to automatically create and resolve tickets in Zendesk.
Consider modifying example templates to fit your use case (e.g. to include more information on alert groups).
Refer to [outgoing webhooks documentation][outgoing-webhooks] for more information on available template variables and webhook configuration.
Refer to [outgoing webhooks documentation](ref:outgoing-webhooks) for more information on available template variables and webhook configuration.
For more information on Zendesk API, refer to [Zendesk API documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/).
{{% docs/reference %}}
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
[outgoing-webhooks]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[outgoing-webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
{{% /docs/reference %}}

13
docs/sources/configure/jinja2-templating/_index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
- /docs/grafana-cloud/alerting-and-irm/oncall/jinja2-templating/
- ../jinja2-templating/ # /docs/oncall/<ONCALL_VERSION>/jinja2-templating/
refs:
webhook-integration:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/webhook/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/webhook/
---
@ -134,7 +140,7 @@ As a best practice, add Playbooks, useful links, or checklists to the alert mess
Integration templates are applied to alerts that originated from a specific integration to define alert rendering and behavior.
Grafana OnCall provides pre-configured default Jinja templates for supported integrations.
For any monitoring system not available in the Grafana OnCall integrations list, configure a [Webhook integration][webhook-integration] and configure your
For any monitoring system not available in the Grafana OnCall integrations list, configure a [Webhook integration](ref:webhook-integration) and configure your
templates as needed.
## Edit templates
@ -150,8 +156,3 @@ The template editor will open with three columns: example alert payload, the tem
1. For messenger templates, click **Save and open Alert Group in ChatOps** to see how the alert renders in the messenger.
Note: The alert group must exist in the messenger to preview the template.
1. Click **Save** to save the template.
{{% docs/reference %}}
[webhook-integration]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/webhook"
[webhook-integration]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/webhook"
{{% /docs/reference %}}

13
docs/sources/configure/jinja2-templating/advanced-templates/index.md
View file

@ -15,6 +15,12 @@ canonical: https://grafana.com/docs/oncall/latest/configure/jinja2-templating/ad
aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/advanced-templates/
- ../jinja2-templating/advanced-templates/ # /docs/oncall/<ONCALL_VERSION>/jinja2-templating/advanced-templates/
refs:
map-payloads-to-oncall-fields:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#map-payloads-to-oncall-fields
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#map-payloads-to-oncall-fields
---
# Advanced template configuration
@ -27,7 +33,7 @@ Jinja2 offers a range of functionalities, including loops, conditions, and funct
Every alert from a monitoring system is received in a key/value format, which Grafana OnCall maps to specific fields, such as:
`title`, `message`, `image`, `grouping`, and `auto-resolve`.
To learn more about mapping your alert payload to Grafana OnCall fields, refer to [map payloads to OnCall fields][map-payloads-to-oncall-fields].
To learn more about mapping your alert payload to Grafana OnCall fields, refer to [map payloads to OnCall fields](ref:map-payloads-to-oncall-fields).
## Loops
@ -93,8 +99,3 @@ Grafana OnCall enhances Jinja with additional functions:
- Usage example: `{{ payload.data | b64decode }}`
- `parse_json`:Parses a JSON string to an object
- Usage example: `{{ (payload.data | b64decode | parse_json).name }}`
{{% docs/reference %}}
[map-payloads-to-oncall-fields]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating#map-payloads-to-oncall-fields"
[map-payloads-to-oncall-fields]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating#map-payloads-to-oncall-fields"
{{% /docs/reference %}}

13
docs/sources/intro/_index.md
View file

@ -13,6 +13,12 @@ keywords:
canonical: https://grafana.com/docs/oncall/latest/intro/
aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/intro/
refs:
get-started:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/set-up/get-started/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/set-up/get-started/
---
# Introduction to Grafana OnCall
@ -41,11 +47,6 @@ alert details. Additionally, enhance flexibility by incorporating regular expres
## Next steps
To get started with Grafana OnCall, refer to [Get started][]
To get started with Grafana OnCall, refer to [Get started](ref:get-started)
To learn more about what you can do with Grafana OnCall, visit the [Grafana Cloud IRM product page](https://grafana.com/products/cloud/irm/).
{{% docs/reference %}}
[Get started]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/set-up/get-started"
[Get started]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/set-up/get-started"
{{% /docs/reference %}}

11
docs/sources/manage/insights-and-metrics/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/insights-and-metrics/
- /docs/grafana-cloud/alerting-and-irm/oncall/insights-and-metrics/
- ../insights-and-metrics/ # /docs/oncall/<ONCALL_VERSION>/insights-and-metrics/
refs:
grafana-oncall-api:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/oncall-api-reference/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/
---
# Insight Logs and Metrics
@ -295,8 +301,3 @@ Actions performed with slack chatops integration:
```logql
{instance_type="oncall"} | logfmt | __error__=`` | action_type = `chat_ops` and chat_ops_type=`slack`
```
{{% docs/reference %}}
[Grafana OnCall API]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/oncall-api-reference"
[Grafana OnCall API]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference"
{{% /docs/reference %}}

13
docs/sources/manage/mobile-app/alert-groups-feed/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app/alert-groups-feed/
- /docs/grafana-cloud/alerting-and-irm/oncall/mobile-app/alert-groups-feed/
- ../../mobile-app/alert-groups-feed/ # /docs/oncall/<ONCALL_VERSION>/mobile-app/alert-groups-feed/
refs:
manage-users-and-teams-for-grafana-oncall:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/#user-roles-and-permissions
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/#user-roles-and-permissions
---
# Alert Groups feed
@ -36,13 +42,8 @@ Additionally, you can take action on the alert group directly from this page. Yo
> **Note:** You need to have sufficient permission to take action on the alert group.
> To learn more about Grafana OnCall user roles and permission,
> refer to [Manage users and teams for Grafana OnCall][].
> refer to [Manage users and teams for Grafana OnCall](ref:manage-users-and-teams-for-grafana-oncall).
<img src="/static/img/oncall/mobile-app-alertgroups2.png" width="300px">
<img src="/static/img/oncall/mobile-app-alertgroup2.png" width="300px">
<img src="/static/img/oncall/mobile-app-timeline.png" width="300px">
{{% docs/reference %}}
[Manage users and teams for Grafana OnCall]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management#user-roles-and-permissions"
[Manage users and teams for Grafana OnCall]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management#user-roles-and-permissions"
{{% /docs/reference %}}

13
docs/sources/manage/mobile-app/push-notifications/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app/push-notifications/
- /docs/grafana-cloud/alerting-and-irm/oncall/mobile-app/push-notifications/
- ../../mobile-app/push-notifications/ # /docs/oncall/<ONCALL_VERSION>/mobile-app/push-notifications/
refs:
shift-swap-requests:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/#shift-swap-requests
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/#shift-swap-requests
---
# Push notifications
@ -24,7 +30,7 @@ There are four types of push notifications for the mobile app:
- **Mobile push** - Sends a typical push notification to your mobile device. Intended for all types of alerts.
- **Mobile push important** - Sends a push notification for important alerts. We recommend (and default) to louder notifications.
- **On-call shift notifications** - Sends announcements for upcoming shifts (optional).
- **Shift swap notifications** - Sends announcements for [Shift swap requests][] (optional).
- **Shift swap notifications** - Sends announcements for [Shift swap requests](ref:shift-swap-requests) (optional).
## Add mobile app to notification policies
@ -102,8 +108,3 @@ informing all users in the on-call schedule (except the initiator) about it.
To enable or disable shift swap notifications and their follow-ups, use the **info notifications** section
in the **Push notifications** settings.
{{% docs/reference %}}
[Shift swap requests]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules#shift-swap-requests"
[Shift swap requests]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules#shift-swap-requests"
{{% /docs/reference %}}

13
docs/sources/manage/notify/_index.md
View file

@ -16,13 +16,19 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/
- /docs/grafana-cloud/alerting-and-irm/oncall/notify/
- ../notify/ # /docs/oncall/<ONCALL_VERSION>/notify/
refs:
outgoing-webhooks:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
---
# Notifications
Grafana OnCall directly supports the export of alert notifications to some popular messaging applications like Slack and
Telegram.
You can use [Outgoing webhooks][outgoing-webhooks] for applications that aren't directly supported.
You can use [Outgoing webhooks](ref:outgoing-webhooks) for applications that aren't directly supported.
To configure supported messaging apps, refer to the following topics:
@ -52,8 +58,3 @@ To configure a users notification policy:
1. Click **Add notification step** and use the dropdowns to specify the notification method and frequency. Notification steps will be followed in the order they
are listed.
{{% docs/reference %}}
[outgoing-webhooks]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[outgoing-webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
{{% /docs/reference %}}

34
docs/sources/manage/notify/phone-calls-sms/index.md
View file

@ -15,11 +15,28 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/notify/phone-calls-sms/
- ../../notify/phone-sms/ # /docs/oncall/<ONCALL_VERSION>/notify/phone-sms/
- ../../notify/phone-calls-sms/ # /docs/oncall/<ONCALL_VERSION>/notify/phone-calls-sms/
refs:
incoming-call-routing:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/live-call-routing/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/live-call-routing/
mobile-app:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/mobile-app/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app/
grafana-oss-cloud-setup:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/set-up/open-source/#grafana-oss-cloud-setup
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source/#grafana-oss-cloud-setup
---
# Phone calls and SMS notifications
Grafana OnCall Cloud includes SMS and Phone notifications, OSS users can use the [Grafana OSS-Cloud Setup][] as a relay or configure other providers like Twilio.
Grafana OnCall Cloud includes SMS and Phone notifications,
OSS users can use the [Grafana OSS-Cloud Setup](ref:grafana-oss-cloud-setup) as a relay or configure other providers like Twilio.
## Are there additional costs for outgoing calls/sms?
@ -31,7 +48,7 @@ There are no specific limits, but we reserve the right to stop sending sms/calls
## Route incoming calls to the engineer who is on-call
See our [docs][Incoming Call Routing], and [blog post](https://grafana.com/blog/2024/06/10/a-guide-to-grafana-oncall-sms-and-call-routing/),
See our [docs](ref:incoming-call-routing), and [blog post](https://grafana.com/blog/2024/06/10/a-guide-to-grafana-oncall-sms-and-call-routing/),
on Advanced SMS & call routing configuration, for a guide on how to configure incoming call routing.
## Is there a list of pre-defined phone numbers?
@ -43,15 +60,4 @@ In order to learn the phone number used by OnCall, make a test call at the "Phon
There are cases when OnCall is not able to make phone calls or send SMS to certain regions or specific phone numbers.
We're working hard to fix such cases, but kindly asking to test your personal notification chain to make sure OnCall
is able to notify you. Also we suggest to back up Phone Calls and SMS with other notification methods such as
[Mobile app][].
{{% docs/reference %}}
[Mobile app]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/mobile-app"
[Mobile app]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app"
[Grafana OSS-Cloud Setup]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/set-up/open-source#grafana-oss-cloud-setup"
[Grafana OSS-Cloud Setup]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source#grafana-oss-cloud-setup"
[Incoming Call Routing]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/live-call-routing"
[Incoming Call Routing]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/live-call-routing"
{{% /docs/reference %}}
[Mobile app](ref:mobile-app).

23
docs/sources/manage/notify/slack/index.md
View file

@ -15,6 +15,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/notify/slack/
- ../../chat-options/configure-slack/ # /docs/oncall/<ONCALL_VERSION>/chat-options/configure-slack/
- ../../notify/slack/ # /docs/oncall/<ONCALL_VERSION>/notify/slack/
refs:
page-people-manually:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/manual/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/manual/
slack-setup:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/set-up/open-source/#slack-setup
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source/#slack-setup
---
# Slack integration for Grafana OnCall
@ -31,7 +42,7 @@ can take directly from Slack, including acknowledge, resolve, add resolution not
To install the Slack integration, you must have Admin permissions in your Grafana instance as well as the Slack workspace
that you’d like to integrate with.
For Open Source Grafana OnCall Slack installation guidance, refer to [Slack setup][].
For Open Source Grafana OnCall Slack installation guidance, refer to [Slack setup](ref:slack-setup).
## Install Slack integration for Grafana OnCall
@ -175,7 +186,7 @@ Use `/escalate` to page a team (and additional responders) directly from Slack.
It's also possible to page additional responders for an existing alert group. To do so, use the "Responders" button
in the alert group message.
To manually page people, refer to [Page people manually][].
To manually page people, refer to [Page people manually](ref:page-people-manually).
### Slack `/oncall` command
@ -197,11 +208,3 @@ Use message shortcuts to add resolution notes directly from Slack. Message short
1. Hover over the message and select **More actions** from the menu options.
1. Select **Add as resolution note**.
1. The Grafana OnCall app will react to the message in Slack with the memo emoji and add the message to the alert group timeline.
{{% docs/reference %}}
[Slack setup]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/set-up/open-source#slack-setup"
[Slack setup]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source#slack-setup"
[Page people manually]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/manual"
[Page people manually]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/manual"
{{% /docs/reference %}}

43
docs/sources/manage/on-call-schedules/_index.md
View file

@ -15,6 +15,27 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/
- /docs/grafana-cloud/alerting-and-irm/oncall/on-call-schedules/
- ../on-call-schedules # /docs/oncall/<ONCALL_VERSION>/on-call-schedules/
refs:
web-based-on-call-schedules:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/web-schedule/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/web-schedule/
import-on-call-schedules:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/ical-schedules/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/ical-schedules/
manage-users-and-teams-for-grafana-oncall:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
shift-swap-requests:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/shift-swaps/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/shift-swaps/
---
## Before you begin
@ -22,14 +43,14 @@ aliases:
- Users with Admin or Editor roles can create, edit and delete schedules.
- Users with Viewer role cannot receive alert notifications, therefore, cannot be on-call.
For more information about permissions, refer to [Manage users and teams for Grafana OnCall][]
For more information about permissions, refer to [Manage users and teams for Grafana OnCall](ref:manage-users-and-teams-for-grafana-oncall)
### Web-based schedule
Configure and manage on-call schedules directly in the Grafana OnCall plugin. Easily configure and preview rotations,
see teammates' time zones, and add overrides.
For more information, refer to [Web-based on-call schedules][].
For more information, refer to [Web-based on-call schedules](ref:web-based-on-call-schedules).
### iCal import
@ -37,7 +58,7 @@ Use any calendar service that uses the iCal format to manage and customize on-ca
shifts from your calendar app to Grafana OnCall for widely accessible scheduling. iCal imports appear in Grafana
OnCall as read-only schedules but can be leveraged similarly to a web-based schedule.
For more information, refer top [Import on-call schedules][].
For more information, refer top [Import on-call schedules](ref:import-on-call-schedules).
### Terraform
@ -65,18 +86,4 @@ Sometimes you may need someone to cover your scheduled on-call shifts (e.g. you
for a couple of weeks). You can then create a shift swap request, which will let your teammates
know about this as well as allowing them to volunteer and take your affected shifts for that period.
For more information, refer to [Shift swap requests][].
{{% docs/reference %}}
[Import on-call schedules]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/ical-schedules"
[Import on-call schedules]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/ical-schedules"
[Manage users and teams for Grafana OnCall]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/"
[Manage users and teams for Grafana OnCall]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
[Web-based on-call schedules]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/web-schedule"
[Web-based on-call schedules]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/web-schedule"
[Shift swap requests]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/shift-swaps"
[Shift swap requests]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/shift-swaps"
{{% /docs/reference %}}
For more information, refer to [Shift swap requests](ref:shift-swap-requests).

13
docs/sources/manage/on-call-schedules/api-terraform-schedule/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/api-terraform-schedules/
- /docs/grafana-cloud/alerting-and-irm/oncall/on-call-schedules/api-terraform-schedules/
- ../../on-call-schedules/api-terraform-schedule/ # /docs/oncall/<ONCALL_VERSION>/on-call-schedules/api-terraform-schedule/
refs:
oncall-api:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/oncall-api-reference/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/
---
# API & Terraform schedules
@ -24,9 +30,4 @@ teams in the org, we suggest considering storing schedules as code.
- [Get started with Grafana OnCall and Terraform (blogpost)](https://grafana.com/blog/2022/08/29/get-started-with-grafana-oncall-and-terraform/)
- [Grafana Terraform provider reference (OnCall resources are managed using this provider)](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/oncall_schedule)
- [OnCall API][]
{{% docs/reference %}}
[OnCall API]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/oncall-api-reference"
[OnCall API]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference"
{{% /docs/reference %}}
- [OnCall API](ref:oncall-api)

17
docs/sources/manage/on-call-schedules/ical-schedules/index.md
View file

@ -15,6 +15,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/ical-schedules/
- /docs/grafana-cloud/alerting-and-irm/oncall/on-call-schedules/ical-schedules/
- ../../on-call-schedules/ical-schedules/ # /docs/oncall/<ONCALL_VERSION>/on-call-schedules/ical-schedules/
refs:
web-based-on-call-schedules:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/web-schedule/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/web-schedule/
---
# Import on-call schedules
@ -26,7 +32,7 @@ OnCall as read-only schedules but can be leveraged similarly to a web-based sche
> Unfortunately there is a known limitation with Google Calendar import and export.
> Google may take up to 24h to import OnCall's calendar (OnCall -> Google) and sometimes our customers report delay in
> exporting (Google Calendar -> OnCall). If actual calendar is critical for you, we suggest checking
> [Web-based on-call schedules][]
> [Web-based on-call schedules](ref:web-based-on-call-schedules)
## Before you begin
@ -99,14 +105,9 @@ event duplication.
### Create overlapping schedules (optional)
If you create schedules that overlap, you can prioritize a schedule by adding a level marker to the calendar event
title. You can prioritize schedule overlaps using [L0] - [L9] prioritization. Overlapping calendar events that do not
title. You can prioritize schedule overlaps using `[L0] - [L9]` prioritization. Overlapping calendar events that do not
contain a level marker result in all overlapping users receiving notifications.
For example, users AliceGrafana and BobGrafana have overlapping schedules but BobGrafana is the intended primary
contact. The calendar events titles would be `[L1] BobGrafana` and `[L0] AliceGrafana` - In this case AliceGrafana
maintains the default [L0] status, and would not receive notifications during the overlapping time with BobGrafana.
{{% docs/reference %}}
[Web-based on-call schedules]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/web-schedule"
[Web-based on-call schedules]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/web-schedule"
{{% /docs/reference %}}
maintains the default `[L0]` status, and would not receive notifications during the overlapping time with BobGrafana.

23
docs/sources/manage/on-call-schedules/shift-swaps/index.md
View file

@ -15,6 +15,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/shift-swaps/
- /docs/grafana-cloud/alerting-and-irm/oncall/on-call-schedules/shift-swaps/
- ../../on-call-schedules/shift-swaps/ # /docs/oncall/<ONCALL_VERSION>/on-call-schedules/shift-swaps/
refs:
mobile-push-notification:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/mobile-app/push-notifications/#shift-swap-notifications
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app/push-notifications/#shift-swap-notifications
rbac:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/#role-based-access-control-rbac
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/manage/user-and-team-management/#role-based-access-control-rbac
---
# Shift swaps
@ -46,7 +57,7 @@ of a schedule, or clicking the button shown when hovering on a particular shift
> consider creating a higher level layer rotation with the desired updates.
Upon submitting the request, a Slack notification will be sent to the channel associated to the correspondent
schedule, if there is one. A [mobile push notification][] will be sent to team members who
schedule, if there is one. A [mobile push notification](ref:mobile-push-notification) will be sent to team members who
participate in the schedule and have the notifications enabled.
<img src="/static/img/oncall/swap-slack-notification-3.png">
@ -70,7 +81,7 @@ The follow-up notifications will be sent at the following intervals before the s
You can delete the swap request at any time. If the swap has been taken, it will automatically be undone upon removal.
> **Note**: if [RBAC][] is enabled, a user is required to have the `SCHEDULES_WRITE` permission to create,
> **Note**: if [RBAC](ref:rbac) is enabled, a user is required to have the `SCHEDULES_WRITE` permission to create,
> update, take or delete a swap request. `SCHEDULES_READ` will be enough to get details about existing requests.
## Check existing swap requests
@ -123,11 +134,3 @@ request, we will not attempt to regenerate a new shift swap request.
application.
2. Create a Client ID for your OAuth2 app and set the `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY` and `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`
environment variables accordingly.
{{% docs/reference %}}
[mobile push notification]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/mobile-app/push-notifications#shift-swap-notifications"
[mobile push notification]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app/push-notifications#shift-swap-notifications"
[RBAC]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management#role-based-access-control-rbac"
[RBAC]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/manage/user-and-team-management#role-based-access-control-rbac"
{{% /docs/reference %}}

13
docs/sources/manage/on-call-schedules/web-schedule/index.md
View file

@ -13,6 +13,12 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/web-schedule/
- /docs/grafana-cloud/alerting-and-irm/oncall/on-call-schedules/web-schedule/
- ../../on-call-schedules/web-schedule/ # /docs/oncall/<ONCALL_VERSION>/on-call-schedules/web-schedule/
refs:
shift-swaps:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/shift-swaps/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/shift-swaps/
---
# Web-based on-call schedules
@ -55,7 +61,7 @@ on this calendar will take precedence over the rotations calendar.
## Schedule quality report
The schedule view features a quality report that provides a score for your schedule based on rotations, overrides and [shift swaps][].
The schedule view features a quality report that provides a score for your schedule based on rotations, overrides and [shift swaps](ref:shift-swaps).
It's calculated based on these key factors:
- Gaps (amount of time when no one is on-call)
@ -89,8 +95,3 @@ A perfectly balanced schedule is considered ideal, so reducing this number will
Export on-call schedules from Grafana OnCall to your preferred calendar app with a one-time secret iCal URL. The
schedule export allows you to view on-call shifts alongside the rest of your schedule.
{{% docs/reference %}}
[shift swaps]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/shift-swaps"
[shift swaps]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/shift-swaps"
{{% /docs/reference %}}

13
docs/sources/oncall-api-reference/integrations.md
View file

@ -2,6 +2,12 @@
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/integrations/
title: Integrations HTTP API
weight: 500
refs:
alertmanager:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/alertmanager/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/alertmanager/
---
# Integrations HTTP API
@ -75,7 +81,7 @@ The above command returns JSON structured in the following way:
```
Integrations are sources of alerts and alert groups for Grafana OnCall.
For example, to learn how to integrate Grafana OnCall with Alertmanager refer to [Alertmanager][].
For example, to learn how to integrate Grafana OnCall with Alertmanager refer to [Alertmanager](ref:alertmanager).
**HTTP request**
@ -318,8 +324,3 @@ curl "{{API_URL}}/api/v1/integrations/CFRPV98RPR1U8/" \
**HTTP request**
`DELETE {{API_URL}}/api/v1/integrations/<INTEGRATION_ID>/`
{{% docs/reference %}}
[Alertmanager]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/alertmanager"
[Alertmanager]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/alertmanager"
{{% /docs/reference %}}

23
docs/sources/oncall-api-reference/outgoing_webhooks.md
View file

@ -2,6 +2,17 @@
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/
title: Outgoing webhooks HTTP API
weight: 700
refs:
outgoing-webhooks:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
event-types:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/#event-types
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/#event-types
---
# Outgoing webhooks
@ -10,7 +21,7 @@ weight: 700
> endpoint remains available and is compatible with previous callers but under the hood it will interact with the
> new webhooks objects. It is recommended to use the /webhooks endpoint going forward which has more features.
For more details about specific fields of a webhook, refer to [Outgoing webhooks][].
For more details about specific fields of a webhook, refer to [Outgoing webhooks](ref:outgoing-webhooks).
## List webhooks
@ -105,7 +116,7 @@ curl "{{API_URL}}/api/v1/webhooks/" \
### Trigger Types
For more detail, refer to [Event types][].
For more detail, refer to [Event types](ref:event-types).
- `escalation`
- `alert group created`
@ -233,11 +244,3 @@ The above command returns JSON structured in the following way:
"total_pages": 1
}
```
{{% docs/reference %}}
[Outgoing webhooks]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks"
[Outgoing webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks"
[Event types]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks#event-types"
[Event types]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks#event-types"
{{% /docs/reference %}}

107
docs/sources/set-up/get-started/index.md
View file

@ -16,6 +16,57 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall//get-started/
- ../getting-started/ # /docs/oncall/<ONCALL_VERSION>/getting-started/
- ../get-started/ # /docs/oncall/<ONCALL_VERSION>/get-started/
refs:
routes:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes/#routes
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes/#routes
escalation-chains-and-routes:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes/
escalation-chains:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes/#escalation-chains
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes/#escalation-chains
slack-integration-for-grafana-oncall:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/notify/slack/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/slack/
user-and-team-management:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management/
install-grafana-oncall-oss:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/set-up/open-source/#install-grafana-oncall-oss
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source/#install-grafana-oncall-oss
integrations:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/
jinja2-templating:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/
notify-people:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/notify/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/
on-call-schedules:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules/
---
# Get started with Grafana OnCall
@ -46,13 +97,13 @@ OnCall is available in Grafana Cloud automatically:
3. Choose **Alerts and IRM** from the left menu
4. Click **OnCall** to access Grafana OnCall
Otherwise, to install Grafana OnCall, refer to [Install Grafana OnCall OSS][].
Otherwise, to install Grafana OnCall, refer to [Install Grafana OnCall OSS](ref:install-grafana-oncall-oss).
## How to configure Grafana OnCall
* Users with [Admin role][user-and-team-management] can configure Alert rules (Integrations, Routes, etc)
* Users with [Admin role](ref:user-and-team-management) can configure Alert rules (Integrations, Routes, etc)
to define **when and which users to notify**
* OnCall users with [Editor role][user-and-team-management] can work with Alerts Groups and set up personal settings,
* OnCall users with [Editor role](ref:user-and-team-management) can work with Alerts Groups and set up personal settings,
e.g. **how to notify**.
> **Note:** If your role is **Editor**, you can skip to [Learn about the Alert Workflow](#learn-about-the-alert-workflow).
@ -83,19 +134,19 @@ send a demo alert.
4. Acknowledge and resolve the test alert group
For more information on Grafana OnCall integrations and further configuration guidance, refer to
[Grafana OnCall integrations][integrations]
[Grafana OnCall integrations](ref:integrations)
### Review and modify alert templates
Review and customize templates to interpret monitoring alerts and minimize noise. Group alerts, enable auto-resolution,
customize visualizations and notifications by extracting data from alerts. See more details in the
[Jinja2 templating][] section.
[Jinja2 templating](ref:jinja2-templating) section.
### Configure Escalation Chains
Escalation Chains are a set of steps that define who to notify, and when.
For more information, refer to [Escalation chains][].
For more information, refer to [Escalation chains](ref:escalation-chains).
Escalation Chains are customizable automated alert routing steps that enable you to specify who is notified for a certain
alert. In addition to escalation chains, you can configure Routes to send alerts to different escalation chains depending
@ -114,10 +165,10 @@ To configure Escalation Chains:
Alerts from this integration will now follow the escalation steps configured in your Escalation Chain.
For more information on Escalation Chains and more ways to customize them, refer to [Escalation chains][]
For more information on Escalation Chains and more ways to customize them, refer to [Escalation chains](ref:escalation-chains)
Routes define which messenger channels and escalation chains to use for notifications.
For more information, refer to [Routes][].
For more information, refer to [Routes](ref:routes).
### Learn about the Alert Workflow
@ -158,7 +209,7 @@ Personal notification policies determine how a user is notified for a certain ty
phone call, Slack mentions, or mobile push notification. Administrators can configure how users receive notifications
for certain types of alerts.
For more information on personal notification policies, refer to
[Manage users and teams for Grafana OnCall][user-and-team-management]
[Manage users and teams for Grafana OnCall](ref:user-and-team-management)
To configure users personal notification policies:
@ -182,10 +233,10 @@ To configure Slack for Grafana OnCall:
6. Ensure users verify their Slack accounts in their user profile in Grafana OnCall.
For further instruction on connecting to your Slack workspace, refer to
[Slack integration for Grafana OnCall][]
[Slack integration for Grafana OnCall](ref:slack-integration-for-grafana-oncall)
Grafana OnCall also supports other ChatOps integration like Microsoft Teams and Telegram.
For a full list of supported integrations, refer to [Notify people][].
For a full list of supported integrations, refer to [Notify people](ref:notify-people).
### Add your on-call schedule
@ -198,36 +249,4 @@ To integrate your on-call calendar with Grafana OnCall:
2. Provide a schedule name.
3. Configure the rest of the schedule settings and click Create Schedule
For more information about OnCall schedules, refer to [On-call schedules][].
{{% docs/reference %}}
[escalation-chains-and-routes]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes"
[escalation-chains-and-routes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes"
[Escalation chains]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes#escalation-chains"
[Escalation chains]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes#escalation-chains"
[integrations]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations"
[integrations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations"
[Jinja2 templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating"
[Jinja2 templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating"
[Notify people]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/notify"
[Notify people]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify"
[On-call schedules]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/on-call-schedules"
[On-call schedules]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/on-call-schedules"
[Install Grafana OnCall OSS]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/set-up/open-source#install-grafana-oncall-oss"
[Install Grafana OnCall OSS]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source#install-grafana-oncall-oss"
[Routes]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/escalation-chains-and-routes#routes"
[Routes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/escalation-chains-and-routes#routes"
[Slack integration for Grafana OnCall]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/notify/slack"
[Slack integration for Grafana OnCall]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/notify/slack"
[user-and-team-management]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management"
[user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/user-and-team-management"
{{% /docs/reference %}}
For more information about OnCall schedules, refer to [On-call schedules](ref:on-call-schedules).

23
docs/sources/set-up/open-source/index.md
View file

@ -13,6 +13,17 @@ aliases:
- /docs/grafana-cloud/alerting-and-irm/oncall/set-up/open-source/
- /docs/grafana-cloud/alerting-and-irm/oncall/open-source/
- ../open-source/ # /docs/oncall/<ONCALL_VERSION>/open-source/
refs:
grafana-oncall-mobile-app:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/manage/mobile-app/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app/
inbound-email-integration:
- pattern: /docs/oncall/
destination: /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/inbound-email/
---
# Grafana OnCall open source guide
@ -280,7 +291,7 @@ After enabling the email integration, it will be possible to use the `Notify by
## Inbound Email Setup
Grafana OnCall is capable of creating alert groups from the [Inbound email integration][inbound-email-integration].
Grafana OnCall is capable of creating alert groups from the [Inbound email integration](ref:inbound-email-integration).
To configure Inbound Email integration for Grafana OnCall OSS populate env variables with your Email Service Provider data:
@ -311,7 +322,7 @@ Refer to [Install Grafana OnCall OSS](#install-grafana-oncall-oss) before contin
For Grafana OnCall OSS, the mobile app QR code includes an authentication token along with a backend URL.
Your Grafana OnCall OSS instance should be reachable from the same network as your mobile device, preferably from the internet.
For more information, refer to [Grafana OnCall mobile app][].
For more information, refer to [Grafana OnCall mobile app](ref:grafana-oncall-mobile-app).
## Alert Group Escalation Auditor
@ -341,11 +352,3 @@ To configure this feature as such:
Additionally, if you prefer to disable this feature, you can set the `ESCALATION_AUDITOR_ENABLED` environment variable
to `False`.
{{% docs/reference %}}
[inbound-email-integration]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email"
[inbound-email-integration]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/inbound-email"
[Grafana OnCall mobile app]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/mobile-app"
[Grafana OnCall mobile app]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/manage/mobile-app"
{{% /docs/reference %}}