Commit 507dc436 by achatterjee-grafana Committed by GitHub

Added "curated dashboards" information and broke down, rearranged topics. (#30659)

* Change to introduction section.

* Checkin changes.

* Check in changes.

* Updated heading levels for better readability.

* Checkin changes.

* Broke down topic and fixed relrefs. Also, resized images.

* Added one more relref from preconfig dashboards to main topic.

* Adding Eric's changes.

* Added alias.

* Updated alias with correct syntax, also updated description typo for "Preconfigured dashboards"s

* Checking in changes from Diana.

* Update docs/sources/datasources/google-cloud-monitoring/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* One last change.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
parent db9a8bf0
...@@ -86,7 +86,7 @@ aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", ...@@ -86,7 +86,7 @@ aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin",
<img src="/img/docs/logos/icon_prometheus.svg" > <img src="/img/docs/logos/icon_prometheus.svg" >
<h5>Prometheus</h5> <h5>Prometheus</h5>
</a> </a>
<a href="{{< relref "datasources/cloudmonitoring.md" >}}" class="nav-cards__item nav-cards__item--ds"> <a href="{{< relref "datasources/google-cloud-monitoring/_index.md" >}}" class="nav-cards__item nav-cards__item--ds">
<img src="/img/docs/logos/icon_cloudmonitoring.svg"> <img src="/img/docs/logos/icon_cloudmonitoring.svg">
<h5>Google Cloud Monitoring</h5> <h5>Google Cloud Monitoring</h5>
</a> </a>
......
...@@ -19,7 +19,7 @@ The following data sources are officially supported: ...@@ -19,7 +19,7 @@ The following data sources are officially supported:
- [AWS CloudWatch]({{< relref "cloudwatch.md" >}}) - [AWS CloudWatch]({{< relref "cloudwatch.md" >}})
- [Azure Monitor]({{< relref "azuremonitor.md" >}}) - [Azure Monitor]({{< relref "azuremonitor.md" >}})
- [Elasticsearch]({{< relref "elasticsearch.md" >}}) - [Elasticsearch]({{< relref "elasticsearch.md" >}})
- [Google Cloud Monitoring]({{< relref "cloudmonitoring.md" >}}) - [Google Cloud Monitoring]({{< relref "google-cloud-monitoring/_index.md" >}})
- [Graphite]({{< relref "graphite.md" >}}) - [Graphite]({{< relref "graphite.md" >}})
- [InfluxDB]({{< relref "influxdb.md" >}}) - [InfluxDB]({{< relref "influxdb.md" >}})
- [Loki]({{< relref "loki.md" >}}) - [Loki]({{< relref "loki.md" >}})
......
+++
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/latest/features/datasources/cloudmonitoring/"]
weight = 10
+++
# Preconfigured Cloud Monitoring dashboards
Google Cloud Monitoring data source ships with pre-configured dashboards for some of the most popular GCP services. These curated dashboards are based on similar dashboards in the GCP dashboard samples repository. See also, [Using Google Cloud Monitoring in Grafana]({{< relref "./_index.md" >}}) for detailed instructions on how to add and configure the Google Cloud Monitoring data source.
## Curated dashboards
The curated dashboards are based on similar dashboards in the GCP dashboard samples repository.
To import the curated dashboards:
1. On the configuration page of your Cloud Monitoring data source, click the **Dashboards** tab.
1. Click **Import** for the dashboard you would like to use.
The data source of the newly created dashboard panels will be the one selected above. The dashboards have a template variable that is populated with the projects accessible by the configured service account every time the dashboard is loaded. After the dashboard is loaded, you can select the project you prefer from the drop-down list.
In case you want to customize a dashboard, we recommend that you save it under a different name. Otherwise the dashboard will be overwritten when a new version of the dashboard is released.
{{< docs-imagebox img="/img/docs/google-cloud-monitoring/curated-dashboards-7-4.png" max-width= "650px" >}}
...@@ -37,7 +37,7 @@ The Grafana Stackdriver plugin comes with support for automatic unit detection. ...@@ -37,7 +37,7 @@ The Grafana Stackdriver plugin comes with support for automatic unit detection.
The data source is still in the `beta` phase, meaning it's currently in active development and is still missing one important feature - templating queries. The data source is still in the `beta` phase, meaning it's currently in active development and is still missing one important feature - templating queries.
Please try it out, but be aware of that it might be subject to changes and possible bugs. We would love to hear your feedback. Please try it out, but be aware of that it might be subject to changes and possible bugs. We would love to hear your feedback.
Please read [Using Google Stackdriver in Grafana]({{< relref "../datasources/cloudmonitoring/" >}}) for more detailed information on how to get started and use it. Refer to [Using Google Stackdriver in Grafana]({{< relref "../datasources/google-cloud-monitoring/_index.md" >}}) for more detailed information on how to get started and use it.
## TV and Kiosk Mode ## TV and Kiosk Mode
......
...@@ -45,9 +45,9 @@ Stackdriver is the first data source which has support for a custom templating q ...@@ -45,9 +45,9 @@ Stackdriver is the first data source which has support for a custom templating q
create their very own templating query editor. create their very own templating query editor.
Additionally, if Grafana is running on a Google Compute Engine (GCE) virtual machine, it is now possible for Grafana to automatically retrieve default credentials from the metadata server. Additionally, if Grafana is running on a Google Compute Engine (GCE) virtual machine, it is now possible for Grafana to automatically retrieve default credentials from the metadata server.
This has the advantage of not needing to generate a private key file for the service account and also not having to upload the file to Grafana. [Learn more]({{< relref "../datasources/cloudmonitoring/#using-gce-default-service-account" >}}). This has the advantage of not needing to generate a private key file for the service account and also not having to upload the file to Grafana. [Learn more]({{< relref "../datasources/google-cloud-monitoring/_index.md/#using-gce-default-service-account" >}}).
Please read [Using Google Stackdriver in Grafana]({{< relref "../datasources/cloudmonitoring/" >}}) for more detailed information on how to get started and use it. Please read [Using Google Stackdriver in Grafana]({{< relref "../datasources/google-cloud-monitoring/_index.md/" >}}) for more detailed information on how to get started and use it.
<div class="clearfix"></div> <div class="clearfix"></div>
......
...@@ -114,7 +114,7 @@ will be shared soon. ...@@ -114,7 +114,7 @@ will be shared soon.
Built-in support for [Google Stackdriver](https://cloud.google.com/stackdriver/) is officially released in Grafana 6.0. Beta support was added in Grafana 5.3 and we have added lots of improvements since then. Built-in support for [Google Stackdriver](https://cloud.google.com/stackdriver/) is officially released in Grafana 6.0. Beta support was added in Grafana 5.3 and we have added lots of improvements since then.
To get started read the guide: [Using Google Stackdriver in Grafana]({{< relref "../datasources/cloudmonitoring/" >}}). To get started read the guide: [Using Google Stackdriver in Grafana]({{< relref "../datasources/google-cloud-monitoring/_index.md/" >}}).
## Azure Monitor data source ## Azure Monitor data source
......
...@@ -179,7 +179,7 @@ It was released as a beta feature in Grafana 6.7. The feedback has been really p ...@@ -179,7 +179,7 @@ It was released as a beta feature in Grafana 6.7. The feedback has been really p
## Stackdriver data source supports Service Monitoring ## Stackdriver data source supports Service Monitoring
[Service monitoring](https://cloud.google.com/service-monitoring) in Google Cloud Platform (GCP) enables you to monitor based on Service Level Objectives (SLOs) for your GCP services. The new SLO query builder in the Stackdriver data source allows you to display SLO data in Grafana. Read more about it in the [Stackdriver data source documentation]({{< relref "../datasources/cloudmonitoring/#slo-service-level-objective-queries" >}}). [Service monitoring](https://cloud.google.com/service-monitoring) in Google Cloud Platform (GCP) enables you to monitor based on Service Level Objectives (SLOs) for your GCP services. The new SLO query builder in the Stackdriver data source allows you to display SLO data in Grafana. Read more about it in the [Stackdriver data source documentation]({{< relref "../datasources/google-cloud-monitoring/_index.md/#slo-service-level-objective-queries" >}}).
## Time zone support ## Time zone support
......
...@@ -83,7 +83,7 @@ Additionally, the Raw Edit mode for Application Insights Analytics has been repl ...@@ -83,7 +83,7 @@ Additionally, the Raw Edit mode for Application Insights Analytics has been repl
## Deep linking for Google Cloud Monitoring (formerly named Google Stackdriver) data source ## Deep linking for Google Cloud Monitoring (formerly named Google Stackdriver) data source
A new feature in Grafana 7.1 is [deep linking from Grafana panels to the Metrics Explorer in Google Cloud Console]({{<relref "../datasources/cloudmonitoring.md#deep-linking-from-grafana-panels-to-the-metrics-explorer-in-google-cloud-console">}}). Click on a time series in the panel to see a context menu with a link to View in Metrics explorer in Google Cloud Console. Clicking that link opens the Metrics explorer in the Monitoring Google Cloud Console and runs the query from the Grafana panel there. A new feature in Grafana 7.1 is [deep linking from Grafana panels to the Metrics Explorer in Google Cloud Console]({{<relref "../datasources/google-cloud-monitoring/_index.md#deep-linking-from-grafana-panels-to-the-metrics-explorer-in-google-cloud-console">}}). Click on a time series in the panel to see a context menu with a link to View in Metrics explorer in Google Cloud Console. Clicking that link opens the Metrics explorer in the Monitoring Google Cloud Console and runs the query from the Grafana panel there.
## Time range picker update ## Time range picker update
......
...@@ -75,7 +75,7 @@ The updated Google Cloud monitoring data source is shipped with pre-configured d ...@@ -75,7 +75,7 @@ The updated Google Cloud monitoring data source is shipped with pre-configured d
To import the pre-configured dashboards, go to the configuration page of your Google Cloud Monitoring data source and click on the `Dashboards` tab. Click `Import` for the dashboard you would like to use. To customize the dashboard, we recommend to save the dashboard under a different name, because otherwise the dashboard will be overwritten when a new version of the dashboard is released. To import the pre-configured dashboards, go to the configuration page of your Google Cloud Monitoring data source and click on the `Dashboards` tab. Click `Import` for the dashboard you would like to use. To customize the dashboard, we recommend to save the dashboard under a different name, because otherwise the dashboard will be overwritten when a new version of the dashboard is released.
For more details, see the [Google Cloud Monitoring docs]({{<relref "../datasources/cloudmonitoring/#out-of-the-box-dashboards">}}) For more details, see the [Google Cloud Monitoring docs]({{<relref "../datasources/google-cloud-monitoring/_index.md/#out-of-the-box-dashboards">}})
## Shorten URL for dashboards and Explore ## Shorten URL for dashboards and Explore
......
...@@ -2,20 +2,19 @@ ...@@ -2,20 +2,19 @@
<div class="grafana-info-box"> <div class="grafana-info-box">
<h4>Google Cloud Monitoring Authentication</h4> <h4>Google Cloud Monitoring Authentication</h4>
<p> <p>
There are two ways to authenticate the Google Cloud Monitoring plugin - either by uploading a Service Account key file, or by There are two ways to authenticate the Google Cloud Monitoring plugin - either by uploading a Service Account key file or by
automatically retrieving credentials from the Google metadata server. The latter option is only available when automatically retrieving credentials from the Google metadata server. The latter option is only available when
running Grafana on a GCE virtual machine. running Grafana on a GCE virtual machine.
</p> </p>
<h5>Uploading a Service Account Key File</h5> <h5>Uploading a Service Account Key File</h5>
<p> <p>
First you need to create a Google Cloud Platform (GCP) Service Account for the Project you want to show data for. There are two ways to authenticate the Google Cloud Monitoring plugin. You can upload a Service Account key file or automatically retrieve
A Grafana datasource integrates with one GCP Project. If you want to visualize data from multiple GCP Projects credentials from the Google metadata server. The latter option is only available when running Grafana on a GCE virtual machine.
then you need to create one datasource per GCP Project.
</p> </p>
<p> <p>
The <strong>Monitoring Viewer</strong> role provides all the permissions that Grafana needs. The following API The <strong>Monitoring Viewer</strong> role provides all the permissions that Grafana needs. The following API
needs to be enabled on GCP for the datasource to work: needs to be enabled on GCP for the data source to work:
<a <a
class="external-link" class="external-link"
target="_blank" target="_blank"
...@@ -34,7 +33,7 @@ ...@@ -34,7 +33,7 @@
<p> <p>
Detailed instructions on how to create a Service Account can be found Detailed instructions on how to create a Service Account can be found
<a class="external-link" target="_blank" href="https://grafana.com/docs/grafana/latest/datasources/cloudmonitoring/" <a class="external-link" target="_blank" href="https://grafana.com/docs/grafana/latest/datasources/google-cloud-monitoring/_index.md"
>in the documentation.</a >in the documentation.</a
> >
</p> </p>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment