diff --git a/docs/sources/_index.md b/docs/sources/_index.md index e2b19d95..a7962831 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -11,6 +11,7 @@ keywords: - OnCall - irm title: Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/" weight: 1000 --- diff --git a/docs/sources/calendar-schedules/_index.md b/docs/sources/calendar-schedules/_index.md index 7dff67a0..607f5d72 100644 --- a/docs/sources/calendar-schedules/_index.md +++ b/docs/sources/calendar-schedules/_index.md @@ -8,6 +8,7 @@ keywords: - on-call - calendar title: Configure and manage on-call schedules +canonical: "https://grafana.com/docs/oncall/latest/calendar-schedules/" weight: 900 --- diff --git a/docs/sources/chat-options/_index.md b/docs/sources/chat-options/_index.md index 324356d3..a69cf32d 100644 --- a/docs/sources/chat-options/_index.md +++ b/docs/sources/chat-options/_index.md @@ -10,6 +10,7 @@ keywords: - oncall - slack title: Connect ChatOps to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/" weight: 700 --- diff --git a/docs/sources/chat-options/configure-slack.md b/docs/sources/chat-options/configure-slack.md index 5b330838..9d42934f 100644 --- a/docs/sources/chat-options/configure-slack.md +++ b/docs/sources/chat-options/configure-slack.md @@ -10,6 +10,7 @@ keywords: - oncall - slack title: Connect Slack to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-slack/" weight: 100 --- diff --git a/docs/sources/chat-options/configure-telegram.md b/docs/sources/chat-options/configure-telegram.md index ec6128eb..0d52e861 100644 --- a/docs/sources/chat-options/configure-telegram.md +++ b/docs/sources/chat-options/configure-telegram.md @@ -10,6 +10,7 @@ keywords: - oncall - telegram title: Connect Telegram to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-telegram/ weight: 300 --- diff --git a/docs/sources/configure-user-settings.md b/docs/sources/configure-user-settings.md index 7654c795..64529000 100644 --- a/docs/sources/configure-user-settings.md +++ b/docs/sources/configure-user-settings.md @@ -10,6 +10,7 @@ keywords: - oncall - integrations title: Manage users and teams for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/configure-user-setting/" weight: 1100 --- diff --git a/docs/sources/escalation-policies/_index.md b/docs/sources/escalation-policies/_index.md index def9d900..4e8f832d 100644 --- a/docs/sources/escalation-policies/_index.md +++ b/docs/sources/escalation-policies/_index.md @@ -1,13 +1,15 @@ -+++ -title = "Configure Escalation Chains and Routes for Grafana OnCall" -keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"] -weight = 500 -+++ +--- +title: Configure escalation chains and routes for Grafana OnCall +weight: 500 +canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/" +aliases: + - /docs/oncall/latest/chat-options/escalation-policies/ +--- -# Configure Escalation Chains and Routes for Grafana OnCall +# Configure escalation chains and routes for Grafana OnCall -Escalation Chains and Routes for Grafana OnCall +Escalation chains and routes for Grafana OnCall Administrators can create escalation policies to automatically send alert group notifications to recipients. These policies define how, where, and when to send notifications. diff --git a/docs/sources/escalation-policies/configure-escalation-chains.md b/docs/sources/escalation-policies/configure-escalation-chains.md index 9430dd24..f1ce2607 100644 --- a/docs/sources/escalation-policies/configure-escalation-chains.md +++ b/docs/sources/escalation-policies/configure-escalation-chains.md @@ -10,6 +10,7 @@ keywords: - oncall - integrations title: Configure and manage Escalation Chains +canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/configure-escalation-chains/" weight: 100 --- diff --git a/docs/sources/escalation-policies/configure-routes.md b/docs/sources/escalation-policies/configure-routes.md index 18666e4c..becaa109 100644 --- a/docs/sources/escalation-policies/configure-routes.md +++ b/docs/sources/escalation-policies/configure-routes.md @@ -9,11 +9,12 @@ keywords: - amixr - oncall - integrations -title: Configure and manage Routes +title: Configure and manage routes +canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/configure-routes/" weight: 300 --- -# Configure and manage Routes +# Configure and manage routes Set up escalation chains and routes to configure escalation behavior for alert group notifications. diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index 1e762b2b..c2fe2569 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -1,10 +1,13 @@ -+++ -title = "Get started with Grafana OnCall" -keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call"] -aliases = ["/docs/grafana-cloud/oncall/getting-started"] -weight = 100 -+++ +--- +title: +- Get started with Grafana OnCall +aliases: +- /docs/grafana-cloud/oncall/getting-started +canonical: "https://grafana.com/docs/oncall/latest/getting-started/" +weight: 100 +--- +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/ # Get started with Grafana OnCall diff --git a/docs/sources/integrations/_index.md b/docs/sources/integrations/_index.md index cfbed723..debce6e8 100644 --- a/docs/sources/integrations/_index.md +++ b/docs/sources/integrations/_index.md @@ -11,6 +11,7 @@ keywords: - oncall - integrations title: Connect to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/" weight: 300 --- diff --git a/docs/sources/integrations/add-webhook-integration.md b/docs/sources/integrations/add-webhook-integration.md index e0579381..09ad3705 100644 --- a/docs/sources/integrations/add-webhook-integration.md +++ b/docs/sources/integrations/add-webhook-integration.md @@ -9,6 +9,7 @@ keywords: - Alertmanager - Prometheus title: Webhook integration for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/add-webhook-integration/" weight: 700 --- diff --git a/docs/sources/integrations/available-integrations /_index.md b/docs/sources/integrations/available-integrations /_index.md index 6e30a415..1d785f3c 100644 --- a/docs/sources/integrations/available-integrations /_index.md +++ b/docs/sources/integrations/available-integrations /_index.md @@ -1,7 +1,7 @@ --- aliases: - /docs/grafana-cloud/oncall/integrations/add-integration/ - - /docs/oncall/latest/integrations/available-integrations / + - /docs/oncall/latest/integrations/available-integrations/ keywords: - Grafana Cloud - Alerts @@ -10,6 +10,7 @@ keywords: - Alertmanager - Prometheus title: Currently available integrations for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/" weight: 100 --- diff --git a/docs/sources/integrations/available-integrations /add-alertmanager.md b/docs/sources/integrations/available-integrations /add-alertmanager.md index f5604f4e..e3a80c1c 100644 --- a/docs/sources/integrations/available-integrations /add-alertmanager.md +++ b/docs/sources/integrations/available-integrations /add-alertmanager.md @@ -10,6 +10,7 @@ keywords: - Alertmanager - Prometheus title: Connect Alert Manager to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/add-alertmanager/" weight: 300 --- diff --git a/docs/sources/integrations/available-integrations /add-grafana-alerting.md b/docs/sources/integrations/available-integrations /add-grafana-alerting.md index 0e8519dd..e3af0a90 100644 --- a/docs/sources/integrations/available-integrations /add-grafana-alerting.md +++ b/docs/sources/integrations/available-integrations /add-grafana-alerting.md @@ -9,6 +9,7 @@ keywords: - on-call - Prometheus title: Connect Grafana Alerting to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/add-grafana-alerting/" weight: 100 --- diff --git a/docs/sources/integrations/available-integrations /add-zabbix.md b/docs/sources/integrations/available-integrations /add-zabbix.md index a85e2477..cfe663a1 100644 --- a/docs/sources/integrations/available-integrations /add-zabbix.md +++ b/docs/sources/integrations/available-integrations /add-zabbix.md @@ -8,6 +8,7 @@ keywords: - on-call - Zabbix title: Connect Zabbix to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/add-zabbix/" weight: 500 --- diff --git a/docs/sources/integrations/configure-outgoing-webhooks.md b/docs/sources/integrations/configure-outgoing-webhooks.md index dda09988..c35b0b24 100644 --- a/docs/sources/integrations/configure-outgoing-webhooks.md +++ b/docs/sources/integrations/configure-outgoing-webhooks.md @@ -9,6 +9,7 @@ keywords: - amixr - webhooks title: Configure outgoing webhooks for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/configure-outgoing-webhooks/" weight: 500 --- diff --git a/docs/sources/integrations/create-custom-templates.md b/docs/sources/integrations/create-custom-templates.md index 676278db..440bfe28 100644 --- a/docs/sources/integrations/create-custom-templates.md +++ b/docs/sources/integrations/create-custom-templates.md @@ -8,6 +8,7 @@ keywords: - on-call - Jinja title: Configure alerts in Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/create-custom-templates/" weight: 300 --- diff --git a/docs/sources/oncall-api-reference/_index.md b/docs/sources/oncall-api-reference/_index.md index b696b0fc..708be1a7 100644 --- a/docs/sources/oncall-api-reference/_index.md +++ b/docs/sources/oncall-api-reference/_index.md @@ -2,6 +2,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/ title: Grafana OnCall HTTP API reference +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/" weight: 1300 --- diff --git a/docs/sources/oncall-api-reference/alertgroups.md b/docs/sources/oncall-api-reference/alertgroups.md index 9ebec034..59b27ead 100644 --- a/docs/sources/oncall-api-reference/alertgroups.md +++ b/docs/sources/oncall-api-reference/alertgroups.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/alertgroups/ - /docs/oncall/latest/oncall-api-reference/alertgroups/ title: Alert groups HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/alertgroups/" weight: 400 --- diff --git a/docs/sources/oncall-api-reference/alerts.md b/docs/sources/oncall-api-reference/alerts.md index ca67add1..8a062581 100644 --- a/docs/sources/oncall-api-reference/alerts.md +++ b/docs/sources/oncall-api-reference/alerts.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/alerts/ - /docs/oncall/latest/oncall-api-reference/alerts/ title: Alerts HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/alerts/" weight: 100 --- diff --git a/docs/sources/oncall-api-reference/escalation_chains.md b/docs/sources/oncall-api-reference/escalation_chains.md index 24a7eb50..8723b6a6 100644 --- a/docs/sources/oncall-api-reference/escalation_chains.md +++ b/docs/sources/oncall-api-reference/escalation_chains.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/escalation_chains/ - /docs/oncall/latest/oncall-api-reference/escalation_chains/ title: Escalation Chains HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_chains/" weight: 200 --- diff --git a/docs/sources/oncall-api-reference/escalation_policies.md b/docs/sources/oncall-api-reference/escalation_policies.md index bc1262e4..76d253f3 100644 --- a/docs/sources/oncall-api-reference/escalation_policies.md +++ b/docs/sources/oncall-api-reference/escalation_policies.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/escalation_policies/ - /docs/oncall/latest/oncall-api-reference/escalation_policies/ title: Escalation Policies HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_policies/" weight: 300 --- diff --git a/docs/sources/oncall-api-reference/integrations.md b/docs/sources/oncall-api-reference/integrations.md index d6d7e729..ff8a7cc9 100644 --- a/docs/sources/oncall-api-reference/integrations.md +++ b/docs/sources/oncall-api-reference/integrations.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/integrations/ - /docs/oncall/latest/oncall-api-reference/integrations/ title: Integrations HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/integrations/" weight: 500 --- diff --git a/docs/sources/oncall-api-reference/on_call_shifts.md b/docs/sources/oncall-api-reference/on_call_shifts.md index c3f3a5d0..31eee871 100644 --- a/docs/sources/oncall-api-reference/on_call_shifts.md +++ b/docs/sources/oncall-api-reference/on_call_shifts.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/on_call_shifts/ - /docs/oncall/latest/oncall-api-reference/on_call_shifts/ title: OnCall shifts HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/on_call_shifts/" weight: 600 --- diff --git a/docs/sources/oncall-api-reference/outgoing_webhooks.md b/docs/sources/oncall-api-reference/outgoing_webhooks.md index f42d1c07..0e26f012 100644 --- a/docs/sources/oncall-api-reference/outgoing_webhooks.md +++ b/docs/sources/oncall-api-reference/outgoing_webhooks.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/outgoing_webhooks/ - /docs/oncall/latest/oncall-api-reference/outgoing_webhooks/ title: Outgoing webhooks HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/" weight: 700 --- diff --git a/docs/sources/oncall-api-reference/personal_notification_rules.md b/docs/sources/oncall-api-reference/personal_notification_rules.md index 2b22ec07..dc6e8562 100644 --- a/docs/sources/oncall-api-reference/personal_notification_rules.md +++ b/docs/sources/oncall-api-reference/personal_notification_rules.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/personal_notification_rules/ - /docs/oncall/latest/oncall-api-reference/personal_notification_rules/ title: Personal Notification Rules HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/personal_notification_rules/" weight: 800 --- diff --git a/docs/sources/oncall-api-reference/postmortem_messages.md b/docs/sources/oncall-api-reference/postmortem_messages.md index ba3e9252..b2fefa19 100644 --- a/docs/sources/oncall-api-reference/postmortem_messages.md +++ b/docs/sources/oncall-api-reference/postmortem_messages.md @@ -4,6 +4,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/postmortem_messages/ draft: true title: Postmortem Messages HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/postmortem_messages/" weight: 900 --- diff --git a/docs/sources/oncall-api-reference/postmortems.md b/docs/sources/oncall-api-reference/postmortems.md index 95197687..c98026ae 100644 --- a/docs/sources/oncall-api-reference/postmortems.md +++ b/docs/sources/oncall-api-reference/postmortems.md @@ -4,6 +4,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/postmortems/ draft: true title: Postmortem HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/postmortems/" weight: 1000 --- diff --git a/docs/sources/oncall-api-reference/routes.md b/docs/sources/oncall-api-reference/routes.md index 11a1a460..78eb387f 100644 --- a/docs/sources/oncall-api-reference/routes.md +++ b/docs/sources/oncall-api-reference/routes.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/routes/ - /docs/oncall/latest/oncall-api-reference/routes/ title: Routes HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/routes/" weight: 1100 --- diff --git a/docs/sources/oncall-api-reference/schedules.md b/docs/sources/oncall-api-reference/schedules.md index f8de9cb9..d7ec9273 100644 --- a/docs/sources/oncall-api-reference/schedules.md +++ b/docs/sources/oncall-api-reference/schedules.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/schedules/ - /docs/oncall/latest/oncall-api-reference/schedules/ title: Schedule HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/schedules/" weight: 1200 --- diff --git a/docs/sources/oncall-api-reference/slack_channels.md b/docs/sources/oncall-api-reference/slack_channels.md index 6dda924b..6c7d09c3 100644 --- a/docs/sources/oncall-api-reference/slack_channels.md +++ b/docs/sources/oncall-api-reference/slack_channels.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/slack_channels/ - /docs/oncall/latest/oncall-api-reference/slack_channels/ title: Slack Channels HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/slack_channels/" weight: 1300 --- diff --git a/docs/sources/oncall-api-reference/user_groups.md b/docs/sources/oncall-api-reference/user_groups.md index 7fdef887..e2021770 100644 --- a/docs/sources/oncall-api-reference/user_groups.md +++ b/docs/sources/oncall-api-reference/user_groups.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/user_groups/ - /docs/oncall/latest/oncall-api-reference/user_groups/ title: OnCall User Groups HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/user_groups/" weight: 1400 --- diff --git a/docs/sources/oncall-api-reference/users.md b/docs/sources/oncall-api-reference/users.md index a64514dc..ca6d01df 100644 --- a/docs/sources/oncall-api-reference/users.md +++ b/docs/sources/oncall-api-reference/users.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/users/ - /docs/oncall/latest/oncall-api-reference/users/ title: Grafana OnCall Users HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/users/" weight: 1500 --- diff --git a/docs/sources/open-source.md b/docs/sources/open-source.md index 8d77b0d0..15da9bb1 100644 --- a/docs/sources/open-source.md +++ b/docs/sources/open-source.md @@ -5,6 +5,7 @@ aliases: keywords: - Open Source title: Open Source +canonical: "https://grafana.com/docs/oncall/latest/open-source/" weight: 100 --- @@ -27,23 +28,23 @@ Grafana OnCall Slack integration use a lot of Slack API features: 1. Make sure your OnCall is up and running. -2. You need OnCall to be accessible through https. For development purposes we suggest using [localtunnel](https://github.com/localtunnel/localtunnel). For production purposes please consider setting up proper web server with HTTPS termination. For localtunnel: -```bash -# Choose the unique prefix instead of pretty-turkey-83 -# Localtunnel will generate an url, e.g. https://pretty-turkey-83.loca.lt -# it is referred as below -lt --port 8000 -s pretty-turkey-83 --print-requests -``` +1. You need OnCall to be accessible through https. For development purposes we suggest using [localtunnel](https://github.com/localtunnel/localtunnel). For production purposes please consider setting up proper web server with HTTPS termination. For localtunnel: + ```bash + # Choose the unique prefix instead of pretty-turkey-83 + # Localtunnel will generate an url, e.g. https://pretty-turkey-83.loca.lt + # it is referred as below + lt --port 8000 -s pretty-turkey-83 --print-requests + ``` -3. If you use localtunnel, open your external URL and click "Continue" to allow requests to bypass the warning page. +1. If you use localtunnel, open your external URL and click "Continue" to allow requests to bypass the warning page. -4. [Create a Slack Workspace](https://slack.com/create) for development, or use your company workspace. +1. [Create a Slack Workspace](https://slack.com/create) for development, or use your company workspace. -5. Go to https://api.slack.com/apps and click Create New App button +1. Go to https://api.slack.com/apps and click Create New App button -6. Select `From an app manifest` option and choose the right workspace +1. Select `From an app manifest` option and choose the right workspace -7. Copy and paste the following block with the correct and fields +1. Copy and paste the following block with the correct and fields ```yaml _metadata: @@ -133,17 +134,16 @@ lt --port 8000 -s pretty-turkey-83 --print-requests socket_mode_enabled: false ``` -6. Go to your "OnCall" -> "Env Variables" and set: - ``` +1. Go to your "OnCall" -> "Env Variables" and set: + + ```bash SLACK_CLIENT_OAUTH_ID = Basic Information -> App Credentials -> Client ID SLACK_CLIENT_OAUTH_SECRET = Basic Information -> App Credentials -> Client Secret SLACK_SIGNING_SECRET = Basic Information -> App Credentials -> Signing Secret SLACK_INSTALL_RETURN_REDIRECT_HOST = << OnCall external URL >> ``` -7. Go to "OnCall" -> "ChatOps" -> "Slack" and install Slack Integration - -8. All set! +1. Go to "OnCall" -> "ChatOps" -> "Slack" and install Slack Integration ## Telegram Setup @@ -152,11 +152,11 @@ lt --port 8000 -s pretty-turkey-83 --print-requests 1. Make sure your OnCall is up and running. -2. Respectfully ask [BotFather](https://t.me/BotFather) for a key, put it in `TELEGRAM_TOKEN` in "OnCall" -> "Env Variables". +1. Respectfully ask [BotFather](https://t.me/BotFather) for a key, put it in `TELEGRAM_TOKEN` in "OnCall" -> "Env Variables". -3. Set `TELEGRAM_WEBHOOK_HOST` with your external url for OnCall. +1. Set `TELEGRAM_WEBHOOK_HOST` with your external url for OnCall. -4. Go to "OnCall" -> "ChatOps" -> Telegram and enjoy! +1. Go to "OnCall" -> "ChatOps" -> Telegram and enjoy! ## Grafana OSS-Cloud Setup @@ -167,4 +167,4 @@ Please note that it's possible either to use Grafana Cloud either Twilio for SMS ## Twilio Setup 1. Make sure Grafana OSS <-> Cloud connector is disabled. Set `GRAFANA_CLOUD_NOTIFICATIONS_ENABLED` as False. -2. Check "OnCall" -> "Env Variables" and set all variables starting with `TWILIO_` +1. Check "OnCall" -> "Env Variables" and set all variables starting with `TWILIO_`