diff --git a/docs/sources/mobile-app/_index.md b/docs/sources/mobile-app/_index.md new file mode 100644 index 00000000..ddfc3371 --- /dev/null +++ b/docs/sources/mobile-app/_index.md @@ -0,0 +1,103 @@ +--- +title: Grafana OnCall mobile app +aliases: + - /docs/oncall/latest/mobile-app/ +keywords: + - Mobile App + - oncall + - notification + - push notification +weight: 1200 +--- + +# Grafana OnCall Mobile App + +>**Note**: This application is currently in beta and has limited functionality. + +The Grafana OnCall mobile app allows teams to monitor and respond to critical system events from anywhere. +On-call engineers can start exploring the benefits of the Grafana OnCall mobile app, with real-time alerts, on-call notifications, and a growing feature set. + +## About Grafana OnCall mobile app + +The current version of the mobile app includes limited functionality and serves primarily as a notification method. +The mobile app is in development, and some features are not yet available. + +Stay tuned, we're working on it! + +Grafana OnCall mobile app key features: + +- Override Do Not Disturb on your device to ensure delivery of critical alerts +- Receive push notifications according to your personal notification settings +- View alert details from your mobile device +- Login with a quick and secure QR code authorization + +The OnCall mobile app allows users to receive push notifications as part of their notification policy. +Push notifications are one of the many notification options in Grafana OnCall. + +Consider using multiple notification methods, such as mobile app and phone/SMS, +to remain available in case of degraded internet or phone network connectivity. + +## Before you begin + +The Grafana OnCall mobile app is intended to be used as an extension of your Grafana OnCall instance. +Grafana OnCall is available for Grafana Cloud and Grafana open source users. + +- You must have a Grafana OnCall account to use this application +- Download Grafana OnCall mobile app + +Mobile app download: + +- [Google Play Store](https://play.google.com/store/apps/details?id=com.grafana.oncall.prod) +- Apple App Store - Coming soon + +## Connect your Grafana OnCall account + +The OnCall mobile app uses a QR code authentication to connect to your Grafana OnCall instance. +You can associate one Grafana OnCall user with your OnCall mobile app. + +To connect your account in the mobile app: + +1. Open the Grafana OnCall mobile app and click **Sign in** +2. Follow the instructions in the app to complete QR code authentication +3. Once the scan is successful, your mobile app is connected to OnCall + +### Where can I find my QR code? + +To access your QR code: + +1. Open Grafana OnCall from your desktop +1. Navigate to the **Users** tab, then click **View my profile** +1. Click **Mobile app connection** in your profile + +>**Note**: The QR code will timeout for security purposes - Screenshots of the QR code are unlikely to work for authentication. + +### Connect to your open source Grafana OnCall account + +Grafana OnCall OSS relies on Grafana Cloud as on relay for push notifications. +You must first connect your Grafana OnCall OSS to Grafana Cloud for the mobile app to work. + +To connect to Grafana Cloud, refer to the Cloud page in your OSS Grafana OnCall instance. + +For Grafana OnCall OSS, the 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. + +## Mobile app push notifications + +There are two push notification options for the mobile app: + +- **Mobile push** - Sends a typical push notification to your mobile device according to your device and app notification settings. +Intended for all types of alerts. +- **Mobile push important** - Sends a privileged push notification that can bypass Do Not Disturb on your device. +Intended for critical alerts. Device-specific settings may impact the functionality of these notifications. + +>**Note**: Android users may need to review their device settings to ensure the Grafana OnCall mobile app is authorized to bypass Do Not Disturb. +> In your device settings, allow the Android Critical Message Channel notification channel to Override Do Not Disturb. + +### Add mobile app to notification preferences + +To receive push notifications from the Grafana OnCall mobile app, you must add them to your notification policy steps. + +1. From Grafana OnCall, navigate to the **Users** tab and click **View my profile** +1. In your **User Info** tab, update your Default and Important notification policies to include Mobile push notifications. + +For more information about Notification Policies, refer to [Manage users and teams for Grafana OnCall]({{< relref "../configure-user-settings" >}}) diff --git a/docs/sources/open-source/_index.md b/docs/sources/open-source/_index.md index 57cf4a35..aad2c29c 100644 --- a/docs/sources/open-source/_index.md +++ b/docs/sources/open-source/_index.md @@ -219,3 +219,18 @@ the following env variables with your SMTP server credentials: - `EMAIL_FROM_ADDRESS` (optional) - Email address used to send emails. If not specified, `EMAIL_HOST_USER` will be used. After enabling the email integration, it will be possible to use the `Notify by email` notification step in user settings. + +## Mobile application set up + +>**Note**: This application is currently in beta + +Grafana OnCall OSS users can use the mobile app to receive push notifications from OnCall. +Grafana OnCall OSS relies on Grafana Cloud as on relay for push notifications. +You must first connect your Grafana OnCall OSS to Grafana Cloud for the mobile app to work. + +Refer to [Grafana OSS-Cloud Setup]({{< relref "_index.md#grafana-oss-cloud-setup" >}}) in this document before continuing with the mobile app. + +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, see [Grafana OnCall mobile app]({{< relref "../mobile-app" >}}) diff --git a/engine/apps/mobile_app/backend.py b/engine/apps/mobile_app/backend.py index 43f257c3..bbf1d220 100644 --- a/engine/apps/mobile_app/backend.py +++ b/engine/apps/mobile_app/backend.py @@ -9,8 +9,8 @@ from apps.mobile_app.tasks import notify_user_async class MobileAppBackend(BaseMessagingBackend): backend_id = "MOBILE_APP" - label = "Mobile app" - short_label = "Mobile app" + label = "Mobile push" + short_label = "Mobile push" available_for_use = True template_fields = ["title"] @@ -59,8 +59,8 @@ class MobileAppCriticalBackend(MobileAppBackend): """ backend_id = "MOBILE_APP_CRITICAL" - label = "Mobile app critical" - short_label = "Mobile app critical" + label = "Mobile push important" + short_label = "Mobile push important" template_fields = [] def notify_user(self, user, alert_group, notification_policy, critical=True):