diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index 91b6e0ff92d..4ab78bd07df 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -12,20 +12,58 @@ weight: 70 # Dashboards -A dashboard is a set of one or more [panels]({{< relref "../panels-visualizations/" >}}) organized and arranged into one or more rows. Grafana ships with a variety of panels making it easy to construct the right queries, and customize the visualization so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana [data source]({{< relref "../administration/data-source-management/" >}}). +A dashboard is a set of one or more [panels][] organized and arranged into one or more rows. Grafana ships with a variety of panels making it easy to construct the right queries, and customize the visualization so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana [data source][]. Dashboard snapshots are static. Queries and expressions cannot be re-executed from snapshots. As a result, if you update any variables in your query or expression, it will not change your dashboard data. Before you begin, ensure that you have configured a data source. See also: -- [Use dashboards]({{< relref "use-dashboards/" >}}) -- [Build dashboards]({{< relref "./build-dashboards" >}}) -- [Create dashboard folders]({{< relref "./manage-dashboards/#create-a-dashboard-folder" >}}) -- [Manage dashboards]({{< relref "./manage-dashboards" >}}) -- [Public dashboards]({{< relref "dashboard-public/" >}}) -- [Annotations]({{< relref "./build-dashboards/annotate-visualizations" >}}) -- [Playlist]({{< relref "./create-manage-playlists/" >}}) -- [Reporting]({{< relref "./create-reports" >}}) -- [Version history]({{< relref "./build-dashboards/manage-version-history" >}}) -- [Export and import]({{< relref "./manage-dashboards/#export-and-import-dashboards" >}}) -- [JSON model]({{< relref "./build-dashboards/view-dashboard-json-model/" >}}) +- [Use dashboards][] +- [Build dashboards][] +- [Create dashboard folders][] +- [Manage dashboards][] +- [Public dashboards][] +- [Annotations][] +- [Playlist][] +- [Reporting][] +- [Version history][] +- [Export and import][] +- [JSON model][] + +{{% docs/reference %}} +[Reporting]: "/docs/grafana/ -> /docs/grafana//dashboards/create-reports" +[Reporting]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/create-reports" + +[Public dashboards]: "/docs/grafana/ -> /docs/grafana//dashboards/dashboard-public" +[Public dashboards]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/dashboard-public" + +[Version history]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/manage-version-history" +[Version history]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/manage-version-history" + +[panels]: "/docs/grafana/ -> /docs/grafana//panels-visualizations" +[panels]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations" + +[Annotations]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/annotate-visualizations" +[Annotations]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/annotate-visualizations" + +[Create dashboard folders]: "/docs/grafana/ -> /docs/grafana//dashboards/manage-dashboards#create-a-dashboard-folder" +[Create dashboard folders]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/manage-dashboards#create-a-dashboard-folder" + +[JSON model]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/view-dashboard-json-model" +[JSON model]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/view-dashboard-json-model" + +[Export and import]: "/docs/grafana/ -> /docs/grafana//dashboards/manage-dashboards#export-and-import-dashboards" +[Export and import]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/manage-dashboards#export-and-import-dashboards" + +[Manage dashboards]: "/docs/grafana/ -> /docs/grafana//dashboards/manage-dashboards" +[Manage dashboards]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/manage-dashboards" + +[Build dashboards]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards" +[Build dashboards]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards" + +[Use dashboards]: "/docs/grafana/ -> /docs/grafana//dashboards/use-dashboards" +[Use dashboards]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/use-dashboards" + +[Playlist]: "/docs/grafana/ -> /docs/grafana//dashboards/create-manage-playlists" +[Playlist]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/create-manage-playlists" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/assess-dashboard-usage/index.md b/docs/sources/dashboards/assess-dashboard-usage/index.md index 57fb51dcd15..0ac9d989321 100644 --- a/docs/sources/dashboards/assess-dashboard-usage/index.md +++ b/docs/sources/dashboards/assess-dashboard-usage/index.md @@ -24,9 +24,9 @@ weight: 200 Usage insights enables you to have a better understanding of how your Grafana instance is used. -{{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud](/docs/grafana-cloud/). Grafana Cloud insights logs include additional fields with their own dashboards. Read more in the [Grafana Cloud documentation](/docs/grafana-cloud/usage-insights/). -{{% /admonition %}} +> **Note:** Available in [Grafana Enterprise][] and [Grafana Cloud](/docs/grafana-cloud/). +> Grafana Cloud insights logs include additional fields with their own dashboards. +> Read more in the [Grafana Cloud documentation](/docs/grafana-cloud/usage-insights/). The usage insights feature collects a number of aggregated data and stores them in the database: @@ -36,12 +36,12 @@ The usage insights feature collects a number of aggregated data and stores them The aggregated data provides you access to several features: -- [Dashboard and data source insights]({{< relref "#dashboard-and-data-source-insights" >}}) -- [Presence indicator]({{< relref "#presence-indicator" >}}) -- [Sort dashboards by using insights data]({{< relref "#sort-dashboards-by-using-insights-data" >}}) -- [Visualize usage insight data in a dashboard]({{< relref "#visualize-usage-insights-data" >}}) +- [Dashboard and data source insights](#dashboard-and-data-source-insights) +- [Presence indicator](#presence-indicator) +- [Sort dashboards by using insights data](#sort-dashboards-by-using-insights-data) +- [Visualize usage insight data in a dashboard](#visualize-usage-insights-data) -This feature also generates detailed logs that can be exported to Loki. Refer to [Export logs of usage insights]({{< relref "../../setup-grafana/configure-security/export-logs/" >}}). +This feature also generates detailed logs that can be exported to Loki. Refer to [Export logs of usage insights][]. ## Dashboard and data source insights @@ -87,11 +87,11 @@ To find data source insights: When you are signed in and looking at a dashboard, you can know who is looking at the same dashboard as you are via a presence indicator, which displays avatars of users who have recently interacted with the dashboard. The default time frame is 10 minutes. To see the user's name, hover over the user's avatar. The avatars come from [Gravatar](https://gravatar.com) based on the user's email. -When there are more active users on a dashboard than can fit within the presence indicator, click the **+X** icon. Doing so opens [dashboard insights]({{< relref "#dashboard-and-data-source-insights" >}}), which contains more details about recent user activity. +When there are more active users on a dashboard than can fit within the presence indicator, click the **+X** icon. Doing so opens [dashboard insights](#dashboard-and-data-source-insights), which contains more details about recent user activity. {{< figure src="/static/img/docs/enterprise/presence_indicators.png" max-width="400px" class="docs-image--no-shadow" >}} -To change _recent_ to something other than the past 10 minutes, edit the [configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) file: +To change _recent_ to something other than the past 10 minutes, edit the [configuration][] file: ```ini [analytics.views] @@ -114,9 +114,23 @@ You can sort the dashboards by: ## Visualize usage insights data -If you set up your installation to [export logs of usage insights]({{< relref "../../setup-grafana/configure-security/export-logs/" >}}), we've created two dashboards to help you take advantage of this data. +If you set up your installation to [export logs of usage insights][], we've created two dashboards to help you take advantage of this data. 1. [Usage Insights overview](/grafana/dashboards/13785) provides a top-level perspective of user activity. 1. [Data source details](/grafana/dashboards/13786) dashboard provides a view of data source activity and health. You can click the previous links to download the respective dashboard JSON, then import into your Grafana installation. + +{{% docs/reference %}} +[export logs of usage insights]: "/docs/grafana/ -> /docs/grafana//setup-grafana/configure-security/export-logs" +[export logs of usage insights]: "/docs/grafana-cloud/ -> /docs/grafana//setup-grafana/configure-security/export-logs" + +[Export logs of usage insights]: "/docs/grafana/ -> /docs/grafana//setup-grafana/configure-security/export-logs" +[Export logs of usage insights]: "/docs/grafana-cloud/ -> /docs/grafana//setup-grafana/configure-security/export-logs" + +[configuration]: "/docs/grafana/ -> /docs/grafana//setup-grafana/configure-grafana" +[configuration]: "/docs/grafana-cloud/ -> /docs/grafana//setup-grafana/configure-grafana" + +[Grafana Enterprise]: "/docs/grafana/ -> /docs/grafana//introduction/grafana-enterprise" +[Grafana Enterprise]: "/docs/grafana-cloud/ -> /docs/grafana//introduction/grafana-enterprise" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/_index.md b/docs/sources/dashboards/build-dashboards/_index.md index 6eff2f5279b..50e2643c61a 100644 --- a/docs/sources/dashboards/build-dashboards/_index.md +++ b/docs/sources/dashboards/build-dashboards/_index.md @@ -24,4 +24,9 @@ This section includes the following topics: ## Dynamic dashboards -You can create more interactive and dynamic dashboards by adding and using [variables]({{< relref "../variables" >}}). Instead of hard-coding things like server, application, and sensor names in your metric queries, you can use variables in their place. Read more about variables [here]({{< relref "../variables" >}}). +You can create more interactive and dynamic dashboards by adding and using [variables][]. Instead of hard-coding things like server, application, and sensor names in your metric queries, you can use variables in their place. Read more about variables [here][variables]. + +{{% docs/reference %}} +[variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" +[variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md b/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md index 6a40ae902a6..28aa183baea 100644 --- a/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md +++ b/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md @@ -31,7 +31,7 @@ You can annotate visualizations in three ways: In the first two cases, you're creating new annotations, while in the last you're querying existing annotations from data sources. The built-in annotation query also supports this. -This page explains the first and third options; for information about using the HTTP API, refer to [Annotations API]({{< relref "../../../developers/http_api/annotations/" >}}). +This page explains the first and third options; for information about using the HTTP API, refer to [Annotations API][]. Annotations are supported for the following visualization types: @@ -113,7 +113,7 @@ To add a new annotation query to a dashboard, take the following steps: 1. Configure the query. - The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source]({{< relref "../../../datasources/" >}}) topic. + The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source][] topic. ## Built-in query @@ -163,3 +163,11 @@ When adding or editing an annotation, you can define a repeating time region by The above configuration will produce the following result in the Time series panel: {{< figure src="/media/docs/grafana/screenshot-grafana-10-0-timeseries-time-regions.png" max-width="600px" caption="Time series time regions business hours" >}} + +{{% docs/reference %}} +[Annotations API]: "/docs/grafana/ -> /docs/grafana//developers/http_api/annotations" +[Annotations API]: "/docs/grafana-cloud/ -> /docs/grafana//developers/http_api/annotations" + +[data source]: "/docs/grafana/ -> /docs/grafana//datasources" +[data source]: "/docs/grafana-cloud/ -> /docs/grafana//datasources" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/best-practices/index.md b/docs/sources/dashboards/build-dashboards/best-practices/index.md index a22ef3c44b5..f02ec672bf6 100644 --- a/docs/sources/dashboards/build-dashboards/best-practices/index.md +++ b/docs/sources/dashboards/build-dashboards/best-practices/index.md @@ -100,9 +100,9 @@ How can you tell you are here? - Prevent sprawl by using template variables. For example, you don't need a separate dashboard for each node, you can use query variables. Even better, you can make the data source a template variable too, so you can reuse the same dashboard across different clusters and monitoring backends. - Refer to the list of [Variable examples]({{< relref "../../variables/#examples-of-templates-and-variables" >}}) if you want some ideas. + Refer to the list of [Variable examples][] if you want some ideas. -- Methodical dashboards according to an [observability strategy]({{< relref "#common-observability-strategies" >}}). +- Methodical dashboards according to an [observability strategy](#common-observability-strategies). - Hierarchical dashboards with drill-downs to the next level. {{< figure class="float-right" max-width="100%" src="/static/img/docs/best-practices/drill-down-example.png" caption="Example of using drill-down" >}} @@ -113,12 +113,12 @@ How can you tell you are here? - Compare like to like: split service dashboards when the magnitude differs. Make sure aggregated metrics don't drown out important information. - Expressive charts with meaningful use of color and normalizing axes where you can. - - Example of meaningful color: Blue means it's good, red means it's bad. [Thresholds]({{< relref "../../../panels-visualizations/configure-thresholds/" >}}) can help with that. + - Example of meaningful color: Blue means it's good, red means it's bad. [Thresholds][] can help with that. - Example of normalizing axes: When comparing CPU usage, measure by percentage rather than raw number, because machines can have a different number of cores. Normalizing CPU usage by the number of cores reduces cognitive load because the viewer can trust that at 100% all cores are being used, without having to know the number of CPUs. - Directed browsing cuts down on "guessing." - Template variables make it harder to “just browse” randomly or aimlessly. - Most dashboards should be linked to by alerts. - - Browsing is directed with links. For more information, refer to [Manage dashboard links]({{< relref "../manage-dashboard-links" >}}). + - Browsing is directed with links. For more information, refer to [Manage dashboard links][]. - Version-controlled dashboard JSON. ### High - optimized use @@ -128,7 +128,7 @@ At this stage, you have optimized your dashboard management use with a consisten - Actively reducing sprawl. - Regularly review existing dashboards to make sure they are still relevant. - Only approved dashboards added to master dashboard list. - - Tracking dashboard use. If you're an Enterprise user, you can take advantage of [Usage insights]({{< relref "../../assess-dashboard-usage/" >}}). + - Tracking dashboard use. If you're an Enterprise user, you can take advantage of [Usage insights][]. - Consistency by design. - Use scripting libraries to generate dashboards, ensure consistency in pattern and style. - grafonnet (Jsonnet) @@ -164,7 +164,7 @@ Ask yourself: It's easy to make new dashboards. It's harder to optimize dashboard creation and adhere to a plan, but it's worth it. This strategy should govern both your overall dashboard scheme and enforce consistency in individual dashboard design. -Refer to [Common observability strategies]({{< relref "#common-observability-strategies" >}}) and [Dashboard management maturity levels]({{< relref "#dashboard-management-maturity-model" >}}) for more information. +Refer to [Common observability strategies](#common-observability-strategies) and [Dashboard management maturity levels](#dashboard-management-maturity-model) for more information. #### Write it down @@ -176,14 +176,14 @@ Once you have a strategy or design guidelines, write them down to help maintain - If you are creating a dashboard to play or experiment, then put the word `TEST` or `TMP` in the name. - Consider including your name or initials in the dashboard name or as a tag so that people know who owns the dashboard. - Remove temporary experiment dashboards when you are done with them. -- If you create many related dashboards, think about how to cross-reference them for easy navigation. Refer to [Best practices for managing dashboards]({{< relref "#best-practices-for-managing-dashboards" >}}) for more information. -- Grafana retrieves data from a data source. A basic understanding of [data sources]({{< relref "../../../datasources/" >}}) in general and your specific is important. +- If you create many related dashboards, think about how to cross-reference them for easy navigation. Refer to [Best practices for managing dashboards](#best-practices-for-managing-dashboards) for more information. +- Grafana retrieves data from a data source. A basic understanding of [data sources][] in general and your specific is important. - Avoid unnecessary dashboard refreshing to reduce the load on the network or backend. For example, if your data changes every hour, then you don't need to set the dashboard refresh rate to 30 seconds. - Use the left and right Y-axes when displaying time series with different units or ranges. - Add documentation to dashboards and panels. - - To add documentation to a dashboard, add a [Text panel visualization]({{< relref "../../../panels-visualizations/visualizations/text/" >}}) to the dashboard. Record things like the purpose of the dashboard, useful resource links, and any instructions users might need to interact with the dashboard. Check out this [Wikimedia example](https://grafana.wikimedia.org/d/000000066/resourceloader?orgId=1). + - To add documentation to a dashboard, add a [Text panel visualization][] to the dashboard. Record things like the purpose of the dashboard, useful resource links, and any instructions users might need to interact with the dashboard. Check out this [Wikimedia example](https://grafana.wikimedia.org/d/000000066/resourceloader?orgId=1). - To add documentation to a panel, edit the panel settings and add a description. Any text you add will appear if you hover your cursor over the small `i` in the top left corner of the panel. -- Reuse your dashboards and enforce consistency by using [templates and variables]({{< relref "../../variables" >}}). +- Reuse your dashboards and enforce consistency by using [templates and variables][]. - Be careful with stacking graph data. The visualizations can be misleading, and hide important data. We recommend turning it off in most cases. ## Best practices for managing dashboards @@ -196,13 +196,13 @@ Here are some principles to consider before you start managing dashboards. #### Strategic observability -There are several [common observability strategies]({{< relref "#common-observability-strategies" >}}). 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. +There are several [common observability strategies](#common-observability-strategies). 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. Adapt your strategy to changing needs as necessary. #### Maturity level -What is your dashboard maturity level? Analyze your current dashboard setup and compare it to the [Dashboard management maturity model]({{< relref "#dashboard-management-maturity-model" >}}). Understanding where you are can help you decide how to get to where you want to be. +What is your dashboard maturity level? Analyze your current dashboard setup and compare it to the [Dashboard management maturity model](#dashboard-management-maturity-model). Understanding where you are can help you decide how to get to where you want to be. ### Best practices to follow @@ -211,9 +211,41 @@ What is your dashboard maturity level? Analyze your current dashboard setup and - 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 "../../../panels-visualizations/configure-data-links/#data-link-variables" >}}). + - 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][]. - 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 [Manage dashboard links]({{< relref "../manage-dashboard-links/" >}}). - - Add a [Dashboard list panel]({{< relref "../../../panels-visualizations/visualizations/dashboard-list/" >}}). You can then customize what you see by doing tag or folder searches. - - Add a [Text panel]({{< relref "../../../panels-visualizations/visualizations/text/" >}}) and use markdown to customize the display. + - Create dashboard links, panel, or data links. Links can go to other dashboards or to external systems. For more information, refer to [Manage dashboard links][]. + - Add a [Dashboard list panel][]. You can then customize what you see by doing tag or folder searches. + - Add a [Text panel][] and use markdown to customize the display. + +{{% docs/reference %}} +[Variable examples]: "/docs/grafana/ -> /docs/grafana//dashboards/variables#examples-of-templates-and-variables" +[Variable examples]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables#examples-of-templates-and-variables" + +[templates and variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" +[templates and variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables" + +[URL parameters]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-data-links#data-link-variables" +[URL parameters]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-data-links#data-link-variables" + +[Dashboard list panel]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/dashboard-list" +[Dashboard list panel]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/dashboard-list" + +[Thresholds]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-thresholds" +[Thresholds]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-thresholds" + +[Text panel]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/text" +[Text panel]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/text" + +[Manage dashboard links]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/manage-dashboard-links" +[Manage dashboard links]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/manage-dashboard-links" + +[Text panel visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/text" +[Text panel visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/text" + +[data sources]: "/docs/grafana/ -> /docs/grafana//datasources" +[data sources]: "/docs/grafana-cloud/ -> /docs/grafana//datasources" + +[Usage insights]: "/docs/grafana/ -> /docs/grafana//dashboards/assess-dashboard-usage" +[Usage insights]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/assess-dashboard-usage" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md b/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md index 5e9652bdcd9..44214c5a43d 100644 --- a/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md +++ b/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md @@ -20,7 +20,7 @@ weight: 250 # Dashboard URL variables Grafana can apply variable values passed as query parameters in dashboard URLs. -For more information, refer to [Manage dashboard links]({{< relref "../manage-dashboard-links/" >}}) and [Templates and variables]({{< relref "../../variables/" >}}). +For more information, refer to [Manage dashboard links][] and [Templates and variables][]. ## Passing variables as query parameters @@ -50,11 +50,11 @@ This example in [Grafana Play](https://play.grafana.org/d/000000074/alerting?var ## Adding variables to dashboard links -Grafana can add variables to dashboard links when you generate them from a dashboard's settings. For more information and steps to add variables, refer to [Manage dashboard links]({{< relref "../manage-dashboard-links/" >}}). +Grafana can add variables to dashboard links when you generate them from a dashboard's settings. For more information and steps to add variables, refer to [Manage dashboard links][]. ## Passing ad hoc filters -Ad hoc filters apply key/value filters to all metric queries that use a specified data source. For more information, refer to [Add ad hoc filters]({{< relref "../../variables/add-template-variables/#add-ad-hoc-filters" >}}). +Ad hoc filters apply key/value filters to all metric queries that use a specified data source. For more information, refer to [Add ad hoc filters][]. To pass an ad hoc filter as a query parameter, use the variable syntax to pass the ad hoc filter variable, and also provide the key, the operator as the value, and the value as a pipe-separated list. @@ -76,4 +76,18 @@ When sharing URLs with ad hoc filters, remember to encode the URL. In the above ## Controlling time range using the URL -To set a dashboard's time range, use the `from`, `to`, `time`, and `time.window` query parameters. Because these are not variables, they do not require the `var-` prefix. For more information, see the [Linking overview]({{< relref "../" >}}). +To set a dashboard's time range, use the `from`, `to`, `time`, and `time.window` query parameters. Because these are not variables, they do not require the `var-` prefix. For more information, see the [Linking overview][]. + +{{% docs/reference %}} +[Linking overview]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards" +[Linking overview]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards" + +[Manage dashboard links]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/manage-dashboard-links" +[Manage dashboard links]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/manage-dashboard-links" + +[Add ad hoc filters]: "/docs/grafana/ -> /docs/grafana//dashboards/variables/add-template-variables#add-ad-hoc-filters" +[Add ad hoc filters]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables/add-template-variables#add-ad-hoc-filters" + +[Template and variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" +[Template and variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/create-dashboard/index.md b/docs/sources/dashboards/build-dashboards/create-dashboard/index.md index 71548ff246e..38e472fa134 100644 --- a/docs/sources/dashboards/build-dashboards/create-dashboard/index.md +++ b/docs/sources/dashboards/build-dashboards/create-dashboard/index.md @@ -21,10 +21,10 @@ Dashboards and panels allow you to show your data in visual form. Each panel nee **Before you begin:** -- Ensure that you have the proper permissions. For more information about permissions, refer to [About users and permissions]({{< relref "../../../administration/roles-and-permissions/" >}}). +- Ensure that you have the proper permissions. For more information about permissions, refer to [About users and permissions][]. - Identify the dashboard to which you want to add the panel. - Understand the query language of the target data source. -- Ensure that data source for which you are writing a query has been added. For more information about adding a data source, refer to [Add a data source]({{< relref "../../../administration/data-source-management#add-a-data-source" >}}) if you need instructions. +- Ensure that data source for which you are writing a query has been added. For more information about adding a data source, refer to [Add a data source][] if you need instructions. **To create a dashboard**: @@ -37,7 +37,7 @@ Dashboards and panels allow you to show your data in visual form. Each panel nee 1. In the modal that opens, do one of the following: - Select one of your existing data sources. - - Select one of the Grafana's [built-in special data sources]({{< relref "../../../datasources/#special-data-sources" >}}). + - Select one of the Grafana's [built-in special data sources][]. - Click **Configure a new data source** to set up a new one (Admins only). {{< figure class="float-right" src="/media/docs/grafana/dashboards/screenshot-data-source-selector-10.0.png" max-width="800px" alt="Select data source modal" >}} @@ -45,7 +45,7 @@ Dashboards and panels allow you to show your data in visual form. Each panel nee The **Edit panel** view opens with your data source selected. You can change the panel data source later using the dropdown in the **Query** tab of the panel editor if needed. - For more information about data sources, refer to [Data sources]({{< relref "../../../datasources/" >}}) for specific guidelines. + For more information about data sources, refer to [Data sources][] for specific guidelines. 1. Write or construct a query in the query language of your data source. @@ -59,17 +59,17 @@ Dashboards and panels allow you to show your data in visual form. Each panel nee Grafana displays a preview of your query results with the visualization applied. - For more information about individual visualizations, refer to [Visualizations options]({{< relref "../../../panels-visualizations/visualizations/" >}}). + For more information about individual visualizations, refer to [Visualizations options][]. 1. Refer to the following documentation for ways you can adjust panel settings. While not required, most visualizations need some adjustment before they properly display the information that you need. - - [Configure value mappings]({{< relref "../../../panels-visualizations/configure-value-mappings" >}}) - - [Visualization-specific options]({{< relref "../../../panels-visualizations/visualizations/" >}}) - - [Override field values]({{< relref "../../../panels-visualizations/configure-overrides/" >}}) - - [Configure thresholds]({{< relref "../../../panels-visualizations/configure-thresholds/" >}}) - - [Configure standard options]({{< relref "../../../panels-visualizations/configure-standard-options/" >}}) + - [Configure value mappings][] + - [Visualization-specific options][] + - [Override field values][] + - [Configure thresholds][] + - [Configure standard options][] 1. When you've finished editing your panel, click **Save** to save the dashboard. @@ -85,7 +85,7 @@ Dashboards and panels allow you to show your data in visual form. Each panel nee ## Configure repeating rows -You can configure Grafana to dynamically add panels or rows to a dashboard based on the value of a variable. Variables dynamically change your queries across all rows in a dashboard. For more information about repeating panels, refer to [Configure repeating panels]({{< relref "../../../panels-visualizations/configure-panel-options/#configure-repeating-panels" >}}). +You can configure Grafana to dynamically add panels or rows to a dashboard based on the value of a variable. Variables dynamically change your queries across all rows in a dashboard. For more information about repeating panels, refer to [Configure repeating panels][]. To see an example of repeating rows, refer to [Dashboard with repeating rows](https://play.grafana.org/d/000000153/repeat-rows). The example shows that you can also repeat rows if you have variables set with `Multi-value` or `Include all values` selected. @@ -133,3 +133,38 @@ You can size a dashboard panel to suits your needs. 1. Click **Dashboards** in the left-side menu. 1. Navigate to the dashboard you want to work on. 1. To adjust the size of the panel, click and drag the lower-right corner of the panel. + +{{% docs/reference %}} +[Override field values]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" +[Override field values]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-overrides" + +[built-in special data sources]: "/docs/grafana/ -> /docs/grafana//datasources#special-data-sources" +[built-in special data sources]: "/docs/grafana-cloud/ -> /docs/grafana//datasources#special-data-sources" + +[Configure repeating panels]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-panel-options#configure-repeating-panels" +[Configure repeating panels]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-panel-options#configure-repeating-panels" + +[Add a data source]: "/docs/grafana/ -> /docs/grafana//administration/data-source-management#add-a-data-source" +[Add a data source]: "/docs/grafana-cloud/ -> /docs/grafana//administration/data-source-management#add-a-data-source" + +[Visualization-specific options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations" +[Visualization-specific options]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations" + +[About users and permissions]: "/docs/grafana/ -> /docs/grafana//administration/roles-and-permissions" +[About users and permissions]: "/docs/grafana-cloud/ -> /docs/grafana//administration/roles-and-permissions" + +[Visualizations options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations" +[Visualizations options]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations" + +[Data sources]: "/docs/grafana/ -> /docs/grafana//datasources" +[Data sources]: "/docs/grafana-cloud/ -> /docs/grafana//datasources" + +[Configure thresholds]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-thresholds" +[Configure thresholds]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-thresholds" + +[Configure value mappings]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-value-mappings" +[Configure value mappings]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-value-mappings" + +[Configure standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options" +[Configure standard options]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-standard-options" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md b/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md index f802db5bd8d..2ea8dafc0ef 100644 --- a/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md +++ b/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md @@ -37,10 +37,10 @@ Start by figuring out how you're currently navigating between dashboards. If you The next step is to figure out which link type is right for your workflow. Even though all the link types in Grafana are used to create shortcuts to other dashboards or external websites, they work in different contexts. -- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "#dashboard-links" >}}). -- If you want to drill down into specific panels, use [panel links]({{< relref "#panel-links" >}}). +- If the link relates to most if not all of the panels in the dashboard, use [dashboard links](#dashboard-links). +- If you want to drill down into specific panels, use [panel links](#panel-links). - If you want to link to an external site, you can use either a dashboard link or a panel link. -- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "../../../panels-visualizations/configure-data-links/#data-links" >}}). +- If you want to drill down into a specific series, or even a single measurement, use [data links][]. ## Controlling time range using the URL @@ -52,7 +52,7 @@ To control the time range of a panel or dashboard, you can provide query paramet ## Dashboard links -When you create a dashboard link, you can include the time range and current template variables to directly jump to the same context in another dashboard. This way, you don’t have to worry whether the person you send the link to is looking at the right data. For other types of links, refer to [Data link variables]({{< relref "../../../panels-visualizations/configure-data-links/#data-link-variables/" >}}). +When you create a dashboard link, you can include the time range and current template variables to directly jump to the same context in another dashboard. This way, you don’t have to worry whether the person you send the link to is looking at the right data. For other types of links, refer to [Data link variables][]. Dashboard links can also be used as shortcuts to external systems, such as submitting [a GitHub issue with the current dashboard name](https://github.com/grafana/grafana/issues/new?title=Dashboard%3A%20HTTP%20Requests). @@ -74,7 +74,7 @@ Add links to other dashboards at the top of your current dashboard. - **With tags** – Enter tags to limit the linked dashboards to only the ones with the tags you enter. Otherwise, Grafana includes links to all other dashboards. - **As dropdown** – If you are linking to lots of dashboards, then you probably want to select this option and add an optional title to the dropdown. Otherwise, Grafana displays the dashboard links side by side across the top of your dashboard. - **Time range** – Select this option to include the dashboard time range in the link. When the user clicks the link, the linked dashboard opens with the indicated time range already set. **Example:** https://play.grafana.org/d/000000010/annotations?orgId=1&from=now-3h&to=now - - **Variable values** – Select this option to include template variables currently used as query parameters in the link. When the user clicks the link, any matching templates in the linked dashboard are set to the values from the link. For more information, see [Dashboard URL variables]({{< relref "../create-dashboard-url-variables/" >}}). + - **Variable values** – Select this option to include template variables currently used as query parameters in the link. When the user clicks the link, any matching templates in the linked dashboard are set to the values from the link. For more information, see [Dashboard URL variables][]. - **Open in new tab** – Select this option if you want the dashboard link to open in a new tab or window. 1. Click **Add**. @@ -165,3 +165,14 @@ Click the icon next to the panel title to see available panel links. 1. Find the link that you want to delete. 1. Click the **X** icon next to the link you want to delete. 1. Click **Save** in the upper right to save your changes to the dashboard. + +{{% docs/reference %}} +[data links]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-data-links#data-links" +[data links]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-data-links#data-links" + +[Dashboard URL variables]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/create-dashboard-url-variables" +[Dashboard URL variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/create-dashboard-url-variables" + +[Data link variables]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-data-links#data-link-variables" +[Data link variables]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-data-links#data-link-variables" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md b/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md index 1683e278aa8..d1d93552834 100644 --- a/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md +++ b/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md @@ -56,7 +56,7 @@ icon you can hover over to see the event information. 1. Enter a name and select a data source. 1. Complete the rest of the form to build a query and annotation. -The query editor UI changes based on the data source you select. Refer to the [Data source]({{< relref "../../../datasources/" >}}) documentation for details on how to construct a query. +The query editor UI changes based on the data source you select. Refer to the [Data source][] documentation for details on how to construct a query. ## Add a variable @@ -64,7 +64,7 @@ Variables enable you to create more interactive and dynamic dashboards. Instead and sensor names in your metric queries, you can use variables in their place. Variables are displayed as dropdown lists at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -For more information about variables, refer to [Variables]({{< relref "../../variables/" >}}). +For more information about variables, refer to [Variables][]. 1. On the **Dashboard settings** page, click **Variable** in the left side section menu and then the **Add variable** button. 1. In the **General** section, the name of the variable. This is the name that you will later use in queries. @@ -95,4 +95,15 @@ A dashboard in Grafana is represented by a JSON object, which stores metadata of To view a dashboard JSON model, on the **Dashboard settings** page, click **JSON**. -For more information about the JSON fields, refer to [JSON fields]({{< relref "../view-dashboard-json-model/#json-fields" >}}). +For more information about the JSON fields, refer to [JSON fields][]. + +{{% docs/reference %}} +[Data source]: "/docs/grafana/ -> /docs/grafana//datasources" +[Data source]: "/docs/grafana-cloud/ -> /docs/grafana//datasources" + +[Variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" +[Variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables" + +[JSON fields]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/view-dashboard-json-model#json-fields" +[JSON fields]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/view-dashboard-json-model#json-fields" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md b/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md index ea8449aa6a8..85dd0cf3697 100644 --- a/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md +++ b/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md @@ -81,7 +81,7 @@ Each field in the dashboard JSON is explained below with its usage: | **time** | time range for dashboard, i.e. last 6 hours, last 7 days, etc | | **timepicker** | timepicker metadata, see [timepicker section](#timepicker) for details | | **templating** | templating metadata, see [templating section](#templating) for details | -| **annotations** | annotations metadata, see [annotations]({{< relref "../annotate-visualizations" >}}) for how to add them | +| **annotations** | annotations metadata, see [annotations][] for how to add them | | **refresh** | auto-refresh interval | | **schemaVersion** | version of the JSON schema (integer), incremented each time a Grafana update brings changes to said schema | | **version** | version of the dashboard (integer), incremented each time the dashboard is updated | @@ -245,3 +245,8 @@ Usage of the above mentioned fields in the templating section is explained below | **refresh** | | | **regex** | | | **type** | type of variable, i.e. `custom`, `query` or `interval` | + +{{% docs/reference %}} +[annotations]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/annotate-visualizations" +[annotations]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/annotate-visualizations" +{{% /docs/reference %}} diff --git a/docs/sources/dashboards/create-reports/index.md b/docs/sources/dashboards/create-reports/index.md index 725c07ec923..41eb93c931d 100644 --- a/docs/sources/dashboards/create-reports/index.md +++ b/docs/sources/dashboards/create-reports/index.md @@ -23,7 +23,7 @@ weight: 85 Reporting enables you to automatically generate PDFs from any of your dashboards and have Grafana email them to interested parties on a schedule. This is available in Grafana Cloud and in Grafana Enterprise. -> If you have [Role-based access control]({{< relref "../../administration/roles-and-permissions/access-control/" >}}) enabled, for some actions you would need to have relevant permissions. +> If you have [Role-based access control][] enabled, for some actions you would need to have relevant permissions. > Refer to specific guides to understand what permissions are required.