Creating an OpenShift Console dashboard

You can use OpenShift ConfigMaps to create a dashboard that allows you to view metrics on the OpenShift Console.

Before you begin

For the creation of an OpenShift dashboard, you need a JSON definition file (named datagate_table_sync_openshift_dashboard.json in this topic). Call IBM support to request this file.

About this task

The OpenShift Console can display custom dashboards that were defined by using ConfigMaps. You must create the ConfigMap in the openshift-config-managed namespace and use the legacy Grafana dashboard format (schema version 14 instead of schema version 38+). Version 14 uses rows containing panels rather than a top-level panels array.

1. Download this file to your OpenShift server:
   datagate_table_sync_openshift_dashboard
2. To create a dashboard of this type from the command-line of your OpenShift server, enter the command below. Make sure that the file you downloaded in step 1 is in the current directory.

   oc create configmap datagate-table-sync-dashboard \
     --from-file=datagate-table-sync.json=datagate_table_sync_openshift_dashboard.json \
     --namespace=openshift-config-managed \
     --dry-run=client -o yaml | \
     oc label -f - console.openshift.io/dashboard=true --local --dry-run=client -o yaml | \
     oc apply -f -

3. To display the dashboard, open the OpenShift Console and click Observe > Dashboards

Results

The dashboard displays the following information:

Overview

Four single-stat panels the replication status, the current latency, the insert rate, and the delete rate.

Latency

The synchronization latency over time.

Throughput

Number of synchronized rows per second and the total number of synchronized rows (inserted rows as opposed to deleted) rows.

Operation Details

A breakdown of the total number of operations into:

• Insert operations
• Update operations
• Delete operations
• Compensated operations
• Utility record operations

Advanced Metrics

Net effect operations and capture time.

Metrics Collection Health

Rate of successful refreshes and refresh failures, as well as refresh duration times.