public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "[v9.5.x] Update cascading front matter to use sequence form" (#69378)

Browse Source 
Revert "[v9.5.x] Update cascading front matter to use sequence form (#69327)"

This reverts commit 0f9f72d46b.
This commit is contained in:
Jack Baldry
2023-06-01 14:48:47 +01:00
committed by GitHub
parent a3c8fd3e9b
commit e4fb61b854
26 changed files with 173 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/_index.md
-186
View File
@@ -3,192 +3,6 @@ aliases:
- /docs/grafana/v1.1/
- /docs/grafana/v3.1/
- guides/reference/admin/
cascade:
# Until a better mechanism for arrangement is thought of, the following sequence should be ordered alphabetically by the `_target.path` value.
- _target: { path: /docs/grafana/** } # Default to every page having "Enterprise" and "Open source" labels.
labels:
products:
- enterprise
- oss
- _target: { path: /docs/grafana/** }
labels:
products:
- enterprise
- oss
- _target: { path: /docs/grafana/*/administration/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/administration/enterprise-licensing/** }
labels:
products:
- enterprise
- _target: { path: /docs/grafana/*/administration/organization-management/** }
labels:
products:
- enterprise
- oss
- _target: { path: /docs/grafana/*/administration/provisioning/** }
labels:
products:
- enterprise
- oss
- _target: { path: /docs/grafana/*/administration/recorded-queries/** }
labels:
products:
- cloud
- enterprise
- _target: { path: /docs/grafana/*/administration/roles-and-permissions/access-control/** }
labels:
products:
- cloud
- enterprise
- _target: { path: /docs/grafana/*/administration/stats-and-license/** }
labels:
products:
- enterprise
- oss
- _target: { path: /docs/grafana/*/alerting/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/dashboards/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/datasources/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/explore/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/fundamentals/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/introduction/grafana-cloud/** }
labels:
products:
- cloud
- _target: { path: /docs/grafana/*/introduction/grafana-enterprise/** }
labels:
products:
- enterprise
- _target: { path: /docs/grafana/*/panels-visualizations/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/release-notes/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/search/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/audit-grafana/** }
labels:
products:
- cloud
- enterprise
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/enhanced-ldap/** }
labels:
products:
- cloud
- enterprise
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/saml/** }
labels:
products:
- cloud
- enterprise
- _target:
path: /docs/grafana/*/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/**
labels:
products:
- cloud
- enterprise
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-request-security/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-team-sync/** }
labels:
products:
- cloud
- enterprise
- _target: { path: /docs/grafana/*/setup-grafana/configure-security/export-logs/** }
labels:
products:
- cloud
- oss
- _target: { path: /docs/grafana/*/troubleshooting/** }
labels:
products:
- cloud
- enterprise
- oss
- _target: { path: /docs/grafana/*/whatsnew/** }
labels:
products:
- cloud
- enterprise
- oss
description: Guides, installation, and feature documentation
keywords:
- grafana
docs/sources/administration/_index.md
+6
View File
@@ -1,4 +1,10 @@
---
cascade:
labels:
products:
- cloud
- enterprise
- oss
description: Administration
title: Administration
weight: 40
docs/sources/administration/enterprise-licensing/_index.md
+4
View File
@@ -8,6 +8,10 @@ aliases:
- ../enterprise/license/license-expiration/
- ../enterprise/license/license-restrictions/
- license-restrictions/
cascade:
labels:
products:
- enterprise
description: Activate and manage a Grafana Enterprise license
keywords:
- grafana
docs/sources/administration/organization-management/index.md
+4
View File
@@ -8,6 +8,10 @@ description: Describes how to use organizations to isolate dashboard to users an
keywords:
- organizations
- dashboards
labels:
products:
- enterprise
- oss
menuTitle: Manage organizations
title: Manage organizations
weight: 200
docs/sources/administration/provisioning/index.md
+4
View File
@@ -5,6 +5,10 @@ description: Describes provisioning settings for Grafana using configuration fil
keywords:
- grafana
- provisioning
labels:
products:
- enterprise
- oss
title: Provision Grafana
weight: 600
---
docs/sources/administration/recorded-queries/index.md
+4
View File
@@ -7,6 +7,10 @@ keywords:
- query
- queries
- recorded
labels:
products:
- cloud
- enterprise
title: Recorded queries
weight: 300
---
docs/sources/administration/roles-and-permissions/access-control/_index.md
+5
View File
@@ -3,6 +3,11 @@ aliases:
- ../../enterprise/access-control/
- ../../enterprise/access-control/about-rbac/
- ../../enterprise/access-control/roles/
cascade:
labels:
products:
- cloud
- enterprise
description: Role-based access control (RBAC) provides a standardized way of granting,
changing, and revoking access so that users can view and modify Grafana resources,
such as users and reports.
docs/sources/administration/stats-and-license/index.md
+4
View File
@@ -11,6 +11,10 @@ keywords:
- configuration
- server
- settings
labels:
products:
- enterprise
- oss
title: View server statistics and license
weight: 400
---
docs/sources/alerting/_index.md
+44 -51
View File
@@ -2,28 +2,52 @@
aliases:
- about-alerting/
- unified-alerting/alerting/
description: Intro to key benefits and features of Grafana Alerting
cascade:
labels:
products:
- cloud
- oss
title: Alerting
weight: 114
---
# Alerting
Grafana Alerting allows you to learn about problems in your systems moments after they occur.
Monitor your incoming metrics data or log entries and set up your Alerting system to watch for specific events or circumstances and then send notifications when those things are found.
In this way, you eliminate the need for manual monitoring and provide a first line of defense against system outages or changes that could turn into major incidents.
Using Grafana Alerting, you create queries and expressions from multiple data sources — no matter where your data is stored — giving you the flexibility to combine your data and alert on your metrics and logs in new and unique ways. You can then create, manage, and take action on your alerts from a single, consolidated view, and improve your team’s ability to identify and resolve issues quickly.
Grafana Alerting allows you to learn about problems in your systems moments after they occur. Create, manage, and take action on your alerts in a single, consolidated view, and improve your team’s ability to identify and resolve issues quickly.
Grafana Alerting is available for Grafana OSS, Grafana Enterprise, or Grafana Cloud. With Mimir and Loki alert rules you can run alert expressions closer to your data and at massive scale, all managed by the Grafana UI you are already familiar with.
Watch this video to learn more about Grafana Alerting: {{< vimeo 720001629 >}}
_Refer to [Manage your alert rules]({{< relref "../alerting/alerting-rules" >}}) for current instructions._
_Video shows Alerting in Grafana v9.0. Refer to [Manage your alert rules]({{< relref "../alerting/alerting-rules/" >}}) for current instructions._
## Key features and benefits
## Overview
The following diagram gives you an overview of how Grafana Alerting works and introduces you to some of the key concepts that work together and form the core of our flexible and powerful alerting engine.
{{< figure src="/static/img/docs/alerting/unified/about-alerting-flow-diagram-latest.png" caption="Grafana Alerting overview" >}}
1. Alert rules
Set evaluation criteria that determines whether an alert instance will fire. An alert rule consists of one or more queries and expressions, a condition, the frequency of evaluation, and optionally, the duration over which the condition is met.
Grafana managed alerts support multi-dimensional alerting, which means that each alert rule can create multiple alert instances. This is exceptionally powerful if you are observing multiple series in a single expression.
Once an alert rule has been created, they go through various states and transitions. The state and health of alert rules help you understand several key status indicators about your alerts.
1. Labels
Match an alert rule and its instances to notification policies and silences. They can also be used to group your alerts by severity.
1. Notification policies
Set where, when, and how the alerts get routed. Each notification policy specifies a set of label matchers to indicate which alerts they are responsible for. A notification policy has a contact point assigned to it that consists of one or more notifiers.
1. Contact points
Define how your contacts are notified when an alert fires. We support a multitude of ChatOps tools to ensure the alerts come to your team.
## Features
**One page for all alerts**
@@ -31,55 +55,24 @@ A single Grafana Alerting page consolidates both Grafana-managed alerts and aler
**Multi-dimensional alerts**
Alert rules can create multiple individual alert instances per alert rule, known as multi-dimensional alerts, giving you the power and flexibility to gain visibility into your entire system with just a single alert rule. You do this by adding labels to your query to specify which component is being monitored and generate multiple alert instances for a single alert rule. For example, if you want to monitor each server in a cluster, a multi-dimensional alert will alert on each CPU, whereas a standard alert will alert on the overall server.
Alert rules can create multiple individual alert instances per alert rule, known as multi-dimensional alerts, giving you the power and flexibility to gain visibility into your entire system with just a single alert.
**Route alerts**
**Routing alerts**
Route each alert instance to a specific contact point based on labels you define. Notification policies are the set of rules for where, when, and how the alerts are routed to contact points.
**Silence alerts**
**Silencing alerts**
Silences stop notifications from getting created and last for only a specified window of time.
Silences allow you to stop receiving persistent notifications from one or more alert rules. You can also partially pause an alert based on certain criteria. Silences have their own dedicated section for better organization and visibility, so that you can scan your paused alert rules without cluttering the main alerting view.
Silences allow you to stop receiving persistent notifications from one or more alerting rules. You can also partially pause an alert based on certain criteria. Silences have their own dedicated section for better organization and visibility, so that you can scan your paused alert rules without cluttering the main alerting view.
**Mute timings**
A mute timing is a recurring interval of time when no new notifications for a policy are generated or sent. Use them to prevent alerts from firing a specific and reoccurring period, for example, a regular maintenance period.
Similar to silences, mute timings do not prevent alert rules from being evaluated, nor do they stop alert instances from being shown in the user interface. They only prevent notifications from being created.
## Design your Alerting system
Monitoring complex IT systems and understanding whether everything is up and running correctly is a difficult task. Setting up an effective alert management system is therefore essential to inform you when things are going wrong before they start to impact your business outcomes.
Designing and configuring an alert management set up that works takes time.
Here are some tips on how to create an effective alert management set up for your business:
**Which are the key metrics for your business that you want to monitor and alert on?**
- Find events that are important to know about and not so trivial or frequent that recipients ignore them.
- Alerts should only be created for big events that require immediate attention or intervention.
- Consider quality over quantity.
**Which type of Alerting do you want to use?**
- Choose between Grafana-managed Alerting or Grafana Mimir or Loki-managed Alerting; or both.
**How do you want to organize your alerts and notifications?**
- Be selective about who you set to receive alerts. Consider sending them to whoever is on call or a specific Slack channel.
- Automate as far as possible using the Alerting API or alerts as code (Terraform).
**How can you reduce alert fatigue?**
- Avoid noisy, unnecessary alerts by using silences, mute timings, or pausing alert rule evaluation.
- Continually tune your alert rules to review effectiveness. Remove alert rules to avoid duplication or ineffective alerts.
- Think carefully about priority and severity levels.
- Continually review your thresholds and evaluation rules.
With mute timings, you can specify a time interval when you don’t want new notifications to be generated or sent. You can also freeze alert notifications for recurring periods of time, such as during a maintenance period.
## Useful links
- [Introduction to Alerting]({{< relref "./fundamentals" >}})
- [Fundamental concepts]({{< relref "/docs/grafana/latest/alerting/fundamentals" >}}) of Grafana Alerting.
- [Role-based access control]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control" >}}) in Grafana Enterprise.
- [High availability]({{< relref "/docs/grafana/latest/alerting/fundamentals/high-availability" >}})
docs/sources/breaking-changes/_index.md
-28
View File
@@ -1,28 +0,0 @@
---
aliases:
- guides/
title: Breaking changes
weight: 2
---
# Breaking changes in Grafana
In some cases, major releases that introduce many new features also introduce breaking changes. These changes are described, along with information about what to do, in the breaking changes pages specific to each release.
For our purposes, a breaking change is any change that requires users or operators to do something. This includes:
- Changes in one part of the system that could cause other components to fail
- Deprecations or removal of a feature
- Changes to an API that could break automation
- Changes that affect some plugins or functions of Grafana
- Migrations that can’t be rolled back
{{% admonition type="note" %}}
To learn what's available in a Grafana release, refer to the [What's new ]({{< relref "../whatsnew/" >}}) page for each version. For the steps we recommend when you upgrade, check out the [Upgrade guide]({{< relref "../upgrade-guide/" >}}) for each version.
{{% /admonition %}}
Refer to any of the following breaking changes guides:
{{< section menuTitle="true">}}
docs/sources/dashboards/_index.md
+6
View File
@@ -1,6 +1,12 @@
---
aliases:
- features/dashboard/dashboards/
cascade:
labels:
products:
- cloud
- enterprise
- oss
title: Dashboards
weight: 70
---
docs/sources/datasources/_index.md
+6
View File
@@ -2,6 +2,12 @@
aliases:
- data-sources/
- overview/
cascade:
labels:
products:
- cloud
- enterprise
- oss
title: Data sources
weight: 60
---
docs/sources/explore/_index.md
+6
View File
@@ -1,6 +1,12 @@
---
aliases:
- features/explore/
cascade:
labels:
products:
- cloud
- enterprise
- oss
keywords:
- explore
- loki
docs/sources/fundamentals/_index.md
+6
View File
@@ -1,6 +1,12 @@
---
aliases:
- basics/
cascade:
labels:
products:
- cloud
- enterprise
- oss
title: Fundamentals
weight: 8
---
docs/sources/introduction/grafana-cloud.md
+3
View File
@@ -1,4 +1,7 @@
---
labels:
products:
- cloud
title: Grafana Cloud
weight: 300
---
docs/sources/introduction/grafana-enterprise.md
+3
View File
@@ -1,6 +1,9 @@
---
aliases:
- ../enterprise/
labels:
products:
- enterprise
description: Grafana Enterprise overview
title: Grafana Enterprise
weight: 200
docs/sources/panels-visualizations/_index.md
+6
View File
@@ -3,6 +3,12 @@ aliases:
- dashboards/configure-panels-visualizations/
- features/panels/panels/
- panels/
cascade:
labels:
products:
- cloud
- enterprise
- oss
keywords:
- grafana
- configure
docs/sources/release-notes/_index.md
+6
View File
@@ -1,4 +1,10 @@
---
cascade:
labels:
products:
- cloud
- enterprise
- oss
title: Release notes
weight: 10000
---
docs/sources/search/_index.md
+8
View File
@@ -1,4 +1,12 @@
---
aliases:
- ./
cascade:
labels:
products:
- cloud
- enterprise
- oss
description: Learn how to search for Grafana dashboards
keywords:
- search
docs/sources/setup-grafana/configure-security/audit-grafana.md
+4
View File
@@ -7,6 +7,10 @@ keywords:
- auditing
- audit
- logs
labels:
products:
- cloud
- enterprise
title: Audit a Grafana instance
weight: 800
---
docs/sources/setup-grafana/configure-security/configure-authentication/_index.md
+6
View File
@@ -2,6 +2,12 @@
aliases:
- ../../auth/
- ../../auth/overview/
cascade:
labels:
products:
- cloud
- enterprise
- oss
description: Learn about all the ways in which you can configure Grafana to authenticate
users.
title: Configure authentication
docs/sources/setup-grafana/configure-security/configure-request-security.md
+5
View File
@@ -4,6 +4,11 @@ aliases:
description: Request security enables you to limit requests from the Grafana server
by targeting requests generated by users, such as data source metric queries and
alert notifications.
labels:
products:
- cloud
- enterprise
- oss
title: Configure request security
weight: 1100
---
docs/sources/setup-grafana/configure-security/configure-team-sync.md
+4
View File
@@ -4,6 +4,10 @@ aliases:
- ../../enterprise/team-sync/
description: Learn how to use Team Sync to synchronize between your authentication
provider teams and Grafana teams.
labels:
products:
- cloud
- enterprise
title: Configure Team Sync
weight: 1000
---
docs/sources/setup-grafana/configure-security/export-logs.md
+4
View File
@@ -7,6 +7,10 @@ keywords:
- export
- usage-insights
- enterprise
labels:
products:
- cloud
- oss
title: Export logs of usage insights
weight: 900
---
docs/sources/troubleshooting/_index.md
+6
View File
@@ -1,6 +1,12 @@
---
aliases:
- troubleshoot-dashboards/
cascade:
labels:
products:
- cloud
- enterprise
- oss
description: Guide to troubleshooting Grafana problems
keywords:
- grafana
docs/sources/whatsnew/_index.md
+19 -22
View File
@@ -53,40 +53,37 @@ aliases:
- whats-new-in-v6-5/
- whats-new-in-v6-6/
- whats-new-in-v6-7/
menuTitle: What's new
title: What's new in Grafana
cascade:
labels:
products:
- cloud
- oss
title: What's new
weight: 1
description: Learn about new and changed features in Grafana.
---
# What's new in Grafana
For release highlights, deprecations, and breaking changes in Grafana releases, refer to these "What's new" pages for each version.
{{% admonition type="note" %}}
For Grafana versions prior to v9.2, additional information might also be available in the archive of [release notes]({{< relref "../release-notes/" >}}).
{{% /admonition %}}
> **Note:** For Grafana versions prior to v9.2, additional information might also be available in the archive of [release notes]({{< relref "../release-notes/" >}}).
For a complete list of every change, with links to pull requests and related issues when available, see the [Changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md).
## Grafana 10
- [What's new in 10.0]({{< relref "whats-new-in-v10-0/" >}})
## Grafana 9
- [What's new in 9.5]({{< relref "./whats-new-in-v9-5" >}})
- [What's new in 9.4]({{< relref "./whats-new-in-v9-4" >}})
- [What's new in 9.3]({{< relref "./whats-new-in-v9-3" >}})
- [What's new in 9.2]({{< relref "./whats-new-in-v9-2" >}})
- [What's new in 9.1]({{< relref "./whats-new-in-v9-1" >}})
- [What's new in 9.0]({{< relref "./whats-new-in-v9-0" >}})
- [What's new in 9.5]({{< relref "whats-new-in-v9-5/" >}})
- [What's new in 9.4]({{< relref "whats-new-in-v9-4/" >}})
- [What's new in 9.3]({{< relref "whats-new-in-v9-3/" >}})
- [What's new in 9.2]({{< relref "whats-new-in-v9-2/" >}})
- [What's new in 9.1]({{< relref "whats-new-in-v9-1/" >}})
- [What's new in 9.0]({{< relref "whats-new-in-v9-0/" >}})
## Grafana 8
- [What's new in 8.5]({{< relref "./whats-new-in-v8-5" >}})
- [What's new in 8.4]({{< relref "./whats-new-in-v8-4" >}})
- [What's new in 8.3]({{< relref "./whats-new-in-v8-3" >}})
- [What's new in 8.2]({{< relref "./whats-new-in-v8-2" >}})
- [What's new in 8.1]({{< relref "./whats-new-in-v8-1" >}})
- [What's new in 8.0]({{< relref "./whats-new-in-v8-0" >}})
- [What's new in 8.5]({{< relref "whats-new-in-v8-5/" >}})
- [What's new in 8.4]({{< relref "whats-new-in-v8-4/" >}})
- [What's new in 8.3]({{< relref "whats-new-in-v8-3/" >}})
- [What's new in 8.2]({{< relref "whats-new-in-v8-2/" >}})
- [What's new in 8.1]({{< relref "whats-new-in-v8-1/" >}})
- [What's new in 8.0]({{< relref "whats-new-in-v8-0/" >}})