Setup Dashboards (Grafana) Service¶
Overview¶
Dashboards is a managed data visualization service that makes it easy to query, correlate and visualize metrics, logs from distributed cloud applications. It is built on fully open-source technology (Grafana) and supports unlimited dashboards.
Grafana is commonly used with Prometheus to visualize time series (metrics) data. This topic describes how to setup a Grafana service instance to visualize metrics data.
Prerequisites¶
User must setup a metrics service for the an application.
Setup¶
Create a Dashboards (Grafana) Service¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
The table will be empty if there are no Dashboard
services being created in the system.
To create a new Dashboard
service, click on CREATE
on the top right corner. A new form will appear under Dashboards > Create
.
Provide the following informaiton in the form:
- Name: Name of the
Dashboard
service. This is usually an alpha-numeric string. For example, orders-app-dashboard. - Data source (metrics): Pick the
Metrics Service
this Grafana based dashboard will be visualizing. - Labels: Optional Key/Value information that may be added to this service. This enables you to categorize the resources in flexible ways. Use the
+
symbol to add additional labels.
Click SUBMIT
to create the Dashboard
service.
User may create a dedicated Grafana dashboard service using create
subcommand and provide the name of the metrics service using --data-source
option.
caeops dashboards create --name=demo-grafana-dashboard --labels=[{app=demo-app},{env=dev}] --data-source=demo-metrics-service
CloudAEye SaaS will connect the metrics service (Prometheus) as a data-source with Grafana dashboards service to fascilitate proper wiring out-of-the-box.
List All Grafana Dashboard(s)¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
User may see a list of all Grafana dashboards for the account using list
subcommand.
caeops dashboards list
Get Details of a Grafana Dashboard¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
To view the details of a service, click on the service name hyperlink under Service Name
column.
The following information is shown:
- Service name - Name of the service.
- Region - Name of the public cloud region where the service is running.
- Service endpoint - URL of the service endpoint.
- Labels - Key/Value information associated with the service.
- Create date - Date when the service was created.
- Update date - Date when the service was last updated.
User may see details of a Grafana dashboard using get
subcommand.
caeops dashboards get --name=demo-grafana-dashboard
Add Labels to Grafana Dashboard¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
To view the details of a service, click on the service name hyperlink under Service Name
column.
Click on the pencil icon next the 'Labels'. A new form will appear. Add the Key / Value pair(s).
Click DONE
to save the lable(s).
User may add labels to a Grafana dashboard to keep track of all the service instance using add-labels
subcommand.
caeops dashboards add-labels --name=demo-grafana-dashboard --labels=[{owner=nazrul},{dept=sales}]
Get Labels for a Grafana Dashboard¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
To view the details of a service, click on the service name hyperlink under Service Name
column.
All associated labels for this service will be shown next to Labels
.
User may see all the labels for a Grafana dashboard using get-labels
subcommand.
caeops dashboards get-labels --name=demo-grafana-dashboard
Delete Labels from a Grafana Dashboard¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
To view the details of a service, click on the service name hyperlink under Service Name
column.
All associated labels for this service will be shown next to Labels
.
Click on the pencil icon to make changes to the labels.
Click on X
icon to remove labels.
Click DONE
to save the updated lables.
User may remove labels from a Grafana dashboard to keep track of all the service instance using delete-labels
subcommand.
caeops dashboards delete-labels --name=demo-grafana-dashboard --labels=[{owner=nazrul}]
Delete a Grafana Dashboard¶
From left navigation menu, select Services > Dashboards
.
A list of Dashboard
services that are already created will be shown.
Click on X
icon under Actions
column.
A confirmation windown will be shown.
Click CONFIRM
to delete the Dashboard
service.
User may delete a Grafana dashboard using delete
subcommand.
caeops dashboards delete --name=demo-grafana-dashboard