Migrate existing Metrics Viewer (Grafana) dashboards to external instance

Summary

With the upcoming removal of the system managed Grafana instance in ArcGIS Enterprise on Kubernetes, organizations that have invested significant time and effort into customizing their dashboards will want to export those resources and import to an externally-managed option.

This will walk through the process of exporting the associated dashboard JSON models, setting up the managed Metrics API (Prometheus) endpoint as a data source in both in-cluster and external scenarios, and importing the dashboard configurations.

Procedure

Export existing dashboards to files:

1. Access the system managed Metrics Viewer at https://<FQDN>/<context>/grafana
2. Go to Dashboards -> Manage Dashboards
3. For each dashboard:
   1. Access the dashboard and click the gear in the top right
   2. Go to JSON model in the left pane
   3. Copy the JSON to a text editor and save to file

Configure ArcGIS Enterprise on Kubernetes metrics API as data source in external visualization tool:

1. Open data source configuration page
2. Apply the following properties:
   1. URL – https://<FQDN>/<context>/prometheus for access outside cluster or https://arcgis-rest-metrics-api.<namespace>.svc.cluster.local:8443/arcgis/prometheus for internal connections
   2. Authentication – Basic (may need to update credentials via Usage Statistics API, for more information see documentation)
      1. Username – Original administrator account created with organization
      2. Password – Set by administrator in Usage Statistics API
   3. SSL Certificate Verification – If using an external connection, a trusted certificate is already being used. If using an internal connection, you may need to disable certificate verification for the cluster service endpoint.
3. Save and test configuration

Import dashboard to self-managed Grafana:

1. Login to Grafana instance
2. Go to Dashboards
3. Click New -> Import
4. Upload JSON
5. Assign new title and unique identifier as necessary
6. Click Load

Update data sources in dashboard JSON:

The dashboard will use the default data source for the instance unless otherwise specified, each panel may need to be updated to point at the correct data source if multiple exist:

1. Access dashboard in edit mode
2. Click … at top right of panel
3. Select correct connection in Data source drop-down
4. Repeat for all panels
5. Save changes to dashboard