grafana/docs/sources/best-practices/best-practices-for-managing-dashboards.md

38 lines
2.7 KiB
Markdown
Raw Normal View History

Docs: Add best practices (#27057) * added content * adding content * Update best-practices-for-creating-dashboards.md * moved strategies.md * updating content * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * content updates * Update common-observability-strategies.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-managing-dashboards.md * Update dashboard-management-maturity-levels.md * updated menu * Update dashboard-management-maturity-levels.md * added Torkel tips * Update best-practices-for-creating-dashboards.md * Update docs/sources/best-practices/best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update best-practices-for-creating-dashboards.md * DavKal updates * Update best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
2020-08-26 10:31:19 -05:00
+++
title = "Best practices for managing dashboards"
description = "Best practices for managing dashboards in Grafana"
weight = 200
+++
# Best practices for managing dashboards
This page outlines some best practices to follow when managing Grafana dashboards.
## Before you begin
Here are some principles to consider before you start managing dashboards.
### Strategic observability
There are several [common observability strategies]({{< relref "common-observability-strategies.md" >}}). You should research them and decide whether one of them works for you or if you want to come up with your own. Either way, have a plan, write it down, and stick to it.
Docs: Add best practices (#27057) * added content * adding content * Update best-practices-for-creating-dashboards.md * moved strategies.md * updating content * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * content updates * Update common-observability-strategies.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-managing-dashboards.md * Update dashboard-management-maturity-levels.md * updated menu * Update dashboard-management-maturity-levels.md * added Torkel tips * Update best-practices-for-creating-dashboards.md * Update docs/sources/best-practices/best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update best-practices-for-creating-dashboards.md * DavKal updates * Update best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
2020-08-26 10:31:19 -05:00
Adapt your strategy to changing needs as necessary.
### Maturity level
2020-08-27 08:26:57 -05:00
What is your dashboard maturity level? Analyze your current dashboard setup and compare it to the [Dashboard management maturity model]({{< relref "dashboard-management-maturity-levels.md" >}}). Understanding where you are can help you decide how to get to where you want to be.
Docs: Add best practices (#27057) * added content * adding content * Update best-practices-for-creating-dashboards.md * moved strategies.md * updating content * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * content updates * Update common-observability-strategies.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-managing-dashboards.md * Update dashboard-management-maturity-levels.md * updated menu * Update dashboard-management-maturity-levels.md * added Torkel tips * Update best-practices-for-creating-dashboards.md * Update docs/sources/best-practices/best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update best-practices-for-creating-dashboards.md * DavKal updates * Update best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
2020-08-26 10:31:19 -05:00
## Best practices to follow
- Avoid dashboard sprawl, meaning the uncontrolled growth of dashboards. Dashboard sprawl negatively affects time to find the right dashboard. Duplicating dashboards and changing “one thing” (worse: keeping original tags) is the easiest kind of sprawl.
- Periodically review the dashboards and remove unnecessary ones.
- If you create a temporary dashboard, perhaps to test something, prefix the name with `TEST: `. Delete the dashboard when you are finished.
- Copying dashboards with no significant changes is not a good idea.
- You miss out on updates to the original dashboard, such as documentation changes, bug fixes, or additions to metrics.
- In many cases copies are being made to simply customize the view by setting template parameters. This should instead be done by maintaining a link to the master dashboard and customizing the view with [URL parameters]({{< relref "../linking/data-link-variables.md" >}}).
Docs: Add best practices (#27057) * added content * adding content * Update best-practices-for-creating-dashboards.md * moved strategies.md * updating content * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-creating-dashboards.md * content updates * Update common-observability-strategies.md * Update best-practices-for-managing-dashboards.md * Update best-practices-for-managing-dashboards.md * Update dashboard-management-maturity-levels.md * updated menu * Update dashboard-management-maturity-levels.md * added Torkel tips * Update best-practices-for-creating-dashboards.md * Update docs/sources/best-practices/best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> * Update docs/sources/best-practices/best-practices-for-managing-dashboards.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update docs/sources/best-practices/dashboard-management-maturity-levels.md Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> * Update best-practices-for-creating-dashboards.md * DavKal updates * Update best-practices-for-creating-dashboards.md Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com> Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
2020-08-26 10:31:19 -05:00
- When you must copy a dashboard, clearly rename it and _do not_ copy the dashboard tags. Tags are important metadata for dashboards that are used during search. Copying tags can result in false matches.
- Maintain a dashboard of dashboards or cross-reference dashboards. This can be done in several ways:
- Create dashboard links, panel, or data links. Links can go to other dashboards or to external systems. For more information, refer to [Linking]({{< relref "../linking/_index.md" >}}).
- Add a [Dashboard list panel]({{< relref "../visualizations/dashboard-list-panel.md" >}}). You can then customize what you see by doing tag or folder searches.
- Add a [Text panel]({{< relref "../visualizations/text-panel.md" >}}) and use markdown to customize the display.