Skip to content

Commit 3c6df0f

Browse files
authored
Merge pull request #290004 from maud-lv/ml-grafanasettings
Turn into how-to doc and add CSRF setting
2 parents e3f9c68 + 57449f3 commit 3c6df0f

File tree

4 files changed

+37
-19
lines changed

4 files changed

+37
-19
lines changed

articles/managed-grafana/grafana-settings.md

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,59 @@
11
---
2-
title: Learn about Grafana settings
2+
title: How to Configure Grafana Settings
33
titleSuffix: "Azure Managed Grafana"
4-
description: Learn about Grafana settings in Azure Managed Grafana, including Viewers can Edit and External Enabled.
4+
description: Learn how to configure Grafana settings in Azure Managed Grafana, including enabling Viewers can Edit and External Enabled.
55
author: maud-lv
66
ms.author: malev
77
ms.service: azure-managed-grafana
8-
ms.topic: concept-article
9-
ms.date: 08/09/2024
10-
#customer intent: In this document, learn about the custom Grafana options available in the Grafana settings tab, in Azure Managed Grafana.
8+
ms.topic: how-to
9+
ms.date: 11/06/2024
10+
#customer intent: In this document, learn how to configure the custom Grafana options available in the Grafana settings tab, in Azure Managed Grafana.
1111

1212
---
1313

14-
# Grafana settings
14+
# How to configure Grafana settings
1515

16-
This article introduces the Grafana settings available in Azure Managed Grafana. These settings are designed to enable Azure Managed Grafana customers to customize their Grafana instances by enabling or disabling the Grafana options listed below.
16+
This article provides step-by-step instructions on how to configure Grafana settings in Azure Managed Grafana. These settings allow you to customize your Grafana instance by enabling or disabling specific options. These Grafana settings are also referenced in Grafana's documentation, under [Grafana configuration](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/).
1717

18-
These settings are located in Azure Managed Grafana's **Settings** > **Configuration** menu, in the **Grafana Settings (Preview)** tab.
18+
## Prerequisites
1919

20-
:::image type="content" source="media/grafana-settings/grafana-settings-tab.png" alt-text="Screenshot of the Azure platform showing the Grafana settings tab." lightbox="media/grafana-settings/grafana-settings-tab.png":::
20+
- An Azure account with an active subscription.
21+
- An Azure Managed Grafana instance.
22+
23+
## Access Grafana Settings
2124

22-
They are also referenced in Grafana's documentation, under [Grafana configuration](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/).
25+
1. Open the Azure portal and navigate to your Azure Managed Grafana instance.
26+
1. In the left menu, select **Settings** > **Configuration**.
27+
1. Open the **Grafana Settings** tab.
28+
29+
:::image type="content" source="media/grafana-settings/grafana-settings-tab.png" alt-text="Screenshot of the Azure platform showing the Grafana settings tab." lightbox="media/grafana-settings/grafana-settings-tab.png":::
2330

2431
## Viewers Can Edit
2532

26-
The **Viewers Can Edit** setting allows users with the Grafana Viewer role to edit dashboards. This feature is designed to enable Grafana Viewers to run tests and interact with dashboards without making permanent changes. While they can edit dashboards, they can't save these edits.
33+
The **Viewers Can Edit** setting allows users with the Grafana Viewer role to edit dashboards without saving changes permanently. This feature is designed to enable Grafana Viewers to run tests and interact with dashboards without making permanent changes.
2734

28-
This option also gives Grafana Viewers access to the **Explore** menu in the Grafana UI, where they can perform interactive queries and analyze data within Grafana. However, it's important to note that any changes made by Viewers won't be saved permanently unless they have the appropriate Editor permissions.
35+
With this setting enabled, Grafana Viewers can:
36+
- Edit dashboards temporarily, without saving.
37+
- Access the **Explore** menu to perform interactive queries and analyze data.
2938

30-
To enable or disable this option, open an Azure Managed Grafana instance in the Azure portal and go to **Settings** > **Configuration** > **Grafana Settings (Preview)** > **Viewers can edit**. This option is disabled by default.
39+
1. In the **Grafana Settings** tab, locate the **Viewers Can Edit** option.
40+
1. This option is disabled by default. Toggle the switch to enable this setting.
3141

3242
## External Enabled
3343

34-
The **External Enabled** setting controls the public sharing of snapshots. This option is enabled by default, allowing users to publish snapshots of their dashboards.
44+
The **External Enabled** setting controls the public sharing of snapshots.
45+
46+
With this setting enabled, users can publish snapshots of dashboards to an external URL by opening a dashboard, selecting **Share** > **Snapshot** > **Publish to snapshots.raintanks.io**.
47+
48+
1. In the **Grafana Settings** tab, locate the **External Enabled** option.
49+
1. This option is enabled by default, allowing users to publicly share snapshots of their dashboards. To restrict the public sharing of snapshots, toggle off the switch to disable this setting.
50+
51+
## CSRF Always Check
3552

36-
With this option enabled, users can publish a snapshot of a dashboard to an external URL by opening a dashboard, selecting **Share** > **Snapshot**, and then **Publish to snapshots.raintanks.io**.
53+
The **CSRF Always Check** setting enhances security by rejecting requests that have an origin header that does not match the origin of the Grafana instance. This setting helps to prevent Cross-Site Request Forgery (CSRF) attacks. This option is disabled by default.
3754

38-
You can disable the External Enabled option to restrict the public sharing of snapshots. To do this, open an Azure Managed Grafana instance in the Azure portal and go to **Settings** > **Configuration** > **Grafana Settings (Preview)** and toggle off the **External Enabled** setting.
55+
1. In the **Grafana Settings** tab, locate the **CSRF Always Check** option.
56+
1. Toggle the switch to enable or disable this setting based on your security requirements.
3957

4058
## Related content
4159

articles/managed-grafana/index.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ landingContent:
8181
url: how-to-set-up-private-access.md
8282
- text: Call Grafana APIs programmatically
8383
url: how-to-api-calls.md
84-
- text: Grafana settings
84+
- text: Configure Grafana settings
8585
url: grafana-settings.md
8686
- text: Use deterministic outbound IPs
8787
url: how-to-deterministic-ip.md
-55.8 KB
Loading

articles/managed-grafana/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ items:
2828
href: high-availability.md
2929
- name: Encryption
3030
href: encryption.md
31-
- name: Grafana settings
32-
href: grafana-settings.md
3331
- name: Azure RBAC
3432
href: concept-role-based-access-control.md
3533
- name: How-to guides
@@ -98,6 +96,8 @@ items:
9896
href: how-to-monitor-managed-grafana-workspace.md
9997
- name: Migrate to Azure Managed Grafana
10098
href: how-to-migrate.md
99+
- name: Configure Grafana settings
100+
href: grafana-settings.md
101101
- name: Troubleshoot common issues
102102
href: troubleshoot-managed-grafana.md
103103
- name: Reference

0 commit comments

Comments
 (0)