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

A new data source will need to be created for the dashboard to be populated. 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. Log in as the Grafana Administrator by scrolling to the bottom of the page, hovering over the arrow icon and clicking Sign In. The default credentials are admin/admin.
4. Click the gear icon 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: Server
   • Database: _groundwork_metrics
7. GroundWork internal metrics dashboards are located in the directory:

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

8. To import the metrics, change to the /usr/local/groundwork/grafana/scripts directory and use the option: 

   ./grafbridge-control -import_dashboards /usr/local/groundwork/grafana/data/gwsupportdashboards/

   • 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.
9. You can now import and use the dashboard to visualize GroundWork internal metrics data.
   • The groundwork-internal-metrics.json file is stored in the /usr/local/groundwork/grafana/data/gwsupportdashboards directory.