[v8.3.x] Update docs/shared shortcode usage to use keyword argument interface (#73771)
* Enable legacy shortcode usage logging to allow future template simplification Once all legacy usage is removed, this logical branch can also be removed. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update all use of docs/shared in Grafana to use keyword arguments Signed-off-by: Jack Baldry <jack.baldry@grafana.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
title = "Grafana documentation"
|
||||
description = "Guides, Installation and Feature Documentation"
|
||||
keywords = ["grafana", "installation", "documentation"]
|
||||
aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", "/docs/grafana/v3.1"]
|
||||
aliases = ["/docs/grafana/v1.1", "/docs/grafana/v8.3/guides/reference/admin", "/docs/grafana/v3.1"]
|
||||
+++
|
||||
|
||||
# Grafana documentation
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Configuration"
|
||||
description = "Configuration documentation"
|
||||
keywords = ["grafana", "configuration", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/installation/configuration/"]
|
||||
aliases = ["/docs/grafana/v8.3/installation/configuration/"]
|
||||
weight = 150
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Configure Grafana Docker image"
|
||||
description = "Guide for configuring the Grafana Docker image"
|
||||
keywords = ["grafana", "configuration", "documentation", "docker"]
|
||||
aliases = ["/docs/grafana/latest/installation/configure-docker/"]
|
||||
aliases = ["/docs/grafana/v8.3/installation/configure-docker/"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Preferences"
|
||||
aliases =["/docs/grafana/latest/administration/preferences.md"]
|
||||
aliases =["/docs/grafana/v8.3/administration/preferences.md"]
|
||||
weight = 50
|
||||
+++
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ weight = 100
|
||||
|
||||
In Grafana, you can change your names and emails associated with groups or accounts in the Settings or Preferences. This topic provides instructions for each task.
|
||||
|
||||
{{< docs/shared "preferences/some-tasks-require-permissions.md" >}}
|
||||
{{< docs/shared lookup="preferences/some-tasks-require-permissions.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
## Change organization name
|
||||
|
||||
@@ -19,7 +19,7 @@ Grafana server administrators and organization administrators can change organiz
|
||||
Follow these instructions if you are a Grafana Server Admin.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list.md" >}}
|
||||
{{< docs/shared lookup="manage-users/view-server-org-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
1. In the organization list, click the name of the organization that you want to change.
|
||||
1. In **Name**, enter the new organization name.
|
||||
@@ -31,7 +31,7 @@ Follow these instructions if you are a Grafana Server Admin.
|
||||
If you are an Organization Admin, follow these steps:
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/org-preferences-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/org-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
1. In **Organization name**, enter the new name.
|
||||
1. Click **Update organization name**.
|
||||
|
||||
@@ -9,7 +9,7 @@ weight = 200
|
||||
|
||||
In Grafana, you can modify the UI theme configured in the Settings or Preferences. Set the UI theme for the server, an organization, a team, or your personal user account using the instructions in this topic.
|
||||
|
||||
{{< docs/shared "preferences/some-tasks-require-permissions.md" >}}
|
||||
{{< docs/shared lookup="preferences/some-tasks-require-permissions.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
## Theme options
|
||||
|
||||
@@ -42,8 +42,8 @@ To see what the current settings are, refer to [View server settings]({{< relref
|
||||
Organization administrators can change the UI theme for all users in an organization.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/org-preferences-list.md" >}}
|
||||
{{< docs/shared "preferences/select-ui-theme-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/org-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/select-ui-theme-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Change team UI theme
|
||||
@@ -51,10 +51,10 @@ Organization administrators can change the UI theme for all users in an organiza
|
||||
Organization and team administrators can change the UI theme for all users in a team.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-team-list.md" >}}
|
||||
{{< docs/shared lookup="manage-users/view-team-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
1. Click on the team that you want to change the UI theme for and then navigate to the **Settings** tab.
|
||||
{{< docs/shared "preferences/select-ui-theme-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/select-ui-theme-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Change your personal UI theme
|
||||
@@ -62,6 +62,6 @@ Organization and team administrators can change the UI theme for all users in a
|
||||
You can change the UI theme for your user account. This setting overrides UI theme settings at higher levels.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/navigate-user-preferences-list.md" >}}
|
||||
{{< docs/shared "preferences/select-ui-theme-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/navigate-user-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/select-ui-theme-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
@@ -9,7 +9,7 @@ weight = 400
|
||||
|
||||
By default, Grafana uses the timezone in your web browser. However, you can override this setting at the server, organization, team, or individual user level. This topic provides instructions for each task.
|
||||
|
||||
{{< docs/shared "preferences/some-tasks-require-permissions.md" >}}
|
||||
{{< docs/shared lookup="preferences/some-tasks-require-permissions.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
## Set server timezone
|
||||
|
||||
@@ -20,8 +20,8 @@ Grafana server administrators can choose a default timezone for all users on the
|
||||
Organization administrators can choose a default timezone for their organization.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/org-preferences-list.md" >}}
|
||||
{{< docs/shared "preferences/select-timezone-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/org-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/select-timezone-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Set team timezone
|
||||
@@ -29,10 +29,10 @@ Organization administrators can choose a default timezone for their organization
|
||||
Organization administrators and team administrators can choose a default timezone for all users in a team.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-team-list.md" >}}
|
||||
{{< docs/shared lookup="manage-users/view-team-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
1. Click on the team you that you want to change the timezone for and then navigate to the **Settings** tab.
|
||||
{{< docs/shared "preferences/select-timezone-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/select-timezone-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Set your personal timezone
|
||||
@@ -40,6 +40,6 @@ Organization administrators and team administrators can choose a default timezon
|
||||
You can change the timezone for your user account. This setting overrides timezone settings at higher levels.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/navigate-user-preferences-list.md" >}}
|
||||
{{< docs/shared "preferences/select-timezone-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/navigate-user-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/select-timezone-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Change home dashboard"
|
||||
description = "How to replace the default home dashboard"
|
||||
keywords = ["grafana", "configuration", "documentation", "home"]
|
||||
aliases = ["/docs/grafana/latest/administration/change-home-dashboard/"]
|
||||
aliases = ["/docs/grafana/v8.3/administration/change-home-dashboard/"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
@@ -10,7 +10,7 @@ weight = 300
|
||||
|
||||
The home dashboard you set is the one all users will see by default when they log in. You can set the home dashboard for the server, an organization, a team, or your personal user account. This topic provides instructions for each task.
|
||||
|
||||
{{< docs/shared "preferences/some-tasks-require-permissions.md" >}}
|
||||
{{< docs/shared lookup="preferences/some-tasks-require-permissions.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
## Navigate to the home dashboard
|
||||
|
||||
@@ -47,9 +47,9 @@ default_home_dashboard_path = data/main-dashboard.json
|
||||
Organization administrators can choose a home dashboard for their organization.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/navigate-to-the-dashboard-list.md" >}}
|
||||
{{< docs/shared "preferences/org-preferences-list.md" >}}
|
||||
{{< docs/shared "preferences/select-home-dashboard-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/navigate-to-the-dashboard-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/org-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/select-home-dashboard-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Set home dashboard for your team
|
||||
@@ -57,11 +57,11 @@ Organization administrators can choose a home dashboard for their organization.
|
||||
Organization administrators and Team Admins can choose a home dashboard for a team.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/navigate-to-the-dashboard-list.md" >}}
|
||||
{{< docs/shared "manage-users/view-team-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/navigate-to-the-dashboard-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="manage-users/view-team-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
1. Click on the team that you want to change the home dashboard for and then navigate to the **Settings** tab.
|
||||
{{< docs/shared "preferences/select-home-dashboard-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/select-home-dashboard-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Set your personal home dashboard
|
||||
@@ -69,7 +69,7 @@ Organization administrators and Team Admins can choose a home dashboard for a te
|
||||
You can choose your own personal home dashboard. This setting overrides all home dashboards set at higher levels.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "preferences/navigate-to-the-dashboard-list.md" >}}
|
||||
{{< docs/shared "preferences/navigate-user-preferences-list.md" >}}
|
||||
{{< docs/shared "preferences/select-home-dashboard-list.md" >}}
|
||||
{{< docs/shared lookup="preferences/navigate-to-the-dashboard-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/navigate-user-preferences-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< docs/shared lookup="preferences/select-home-dashboard-list.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
{{< /docs/list >}}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Provisioning"
|
||||
description = ""
|
||||
keywords = ["grafana", "provisioning"]
|
||||
aliases = ["/docs/grafana/latest/installation/provisioning"]
|
||||
aliases = ["/docs/grafana/v8.3/installation/provisioning"]
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Security"
|
||||
description = "Security Docs"
|
||||
keywords = ["grafana", "security", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/installation/security/"]
|
||||
aliases = ["/docs/grafana/v8.3/installation/security/"]
|
||||
weight = 500
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Set up Grafana for high availability"
|
||||
keywords = ["grafana", "tutorials", "HA", "high availability"]
|
||||
aliases = ["/docs/grafana/latest/tutorials/ha_setup/"]
|
||||
aliases = ["/docs/grafana/v8.3/tutorials/ha_setup/"]
|
||||
weight = 1200
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Internal Grafana metrics"
|
||||
description = "Internal metrics exposed by Grafana"
|
||||
keywords = ["grafana", "metrics", "internal metrics"]
|
||||
aliases = ["/docs/grafana/latest/admin/metrics/"]
|
||||
aliases = ["/docs/grafana/v8.3/admin/metrics/"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "View server settings"
|
||||
description = "How to view server settings in the Grafana UI"
|
||||
keywords = ["grafana", "configuration", "server", "settings"]
|
||||
aliases = ["/docs/grafana/latest/admin/view-server-settings/"]
|
||||
aliases = ["/docs/grafana/v8.3/admin/view-server-settings/"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "View server stats"
|
||||
keywords = ["grafana", "server", "statistics"]
|
||||
aliases = ["/docs/grafana/latest/admin/view-server-stats/"]
|
||||
aliases = ["/docs/grafana/v8.3/admin/view-server-stats/"]
|
||||
weight = 400
|
||||
+++
|
||||
|
||||
|
||||
@@ -23,4 +23,4 @@ You can perform the following tasks for alerts:
|
||||
- [Test alert rules and troubleshoot]({{< relref "troubleshoot-alerts.md" >}})
|
||||
- [Add or edit an alert contact point]({{< relref "notifications.md" >}})
|
||||
|
||||
{{< docs/shared "alerts/grafana-managed-alerts.md" >}}
|
||||
{{< docs/shared lookup="alerts/grafana-managed-alerts.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Alert notification templating"
|
||||
keywords = ["grafana", "documentation", "alerting", "alerts", "notification", "templating"]
|
||||
weight = 110
|
||||
aliases = ["/docs/grafana/latest/alerting/add-notification-template/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/add-notification-template/"]
|
||||
+++
|
||||
|
||||
# Alert notification templating
|
||||
|
||||
@@ -3,7 +3,7 @@ title = "Create alerts"
|
||||
description = "Configure alert rules"
|
||||
keywords = ["grafana", "alerting", "guide", "rules"]
|
||||
weight = 200
|
||||
aliases = ["/docs/grafana/latest/alerting/create-alerts/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/create-alerts/"]
|
||||
+++
|
||||
|
||||
# Create alerts
|
||||
|
||||
@@ -3,7 +3,7 @@ title = "Alert notifications"
|
||||
description = "Alerting notifications guide"
|
||||
keywords = ["Grafana", "alerting", "guide", "notifications"]
|
||||
weight = 100
|
||||
aliases = ["/docs/grafana/latest/alerting/notifications/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/notifications/"]
|
||||
+++
|
||||
|
||||
# Alert notifications
|
||||
|
||||
@@ -3,7 +3,7 @@ title = "Pause alert rule"
|
||||
description = "Pause an existing alert rule"
|
||||
keywords = ["grafana", "alerting", "guide", "rules", "view"]
|
||||
weight = 400
|
||||
aliases = ["/docs/grafana/latest/alerting/pause-an-alert-rule/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/pause-an-alert-rule/"]
|
||||
+++
|
||||
|
||||
# Pause an alert rule
|
||||
|
||||
@@ -3,7 +3,7 @@ title = "Troubleshoot alerts"
|
||||
description = "Troubleshoot alert rules"
|
||||
keywords = ["grafana", "alerting", "guide", "rules", "troubleshoot"]
|
||||
weight = 500
|
||||
aliases = ["/docs/grafana/latest/alerting/troubleshoot-alerts/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/troubleshoot-alerts/"]
|
||||
+++
|
||||
|
||||
# Troubleshoot alerts
|
||||
|
||||
@@ -3,7 +3,7 @@ title = "View alerts"
|
||||
description = "View existing alert rules"
|
||||
keywords = ["grafana", "alerting", "guide", "rules", "view"]
|
||||
weight = 400
|
||||
aliases = ["/docs/grafana/latest/alerting/view-alerts/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/view-alerts/"]
|
||||
+++
|
||||
|
||||
# View existing alert rules
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Grafana alerts"
|
||||
aliases = ["/docs/grafana/latest/alerting/metrics/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/metrics/"]
|
||||
weight = 113
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Create and manage rules"
|
||||
aliases = ["/docs/grafana/latest/alerting/rules/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/rules/"]
|
||||
weight = 130
|
||||
+++
|
||||
|
||||
|
||||
+2
-2
@@ -29,10 +29,10 @@ For Cortex and Loki data sources to work with Grafana 8.0 alerting, enable the r
|
||||
- From the **Select data source** drop-down, select an external Prometheus, an external Loki, or a Grafana Cloud data source.
|
||||
- From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click **Add new** and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose.
|
||||
- From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-cortex-alert-type-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-alert-type-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
1. In Step 2, add the query to evaluate.
|
||||
- Enter a PromQL or LogQL expression. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series.
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-cortex-query-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-query-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
1. In Step 3, add additional metadata associated with the rule.
|
||||
- Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "./alert-annotation-label.md" >}}).
|
||||
- Add Runbook URL, panel, dashboard, and alert IDs.
|
||||
|
||||
+2
-2
@@ -31,10 +31,10 @@ Grafana allows you to create alerting rules for an external Cortex or Loki insta
|
||||
- From the **Select data source** drop-down, select an external Prometheus, an external Loki, or a Grafana Cloud data source.
|
||||
- From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click **Add new** and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Cortex or Loki rule groups and namespaces]({{< relref "./edit-cortex-loki-namespace-group.md" >}}).
|
||||
- From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-cortex-alert-type-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-alert-type-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
1. In Step 2, add the query to evaluate.
|
||||
- Enter a PromQL or LogQL expression. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series.
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-cortex-query-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-query-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
1. In Step 3, add conditions.
|
||||
- In the **For** text box, specify the duration for which the condition must be true before an alert fires. If you specify `5m`, the condition must be true for 5 minutes before the alert fires.
|
||||
> **Note:** Once a condition is met, the alert goes into the `Pending` state. If the condition remains active for the duration specified, the alert transitions to the `Firing` state, else it reverts to the `Normal` state.
|
||||
|
||||
+3
-3
@@ -9,9 +9,9 @@ weight = 405
|
||||
|
||||
A namespace contains one or more groups. The rules within a group are run sequentially at a regular interval. The default interval is one (1) minute. You can rename Cortex or Loki rule namespaces and groups, and edit group evaluation intervals.
|
||||
|
||||

|
||||

|
||||
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-list-edit-cortex-loki-icon-8-2.png" max-width="550px" caption="Alert details" >}}
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-list-edit-mimir-loki-icon-8-2.png" max-width="550px" caption="Alert details" >}}
|
||||
|
||||
## Rename a namespace
|
||||
|
||||
@@ -36,4 +36,4 @@ The rules within a group are run sequentially at a regular interval, the default
|
||||
|
||||
When you rename the group, a new group with all the rules from the old group is created. The old group is deleted.
|
||||
|
||||

|
||||

|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Alerting fundamentals"
|
||||
aliases = ["/docs/grafana/latest/alerting/metrics/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/metrics/"]
|
||||
weight = 120
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Alertmanager"
|
||||
aliases = ["/docs/grafana/latest/alerting/metrics/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/metrics/"]
|
||||
weight = 116
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Alerting on numeric data"
|
||||
aliases = ["/docs/grafana/latest/alerting/metrics/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/metrics/"]
|
||||
weight = 116
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Message templating"
|
||||
description = "Message templating"
|
||||
aliases = ["/docs/grafana/latest/alerting/message-templating/"]
|
||||
aliases = ["/docs/grafana/v8.3/alerting/message-templating/"]
|
||||
keywords = ["grafana", "alerting", "guide", "contact point", "templating"]
|
||||
weight = 440
|
||||
+++
|
||||
|
||||
@@ -7,23 +7,23 @@ keywords = ["grafana", "alerting", "guide", "contact point", "templating"]
|
||||
|
||||
Template functions allow you to process labels and annotations to generate dynamic notifications.
|
||||
|
||||
| Name | Argument type | Return type | Description |
|
||||
| ----------------------------------------- | ------------------------------------------------------------ | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [humanize](#humanize) | number or string | string | Converts a number to a more readable format, using metric prefixes. |
|
||||
| [humanize1024](#humanize1024) | number or string | string | Like humanize, but uses 1024 as the base rather than 1000. |
|
||||
| [humanizeDuration](#humanizeduration) | number or string | string | Converts a duration in seconds to a more readable format. |
|
||||
| [humanizePercentage](#humanizepercentage) | number or string | string | Converts a ratio value to a fraction of 100. |
|
||||
| [humanizeTimestamp](#humanizetimestamp) | number or string | string | Converts a Unix timestamp in seconds to a more readable format. |
|
||||
| [title](#title) | string | string | strings.Title, capitalises first character of each word. |
|
||||
| [toUpper](#toupper) | string | string | strings.ToUpper, converts all characters to upper case. |
|
||||
| [toLower](#tolower) | string | string | strings.ToLower, converts all characters to lower case. |
|
||||
| [match](#match) | pattern, text | boolean | regexp.MatchString Tests for a unanchored regexp match. |
|
||||
| [reReplaceAll](#rereplaceall) | pattern, replacement, text | string | Regexp.ReplaceAllString Regexp substitution, unanchored. |
|
||||
| [graphLink](#graphlink) | string - JSON Object with `"expr"` and `"datasource"` fields | string | Returns the path to graphical view in [Explore](https://grafana.com/docs/grafana/latest/explore/) for the given expression and data source. |
|
||||
| [tableLink](#tablelink) | string- JSON Object with `"expr"` and `"datasource"` fields | string | Returns the path to tabular view in [Explore](https://grafana.com/docs/grafana/latest/explore/) for the given expression and data source. |
|
||||
| [args](#args) | []interface{} | map[string]interface{} | Converts a list of objects to a map with keys, for example, arg0, arg1. Use this function to pass multiple arguments to templates. |
|
||||
| [externalURL](#externalurl) | nothing | string | Returns a string representing the external URL. |
|
||||
| [pathPrefix](#pathprefix) | nothing | string | Returns the path of the external URL. |
|
||||
| Name | Argument type | Return type | Description |
|
||||
| ----------------------------------------- | ------------------------------------------------------------ | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [humanize](#humanize) | number or string | string | Converts a number to a more readable format, using metric prefixes. |
|
||||
| [humanize1024](#humanize1024) | number or string | string | Like humanize, but uses 1024 as the base rather than 1000. |
|
||||
| [humanizeDuration](#humanizeduration) | number or string | string | Converts a duration in seconds to a more readable format. |
|
||||
| [humanizePercentage](#humanizepercentage) | number or string | string | Converts a ratio value to a fraction of 100. |
|
||||
| [humanizeTimestamp](#humanizetimestamp) | number or string | string | Converts a Unix timestamp in seconds to a more readable format. |
|
||||
| [title](#title) | string | string | strings.Title, capitalises first character of each word. |
|
||||
| [toUpper](#toupper) | string | string | strings.ToUpper, converts all characters to upper case. |
|
||||
| [toLower](#tolower) | string | string | strings.ToLower, converts all characters to lower case. |
|
||||
| [match](#match) | pattern, text | boolean | regexp.MatchString Tests for a unanchored regexp match. |
|
||||
| [reReplaceAll](#rereplaceall) | pattern, replacement, text | string | Regexp.ReplaceAllString Regexp substitution, unanchored. |
|
||||
| [graphLink](#graphlink) | string - JSON Object with `"expr"` and `"datasource"` fields | string | Returns the path to graphical view in [Explore](https://grafana.com/docs/grafana/v8.3/explore/) for the given expression and data source. |
|
||||
| [tableLink](#tablelink) | string- JSON Object with `"expr"` and `"datasource"` fields | string | Returns the path to tabular view in [Explore](https://grafana.com/docs/grafana/v8.3/explore/) for the given expression and data source. |
|
||||
| [args](#args) | []interface{} | map[string]interface{} | Converts a list of objects to a map with keys, for example, arg0, arg1. Use this function to pass multiple arguments to templates. |
|
||||
| [externalURL](#externalurl) | nothing | string | Returns a string representing the external URL. |
|
||||
| [pathPrefix](#pathprefix) | nothing | string | Returns the path of the external URL. |
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Auth Proxy"
|
||||
description = "Grafana Auth Proxy Guide "
|
||||
keywords = ["grafana", "configuration", "documentation", "proxy"]
|
||||
aliases = ["/docs/grafana/latest/tutorials/authproxy/"]
|
||||
aliases = ["/docs/grafana/v8.3/tutorials/authproxy/"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "LDAP Authentication"
|
||||
description = "Grafana LDAP Authentication Guide "
|
||||
keywords = ["grafana", "configuration", "documentation", "ldap", "active directory"]
|
||||
aliases = ["/docs/grafana/latest/installation/ldap/"]
|
||||
aliases = ["/docs/grafana/v8.3/installation/ldap/"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "SAML Authentication"
|
||||
description = "Grafana SAML Authentication"
|
||||
keywords = ["grafana", "saml", "documentation", "saml-auth"]
|
||||
aliases = ["/docs/grafana/latest/auth/saml/"]
|
||||
aliases = ["/docs/grafana/v8.3/auth/saml/"]
|
||||
weight = 1100
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Team Sync"
|
||||
description = "Grafana Team Sync"
|
||||
keywords = ["grafana", "auth", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/auth/saml/"]
|
||||
aliases = ["/docs/grafana/v8.3/auth/saml/"]
|
||||
weight = 1200
|
||||
+++
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ weight = 15
|
||||
|
||||
This section provides basic information about observability topics in general and Grafana in particular. These topics will help people who are just starting out with observability and monitoring.
|
||||
|
||||
{{< docs/shared "basics/what-is-grafana.md" >}}
|
||||
{{< docs/shared lookup="basics/what-is-grafana.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
{{< docs/shared "basics/grafana-cloud.md" >}}
|
||||
{{< docs/shared lookup="basics/grafana-cloud.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
{{< docs/shared "basics/grafana-enterprise.md" >}}
|
||||
{{< docs/shared lookup="basics/grafana-enterprise.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Glossary"
|
||||
description = "Grafana glossary"
|
||||
keywords = ["grafana", "intro", "glossary", "dictionary"]
|
||||
aliases = ["/docs/grafana/latest/guides/glossary", "/docs/grafana/latest/getting-started/glossary"]
|
||||
aliases = ["/docs/grafana/v8.3/guides/glossary", "/docs/grafana/v8.3/getting-started/glossary"]
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
@@ -44,7 +44,7 @@ This topic lists words and abbreviations that are commonly used in the Grafana d
|
||||
<tr>
|
||||
<td style="vertical-align: top">Explore</td>
|
||||
<td>
|
||||
Explore allows a user to focus on building a query. Users can refine the query to return the expected metrics before building a dashboard. For more information, refer to the <a href="https://grafana.com/docs/grafana/latest/explore">Explore</a> topic.
|
||||
Explore allows a user to focus on building a query. Users can refine the query to return the expected metrics before building a dashboard. For more information, refer to the <a href="https://grafana.com/docs/grafana/v8.3/explore">Explore</a> topic.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -116,7 +116,7 @@ This topic lists words and abbreviations that are commonly used in the Grafana d
|
||||
<tr>
|
||||
<td style="vertical-align: top">transformation</td>
|
||||
<td>
|
||||
Transformations process the result set of a query before it’s passed on for visualization. For more information, refer to the <a href="https://grafana.com/docs/grafana/latest/panels/transformations">Transformations overview</a> topic.
|
||||
Transformations process the result set of a query before it’s passed on for visualization. For more information, refer to the <a href="https://grafana.com/docs/grafana/v8.3/panels/transformations">Transformations overview</a> topic.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Histograms and heatmaps"
|
||||
description = "An introduction to histograms and heatmaps"
|
||||
keywords = ["grafana", "heatmap", "panel", "documentation", "histogram"]
|
||||
aliases = ["/docs/grafana/latest/getting-started/intro-histograms"]
|
||||
aliases = ["/docs/grafana/v8.3/getting-started/intro-histograms"]
|
||||
weight = 700
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Time series dimensions"
|
||||
description = "time series dimensions"
|
||||
keywords = ["grafana", "intro", "guide", "concepts", "timeseries", "labels"]
|
||||
aliases = ["/docs/grafana/latest/guides/timeseries-dimensions", "/docs/grafana/latest/getting-started/timeseries-dimensions"]
|
||||
aliases = ["/docs/grafana/v8.3/guides/timeseries-dimensions", "/docs/grafana/v8.3/getting-started/timeseries-dimensions"]
|
||||
weight = 600
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Common observability strategies"
|
||||
description = "Common observability strategies"
|
||||
keywords = ["grafana", "intro", "guide", "concepts", "methods"]
|
||||
aliases = ["/docs/grafana/latest/getting-started/strategies/"]
|
||||
aliases = ["/docs/grafana/v8.3/getting-started/strategies/"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Dashboards"
|
||||
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/dashboard/dashboards/"]
|
||||
weight = 80
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Annotations"
|
||||
keywords = ["grafana", "annotations", "documentation", "guide"]
|
||||
aliases = ["/docs/grafana/latest/reference/annotations/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/annotations/"]
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Dashboard Folders"
|
||||
keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"]
|
||||
aliases = ["/docs/grafana/latest/reference/dashboard_folders/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/dashboard_folders/"]
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Dashboard Version History"
|
||||
keywords = ["grafana", "dashboard", "documentation", "version", "history"]
|
||||
aliases = ["/docs/grafana/latest/reference/dashboard_history/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/dashboard_history/"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Export and import"
|
||||
keywords = ["grafana", "dashboard", "documentation", "export", "import"]
|
||||
aliases = ["/docs/grafana/latest/reference/export_import/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/export_import/"]
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "JSON model"
|
||||
keywords = ["grafana", "dashboard", "documentation", "json", "model"]
|
||||
aliases = ["/docs/grafana/latest/reference/dashboard/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/dashboard/"]
|
||||
weight = 1200
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Playlist"
|
||||
keywords = ["grafana", "dashboard", "documentation", "playlist"]
|
||||
aliases = ["/docs/grafana/latest/reference/playlist/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/playlist/"]
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Reporting"
|
||||
description = ""
|
||||
keywords = ["grafana", "reporting"]
|
||||
aliases = ["/docs/grafana/latest/administration/reports"]
|
||||
aliases = ["/docs/grafana/v8.3/administration/reports"]
|
||||
weight = 8
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Scripted dashboards"
|
||||
keywords = ["grafana", "dashboard", "documentation", "scripted"]
|
||||
aliases = ["/docs/grafana/latest/reference/scripting/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/scripting/"]
|
||||
weight = 1500
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Search"
|
||||
keywords = ["grafana", "dashboard", "documentation", "search"]
|
||||
aliases =["/docs/grafana/latest/reference/search/"]
|
||||
aliases =["/docs/grafana/v8.3/reference/search/"]
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Time range controls"
|
||||
keywords = ["grafana", "dashboard", "documentation", "time range"]
|
||||
aliases = ["/docs/grafana/latest/reference/timerange/"]
|
||||
aliases = ["/docs/grafana/v8.3/reference/timerange/"]
|
||||
weight = 7
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Data sources"
|
||||
aliases = ["/docs/grafana/latest/datasources/overview/"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/overview/"]
|
||||
weight = 60
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Add data source"
|
||||
aliases = ["/docs/grafana/latest/features/datasources/add-a-data-source/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/add-a-data-source/"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
title = "Alertmanager"
|
||||
description = "Guide for using Alertmanager in Grafana"
|
||||
keywords = ["grafana", "prometheus", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/alertmanager"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/alertmanager"]
|
||||
weight = 150
|
||||
+++
|
||||
|
||||
# Alertmanager data source
|
||||
|
||||
Grafana includes built-in support for Prometheus Alertmanager. It is presently in alpha and not accessible unless [alpha plugins are enabled in Grafana settings](https://grafana.com/docs/grafana/latest/administration/configuration/#enable_alpha). Once you add it as a data source, you can use the [Grafana alerting UI](https://grafana.com/docs/grafana/latest/alerting/) to manage silences, contact points as well as notification policies. A drop-down option in these pages allows you to switch between Grafana and any configured Alertmanager data sources.
|
||||
Grafana includes built-in support for Prometheus Alertmanager. It is presently in alpha and not accessible unless [alpha plugins are enabled in Grafana settings](https://grafana.com/docs/grafana/v8.3/administration/configuration/#enable_alpha). Once you add it as a data source, you can use the [Grafana alerting UI](https://grafana.com/docs/grafana/v8.3/alerting/) to manage silences, contact points as well as notification policies. A drop-down option in these pages allows you to switch between Grafana and any configured Alertmanager data sources.
|
||||
|
||||
## Alertmanager implementations
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "AWS CloudWatch"
|
||||
description = "Guide for using CloudWatch in Grafana"
|
||||
keywords = ["grafana", "cloudwatch", "guide"]
|
||||
aliases = ["/docs/grafana/latest/datasources/cloudwatch"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/cloudwatch"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
@@ -119,7 +119,7 @@ You can monitor a dynamic list of metrics by using the asterisk (\*) wildcard fo
|
||||
|
||||
In this example, the query returns all metrics in the namespace `AWS/EC2` with a metric name of `CPUUtilization` and ANY value for the `InstanceId` dimension are queried. This can help you monitor metrics for AWS resources, like EC2 instances or containers. When new instances are created as part of an auto scaling event, they will automatically appear in the graph without you having to track the new instance IDs. This capability is currently limited to retrieving up to 100 metrics.
|
||||
|
||||
You can expand the [Query inspector](https://grafana.com/docs/grafana/latest/panels/queries/#query-inspector-button) button and click `Meta Data` to see the search expression that is automatically built to support wildcards. To learn more about search expressions, visit the [CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html). By default, the search expression is defined in such a way that the queried metrics must match the defined dimension names exactly. This means that in the example only metrics with exactly one dimension with the name ‘InstanceId’ will be returned.
|
||||
You can expand the [Query inspector](https://grafana.com/docs/grafana/v8.3/panels/queries/#query-inspector-button) button and click `Meta Data` to see the search expression that is automatically built to support wildcards. To learn more about search expressions, visit the [CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html). By default, the search expression is defined in such a way that the queried metrics must match the defined dimension names exactly. This means that in the example only metrics with exactly one dimension with the name ‘InstanceId’ will be returned.
|
||||
|
||||

|
||||
|
||||
@@ -261,11 +261,11 @@ For more information on Grafana alerts, refer to [Alerting]({{< relref "../../al
|
||||
|
||||
The Grafana [configuration]({{< relref "../../administration/configuration.md#aws" >}}) file includes an `AWS` section where you can customize the data source.
|
||||
|
||||
| Configuration option | Description |
|
||||
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `allowed_auth_providers` | Specifies which authentication providers are allowed for the CloudWatch data source. The following providers are enabled by default in OSS Grafana: `default` (AWS SDK default), keys (Access and secret key), credentials (Credentials file), ec2_IAM_role (EC2 IAM role). |
|
||||
| `assume_role_enabled` | Allows you to disable `assume role (ARN)` in the CloudWatch data source. By default, assume role (ARN) is enabled for OSS Grafana. |
|
||||
| `list_metrics_page_limit` | When a custom namespace is specified in the query editor, the [List Metrics API](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) is used to populate the _Metrics_ field and the _Dimension_ fields. The API is paginated and returns up to 500 results per page. The CloudWatch data source also limits the number of pages to 500. However, you can change this limit using the `list_metrics_page_limit` variable in the [grafana configuration file](https://grafana.com/docs/grafana/latest/administration/configuration/#aws). |
|
||||
| Configuration option | Description |
|
||||
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `allowed_auth_providers` | Specifies which authentication providers are allowed for the CloudWatch data source. The following providers are enabled by default in OSS Grafana: `default` (AWS SDK default), keys (Access and secret key), credentials (Credentials file), ec2_IAM_role (EC2 IAM role). |
|
||||
| `assume_role_enabled` | Allows you to disable `assume role (ARN)` in the CloudWatch data source. By default, assume role (ARN) is enabled for OSS Grafana. |
|
||||
| `list_metrics_page_limit` | When a custom namespace is specified in the query editor, the [List Metrics API](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) is used to populate the _Metrics_ field and the _Dimension_ fields. The API is paginated and returns up to 500 results per page. The CloudWatch data source also limits the number of pages to 500. However, you can change this limit using the `list_metrics_page_limit` variable in the [grafana configuration file](https://grafana.com/docs/grafana/v8.3/administration/configuration/#aws). |
|
||||
|
||||
## Pricing
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Authentication"
|
||||
description = "AWS authentication"
|
||||
keywords = ["grafana", "aws", "authentication"]
|
||||
aliases = ["/docs/grafana/latest/datasources/cloudwatch"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/cloudwatch"]
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Curated CloudWatch dashboards"
|
||||
description = "Guide for using AWS CloudWatch in Grafana"
|
||||
keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"]
|
||||
aliases = ["/docs/grafana/latest/datasources/cloudwatch"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/cloudwatch"]
|
||||
weight = 15
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Provision CloudWatch"
|
||||
description = "Guide for provisioning CloudWatch"
|
||||
weight = 400
|
||||
aliases = ["/docs/grafana/latest/datasources/cloudwatch"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/cloudwatch"]
|
||||
+++
|
||||
|
||||
# Provision CloudWatch data source
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Template variables in CloudWatch query"
|
||||
description = "Template variables in CloudWatch queryh"
|
||||
weight = 10
|
||||
aliases = ["/docs/grafana/latest/datasources/cloudwatch"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/cloudwatch"]
|
||||
+++
|
||||
|
||||
# Using template variables in CloudWatch queries
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Azure Monitor"
|
||||
description = "Guide for using Azure Monitor in Grafana"
|
||||
keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/azuremonitor"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/azuremonitor"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
@@ -265,7 +265,7 @@ See the following topics to learn more about the Azure Monitor data source:
|
||||
|
||||
Customers who host Grafana in Azure (e.g. App Service, Azure Virtual Machines) and have managed identity enabled on their VM, will now be able to use the managed identity to configure Azure Monitor in Grafana. This will simplify the data source configuration, requiring the data source to be securely authenticated without having to manually configure credentials via Azure AD App Registrations for each data source. For more details on Azure managed identities, refer to the [Azure documentation](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview).
|
||||
|
||||
To enable managed identity for Grafana, set the `managed_identity_enabled` flag in the `[azure]` section of the [Grafana server config](https://grafana.com/docs/grafana/latest/administration/configuration/#azure).
|
||||
To enable managed identity for Grafana, set the `managed_identity_enabled` flag in the `[azure]` section of the [Grafana server config](https://grafana.com/docs/grafana/v8.3/administration/configuration/#azure).
|
||||
|
||||
```ini
|
||||
[azure]
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Elasticsearch"
|
||||
description = "Guide for using Elasticsearch in Grafana"
|
||||
keywords = ["grafana", "elasticsearch", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/elasticsearch"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/elasticsearch"]
|
||||
weight = 325
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Google Cloud Monitoring"
|
||||
description = "Guide for using Google Cloud Monitoring in Grafana"
|
||||
keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/stackdriver", "/docs/grafana/next/datasources/cloudmonitoring/", "/docs/grafana/next/features/datasources/cloudmonitoring/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/stackdriver", "/docs/grafana/next/datasources/cloudmonitoring/", "/docs/grafana/next/features/datasources/cloudmonitoring/"]
|
||||
weight = 350
|
||||
+++
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
title = "Preconfigured dashboards"
|
||||
description = "Guide for using Google Cloud Monitoring in Grafana"
|
||||
keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/stackdriver", "/docs/grafana/next/features/datasources/cloudmonitoring/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/stackdriver", "/docs/grafana/next/features/datasources/cloudmonitoring/"]
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Graphite"
|
||||
description = "Guide for using graphite in Grafana"
|
||||
keywords = ["grafana", "graphite", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/graphite"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/graphite"]
|
||||
weight = 600
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
title = "InfluxDB data source"
|
||||
description = "Guide for using InfluxDB in Grafana"
|
||||
keywords = ["grafana", "influxdb", "guide", "flux"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/influxdb", "/docs/grafana/latest/datasources/influxdb"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/influxdb", "/docs/grafana/v8.3/datasources/influxdb"]
|
||||
weight = 700
|
||||
+++
|
||||
|
||||
# InfluxDB data source
|
||||
|
||||
{{< docs/shared "influxdb/intro.md" >}}
|
||||
{{< docs/shared lookup="influxdb/intro.md" source="grafana" version="<GRAFANA VERSION>" >}}
|
||||
|
||||
This topic explains options, variables, querying, and other options specific to this data source. Refer to [Add a data source]({{< relref "../add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Jaeger"
|
||||
description = "Guide for using Jaeger in Grafana"
|
||||
keywords = ["grafana", "jaeger", "guide", "tracing"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/jaeger"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/jaeger"]
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Loki"
|
||||
description = "Guide for using Loki in Grafana"
|
||||
keywords = ["grafana", "loki", "logging", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/loki"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/loki"]
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Microsoft SQL Server"
|
||||
description = "Guide for using Microsoft SQL Server in Grafana"
|
||||
keywords = ["grafana", "MSSQL", "Microsoft", "SQL", "guide", "Azure SQL Database"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/mssql/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/mssql/"]
|
||||
weight = 900
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "MySQL"
|
||||
description = "Guide for using MySQL in Grafana"
|
||||
keywords = ["grafana", "mysql", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/mysql/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/mysql/"]
|
||||
weight = 1000
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "OpenTSDB"
|
||||
description = "Guide for using OpenTSDB in Grafana"
|
||||
keywords = ["grafana", "opentsdb", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/opentsdb", "/docs/grafana/latest/features/datasources/opentsdb/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/opentsdb", "/docs/grafana/v8.3/features/datasources/opentsdb/"]
|
||||
weight = 1100
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "PostgreSQL"
|
||||
description = "Guide for using PostgreSQL in Grafana"
|
||||
keywords = ["grafana", "postgresql", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/postgres/"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/postgres/"]
|
||||
weight = 1200
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Prometheus"
|
||||
description = "Guide for using Prometheus in Grafana"
|
||||
keywords = ["grafana", "prometheus", "guide"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/prometheus"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/prometheus"]
|
||||
weight = 1300
|
||||
+++
|
||||
|
||||
@@ -10,7 +10,7 @@ weight = 1300
|
||||
|
||||
Grafana includes built-in support for Prometheus. This topic explains options, variables, querying, and other options specific to the Prometheus data source. Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources.
|
||||
|
||||
> **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more.[Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text).
|
||||
> **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more. [Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text).
|
||||
|
||||
## Prometheus settings
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Tempo"
|
||||
description = "High volume, minimal dependency trace storage. OSS tracing solution from Grafana Labs."
|
||||
keywords = ["grafana", "tempo", "guide", "tracing"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/tempo"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/tempo"]
|
||||
weight = 1400
|
||||
+++
|
||||
|
||||
@@ -130,7 +130,7 @@ To display the service graph:
|
||||
- Select the **Service Graph** query type and run the query
|
||||
- Optionally, filter by service name
|
||||
|
||||
You can pan and zoom the view with buttons or you mouse. For details about the visualization, refer to [Node graph panel](https://grafana.com/docs/grafana/latest/panels/visualizations/node-graph/).
|
||||
You can pan and zoom the view with buttons or you mouse. For details about the visualization, refer to [Node graph panel](https://grafana.com/docs/grafana/v8.3/panels/visualizations/node-graph/).
|
||||
|
||||
Each service in the graph is represented as a circle. Numbers on the inside shows average time per request and request per second.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "TestData"
|
||||
keywords = ["grafana", "dashboard", "documentation", "panels", "testdata"]
|
||||
aliases = ["/docs/grafana/latest/features/datasources/testdata"]
|
||||
aliases = ["/docs/grafana/v8.3/features/datasources/testdata"]
|
||||
weight = 1500
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title = "Zipkin"
|
||||
description = "Guide for using Zipkin in Grafana"
|
||||
keywords = ["grafana", "zipkin", "guide", "tracing"]
|
||||
aliases = ["/docs/grafana/latest/datasources/zipkin"]
|
||||
aliases = ["/docs/grafana/v8.3/datasources/zipkin"]
|
||||
weight = 1600
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Developers"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/"]
|
||||
weight = 190
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Contributor License Agreement (CLA)"
|
||||
description = "Contributor License Agreement (CLA)"
|
||||
aliases = ["/docs/grafana/latest/project/cla", "docs/contributing/cla.html"]
|
||||
aliases = ["/docs/grafana/v8.3/project/cla", "docs/contributing/cla.html"]
|
||||
+++
|
||||
|
||||
# Grafana Labs Software Grant and Contributor License Agreement ("Agreement")
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Build a plugin"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/"]
|
||||
+++
|
||||
|
||||
# Build a plugin
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Add authentication for data source plugins"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/auth-for-datasources/", "/docs/grafana/next/developers/plugins/authentication/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/auth-for-datasources/", "/docs/grafana/next/developers/plugins/authentication/"]
|
||||
+++
|
||||
|
||||
# Add authentication for data source plugins
|
||||
@@ -23,7 +23,7 @@ Users with the _Viewer_ role can access data source configuration—such as the
|
||||
|
||||
> **Note:** You can see the settings that the current user has access to by entering `window.grafanaBootData` in the developer console of your browser.
|
||||
|
||||
> **Note:** Users of [Grafana Enterprise](https://grafana.com/products/enterprise/grafana/) can restrict access to data sources to specific users and teams. For more information, refer to [Data source permissions](https://grafana.com/docs/grafana/latest/enterprise/datasource_permissions).
|
||||
> **Note:** Users of [Grafana Enterprise](https://grafana.com/products/enterprise/grafana/) can restrict access to data sources to specific users and teams. For more information, refer to [Data source permissions](https://grafana.com/docs/grafana/v8.3/enterprise/datasource_permissions).
|
||||
|
||||
If you need to store sensitive information, such as passwords, tokens and API keys, use `secureJsonData` instead. Whenever the user saves the data source configuration, the secrets in `secureJsonData` are sent to the Grafana server and encrypted before they're stored.
|
||||
|
||||
@@ -108,7 +108,7 @@ The Grafana server comes with a proxy that lets you define templates for your re
|
||||
|
||||
### Add a proxy route to your plugin
|
||||
|
||||
To forward requests through the Grafana proxy, you need to configure one or more proxy routes. A proxy route is a template for any outgoing request that is handled by the proxy. You can configure proxy routes in the [plugin.json](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/) file.
|
||||
To forward requests through the Grafana proxy, you need to configure one or more proxy routes. A proxy route is a template for any outgoing request that is handled by the proxy. You can configure proxy routes in the [plugin.json](https://grafana.com/docs/grafana/v8.3/developers/plugins/metadata/) file.
|
||||
|
||||
1. Add the route to plugin.json. Note that you need to restart the Grafana server every time you make a change to your plugin.json file.
|
||||
|
||||
|
||||
@@ -100,4 +100,4 @@ const firstResult = new MutableDataFrame({
|
||||
});
|
||||
```
|
||||
|
||||
For possible options, refer to [PreferredVisualisationType](https://grafana.com/docs/grafana/latest/packages_api/data/preferredvisualisationtype/).
|
||||
For possible options, refer to [PreferredVisualisationType](https://grafana.com/docs/grafana/v8.3/packages_api/data/preferredvisualisationtype/).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Backend plugins"
|
||||
keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/backend-plugins-guide/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/backend-plugins-guide/"]
|
||||
+++
|
||||
|
||||
# Backend plugins
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Legacy plugins"
|
||||
aliases = ["/docs/grafana/latest/plugins/development/", "/docs/grafana/next/plugins/datasources/", "/docs/grafana/next/plugins/apps/", "/docs/grafana/next/plugins/panels/", "/docs/grafana/next/plugins/developing/development/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/development/", "/docs/grafana/next/plugins/datasources/", "/docs/grafana/next/plugins/apps/", "/docs/grafana/next/plugins/panels/", "/docs/grafana/next/plugins/developing/development/"]
|
||||
+++
|
||||
|
||||
# Legacy plugins
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Legacy app plugins"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/apps/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/apps/"]
|
||||
+++
|
||||
|
||||
# Legacy app plugins
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Legacy data source plugins"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/datasources/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/datasources/"]
|
||||
+++
|
||||
|
||||
# Legacy data source plugins
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Legacy defaults and editor mode"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/defaults-and-editor-mode/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/defaults-and-editor-mode/"]
|
||||
+++
|
||||
|
||||
# Legacy defaults and editor mode
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Legacy panel plugins"
|
||||
keywords = ["grafana", "plugins", "panel", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/panels/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/panels/"]
|
||||
+++
|
||||
|
||||
# Legacy panel plugins
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Legacy review guidelines"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/plugin-review-guidelines/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/plugin-review-guidelines/"]
|
||||
+++
|
||||
|
||||
# Legacy review guidelines
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Legacy snapshot mode"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/snapshot-mode/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/snapshot-mode/"]
|
||||
+++
|
||||
|
||||
# Legacy snapshot mode
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Legacy code style guide"
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/code-styleguide/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/code-styleguide/"]
|
||||
+++
|
||||
|
||||
# Legacy code style guide
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
# -------------------------------------------------------------------------
|
||||
title = "plugin.json"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/plugin.json/"]
|
||||
+++
|
||||
|
||||
# plugin.json
|
||||
@@ -34,7 +34,7 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans
|
||||
| `metrics` | boolean | No | For data source plugins, if the plugin supports metric queries. Used in Explore. |
|
||||
| `preload` | boolean | No | Initialize plugin on startup. By default, the plugin initializes on first use. |
|
||||
| `queryOptions` | [object](#queryoptions) | No | For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed. |
|
||||
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/). |
|
||||
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/v8.3/developers/plugins/authentication/). |
|
||||
| `skipDataQuery` | boolean | No | For panel plugins. Hides the query editor. |
|
||||
| `state` | string | No | Marks a plugin as a pre-release. Possible values are: `alpha`, `beta`. |
|
||||
| `streaming` | boolean | No | For data source plugins, if the plugin supports streaming. |
|
||||
@@ -180,7 +180,7 @@ For data source plugins. There is a query options section in the plugin's query
|
||||
|
||||
## routes
|
||||
|
||||
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).
|
||||
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/v8.3/developers/plugins/authentication/).
|
||||
|
||||
### Properties
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
# -------------------------------------------------------------------------
|
||||
title = "plugin.json"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"]
|
||||
aliases = ["/docs/grafana/v8.3/plugins/developing/plugin.json/"]
|
||||
+++
|
||||
|
||||
{{ .Markdown 1 }}
|
||||
|
||||
@@ -174,9 +174,9 @@ func (d *SampleDatasource) CheckHealth(_ context.Context, req *backend.CheckHeal
|
||||
|
||||
We strongly recommend that you not allow unsigned plugins in your Grafana installation. By allowing unsigned plugins, we cannot guarantee the authenticity of the plugin, which could compromise the security of your Grafana installation.
|
||||
|
||||
To sign your plugin, see [Sign a plugin](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#sign-a-plugin).
|
||||
To sign your plugin, see [Sign a plugin](https://grafana.com/docs/grafana/v8.3/developers/plugins/sign-a-plugin/#sign-a-plugin).
|
||||
|
||||
You can still run and develop an unsigned plugin by running your Grafana instance in [development mode](https://grafana.com/docs/grafana/latest/administration/configuration/#app_mode). Alternatively, you can use the [allow_loading_unsigned_plugins configuration setting.]({{< relref "../../administration/#allow_loading_unsigned_plugins" >}})
|
||||
You can still run and develop an unsigned plugin by running your Grafana instance in [development mode](https://grafana.com/docs/grafana/v8.3/administration/configuration/#app_mode). Alternatively, you can use the [allow_loading_unsigned_plugins configuration setting.]({{< relref "../../administration/#allow_loading_unsigned_plugins" >}})
|
||||
|
||||
### Update react-hook-form from v6 to v7
|
||||
|
||||
@@ -482,9 +482,9 @@ Before 7.0, data source and panel plugins exchanged data using either time serie
|
||||
|
||||
Grafana 7.0 is backward compatible with the old data format used in previous versions. Panels and data sources using the old format will still work with plugins using the new data frame format.
|
||||
|
||||
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://grafana.com/docs/grafana/latest/packages_api/data/legacyresponsedata/) or a [DataFrame](https://grafana.com/docs/grafana/latest/packages_api/data/dataframe/).
|
||||
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://grafana.com/docs/grafana/v8.3/packages_api/data/legacyresponsedata/) or a [DataFrame](https://grafana.com/docs/grafana/v8.3/packages_api/data/dataframe/).
|
||||
|
||||
The [toDataFrame()](https://grafana.com/docs/grafana/latest/packages_api/data/todataframe/) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format.
|
||||
The [toDataFrame()](https://grafana.com/docs/grafana/v8.3/packages_api/data/todataframe/) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format.
|
||||
|
||||
```ts
|
||||
import { toDataFrame } from '@grafana/data';
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Package a plugin"
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/developers/plugins/share-a-plugin/"]
|
||||
aliases = ["/docs/grafana/v8.3/developers/plugins/share-a-plugin/"]
|
||||
+++
|
||||
|
||||
# Package a plugin
|
||||
|
||||
@@ -328,10 +328,10 @@
|
||||
},
|
||||
"routes": {
|
||||
"type": "array",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/v8.3/developers/plugins/authentication/).",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/v8.3/developers/plugins/authentication/).",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"path": {
|
||||
|
||||
@@ -11,7 +11,7 @@ You can choose to encrypt secrets stored in the Grafana database using a key fro
|
||||
|
||||
Grafana integrates with the following key management systems:
|
||||
|
||||
- [AWS KMS]({{< relref "/using-aws-kms-to-encrypt-database-secrets.md" >}})
|
||||
- [Azure Key Vault]({{< relref "/using-azure-key-vault-to-encrypt-database-secrets.md" >}})
|
||||
- [AWS KMS]({{< relref "./using-aws-kms-to-encrypt-database-secrets.md" >}})
|
||||
- [Azure Key Vault]({{< relref "./using-azure-key-vault-to-encrypt-database-secrets.md" >}})
|
||||
|
||||
Refer to [Database encryption]({{< relref "../../administration/database-encryption.md" >}}) to learn more about how Grafana encrypts secrets in the database.
|
||||
|
||||
+1
-1
@@ -70,7 +70,7 @@ You can use an encryption key from AWS Key Management Service to encrypt secrets
|
||||
|
||||
**> Note:** The encryption key that is stored in the `secret_key` field is still used by Grafana’s legacy alerting system to encrypt secrets, for decrypting existing secrets, or it is used as the default provider when external providers are not configured. Do not change or remove that value when adding a new KMS provider.
|
||||
|
||||
7. [Restart Grafana](https://grafana.com/docs/grafana/latest/installation/restart-grafana/).
|
||||
7. [Restart Grafana](https://grafana.com/docs/grafana/v8.3/installation/restart-grafana/).
|
||||
|
||||
8. (Optional) From the command line and the root directory of Grafana, re-encrypt all of the secrets within the Grafana database with the new key using the following command:
|
||||
|
||||
|
||||
+1
-1
@@ -68,7 +68,7 @@ You can use an encryption key from Azure Key Vault to encrypt secrets in the Gra
|
||||
|
||||
**> Note:** The encryption key stored in the `secret_key` field is still used by Grafana’s legacy alerting system to encrypt secrets. Do not change or remove that value.
|
||||
|
||||
9. [Restart Grafana](https://grafana.com/docs/grafana/latest/installation/restart-grafana/).
|
||||
9. [Restart Grafana](https://grafana.com/docs/grafana/v8.3/installation/restart-grafana/).
|
||||
|
||||
10. (Optional) From the command line and the root directory of Grafana Enterprise, re-encrypt all of the secrets within the Grafana database with the new key using the following command:
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
title = "About Grafana Enterprise licenses from AWS Marketplace"
|
||||
description = "About Grafana Enterprise licenses from AWS Marketplace"
|
||||
keywords = ["grafana", "about", "enterprise", "overview", "aws", "marketplace"]
|
||||
aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/about-ge-license-through-aws"]
|
||||
aliases = ["/docs/grafana/v8.3/enterprise/activate-aws-marketplace-license/about-ge-license-through-aws"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
title = "Activate a Grafana Enterprise license from AWS Marketplace on ECS"
|
||||
description = "Activate a Grafana Enterprise license from AWS Marketplace on ECS"
|
||||
keywords = ["grafana", "ecs", "enterprise", "aws", "marketplace", "activate"]
|
||||
aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-ecs"]
|
||||
aliases = ["/docs/grafana/v8.3/enterprise/activate-aws-marketplace-license/activate-license-on-ecs"]
|
||||
weight = 250
|
||||
+++
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
title = "Activate a Grafana Enterprise license from AWS Marketplace on EKS"
|
||||
description = "Activate a Grafana Enterprise license from AWS Marketplace on EKS"
|
||||
keywords = ["grafana", "enterprise", "aws", "marketplace", "eks", "activate"]
|
||||
aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-eks"]
|
||||
aliases = ["/docs/grafana/v8.3/enterprise/activate-aws-marketplace-license/activate-license-on-eks"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user