How to configure and visualize internal GroundWork metrics

WAS THIS PAGE HELPFUL? Leave Feedback

Overview

This page reviews how to configure internal GroundWork metrics and how to visualize internal metrics in Grafana.

Steps

Configuring internal GroundWork metrics

By default, internal GroundWork application metrics are gathered and stored in InfluxDB in the _groundwork_metrics database. If you wish to turn this off:

1. In the following directory:

   /usr/local/groundwork/config/

2. Edit the following file:

   foundation.properties

3. Under the Metrics Configuration section, set the following:

   collage.metrics.enabled = false

4. Save the file.
5. Restart GroundWork:

   /etc/init.d/groundwork restart

   Other properties in foundation.properties beginning with collage.metrics can be used to control internal metrics gathering.

Visualizing GroundWork internal metrics in Grafana

In GroundWork Grafana, sign in as an Administrator and create a new InfluxDB data source called GroundWork Internal Metrics, pointing to the _groundwork_metrics database.

1. Log into GroundWork Monitor as an Administrator (e.g., admin/admin).
2. Go to Dashboards > Grafana.
3. To log in as the Grafana Administrator, click , click Sign In. The default credentials are admin/admin.
4. Click , and select Data Sources.
5. Click the Add data source button.
6. Create a new InfluxDB data source with the following parameters:
   Name: (e.g., GroundWork Internal Metrics)
   Type: InfluxDB
   URL: http://localhost:8086
   Access: proxy
   Database: _groundwork_metrics
7. GroundWork internal metrics dashboards are located in the directory:

   /usr/local/groundwork/grafana/data/gwsupportdashboards

8. To import the metrics, use the option;

   grafbridge-control -import_dashboards

9. See grafbridge-control --help for details. This utility is located in /usr/local/groundwork/grafana/scripts. You can enter ./grafbridge-control --help to view the built-in manual page.
10. You can now use the imported dashboards to visualize GroundWork internal metrics data.
    
    Figure: Add data source