Upgrade grafana datasource name and documentation (#236)

Conflux-Chain · Oct 18, 2024 · df78ee7 · df78ee7
1 parent 09ee1a8
commit df78ee7
Show file tree

Hide file tree

Showing 15 changed files with 50 additions and 48 deletions.
diff --git a/doc/DEPLOY.md b/doc/DEPLOY.md
@@ -108,7 +108,7 @@ To set up Grafana, follow these steps:
 1. Configure InfluxDB as a Data Source:
 - Open the Grafana web interface.
 - Go to the data sources section and add InfluxDB as a data source.
-- Name the data source `infura_testnet` or `infura_mainet`, depending on your environment.
+- Name the data source `confura_testnet` or `confura_mainnet`, depending on your environment.
 
 2. Import the Dashboard Configuration:
 - Refer to the [Grafana Dashboard](../grafana/README.md) for the provided dashboard configuration files.

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -15,7 +15,7 @@ services:
     environment:
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-node-management
 
   ethnode-management:
@@ -32,7 +32,7 @@ services:
     environment:
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-ethnode-management
 
   # blockchain sync
@@ -51,7 +51,7 @@ services:
       - INFURA_STORE_MYSQL_DSN=root:root@tcp(db:3306)/confura_cfx?parseTime=true
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-sync
 
   ethchain-sync:
@@ -70,7 +70,7 @@ services:
       - INFURA_SYNC_ETH_FROMBLOCK=36935000
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-ethsync
 
   # virtual filter
@@ -91,7 +91,7 @@ services:
       - INFURA_STORE_MYSQL_DSN=root:root@tcp(db:3306)/confura_cfx?parseTime=true
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-virtual-filter
 
   ethvirtual-filter:
@@ -111,7 +111,7 @@ services:
       - INFURA_ETHSTORE_MYSQL_DSN=root:root@tcp(db:3306)/confura_eth?parseTime=true
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-ethvirtual-filter
 
   # rpc proxy
@@ -137,7 +137,7 @@ services:
       - INFURA_VIRTUALFILTERS_CLIENT_SERVICERPCURL=http://virtual-filter:42537
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-rpc
 
   ethrpc-proxy:
@@ -162,7 +162,7 @@ services:
       - INFURA_ETHVIRTUALFILTERS_CLIENT_SERVICERPCURL=http://ethvirtual-filter:48545
       - INFURA_METRICS_ENABLED=true
       - INFURA_METRICS_INFLUXDB_HOST=http://influxdb:8086
-      - INFURA_METRICS_INFLUXDB_DB=infura_testnet
+      - INFURA_METRICS_INFLUXDB_DB=confura_testnet
     container_name: confura-ethrpc
 
   # middlewares
@@ -190,7 +190,7 @@ services:
       - path: .env
         required: false
     environment:
-      - INFLUXDB_DB=infura_testnet
+      - INFLUXDB_DB=confura_testnet
     volumes:
       - influxdb-data:/var/lib/influxdb
     container_name: confura-influxdb

diff --git a/grafana/Node-Management.json b/grafana/Node-Management.json
@@ -457,8 +457,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,

diff --git a/grafana/README.md b/grafana/README.md
@@ -3,16 +3,18 @@
 This folder contains all dashboard JSON models which can be imported into Grafana.
 | Json Model          	| Description                               	|
 |---------------------	|-------------------------------------------	|
-| RPC-RED-Overview    	| RED metrics overview for RPC proxy        	|
-| RPC-RED-Drilldown   	| RED metrics drilldown for RPC proxy       	|
+| RPC-RED-Overview    	| `RED` metrics overview for RPC proxy        	|
+| RPC-RED-Drilldown   	| `RED` metrics drilldown for RPC proxy       	|
 | RPC-Input-Breakdown 	| Input parameter breakdown for RPC proxy   	|
 | RPC-Batch           	| JSON-RPC batch requests for RPC proxy     	|
 | RPC-PubSub          	| Websocket Pub/Sub metrics for RPC proxy   	|
 | RPC-Fullnode-Proxy  	| Full node proxy metrics for RPC proxy     	|
 | RPC-Store-Ops       	| Store operation metrics for RPC proxy     	|
 | Node-Management     	| Node cluster management metrics           	|
-| Sync-RED            	| RED metrics for indexing sync             	|
+| Sync-RED            	| `RED` metrics for indexing sync             	|
 | Sync-Fullnode-Query 	| Full node query metrics for indexing sync 	|
 | Sync-Store-Ops      	| Store operation metrics for indexing sync 	|
 | Virtual-Filter      	| Operation (eg., polling) metrics for filter 	|
+
 *`RED`: Three key metrics are collected: `Rate`, `Error` and `Duration`.*
+> **Note**: Any InfluxDB data sources created in Grafana must have a name starting with the `confura_*` prefix for proper integration with these dashboards.
diff --git a/grafana/RPC-Batch.json b/grafana/RPC-Batch.json
@@ -471,8 +471,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -485,7 +485,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       }

diff --git a/grafana/RPC-Fullnode-Proxy.json b/grafana/RPC-Fullnode-Proxy.json
@@ -924,8 +924,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -938,7 +938,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/RPC-Input-Breakdown.json b/grafana/RPC-Input-Breakdown.json
@@ -1057,8 +1057,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_testnet",
-          "value": "infura_testnet"
+          "text": "confura_testnet",
+          "value": "confura_testnet"
         },
         "description": null,
         "error": null,
@@ -1071,7 +1071,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/RPC-PubSub.json b/grafana/RPC-PubSub.json
@@ -284,8 +284,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -298,7 +298,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/RPC-RED-Drilldown.json b/grafana/RPC-RED-Drilldown.json
@@ -859,8 +859,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -873,7 +873,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/RPC-RED-Overview.json b/grafana/RPC-RED-Overview.json
@@ -1951,8 +1951,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -1965,7 +1965,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/RPC-Store-Ops.json b/grafana/RPC-Store-Ops.json
@@ -558,8 +558,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -572,7 +572,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/Sync-Fullnode-Query.json b/grafana/Sync-Fullnode-Query.json
@@ -996,8 +996,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -1010,7 +1010,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       }

diff --git a/grafana/Sync-RED.json b/grafana/Sync-RED.json
@@ -1883,8 +1883,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -1897,7 +1897,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       }

diff --git a/grafana/Sync-Store-Ops.json b/grafana/Sync-Store-Ops.json
@@ -796,8 +796,8 @@
       {
         "current": {
           "selected": false,
-          "text": "infura_mainet",
-          "value": "infura_mainet"
+          "text": "confura_mainnet",
+          "value": "confura_mainnet"
         },
         "description": null,
         "error": null,
@@ -810,7 +810,7 @@
         "query": "influxdb",
         "queryValue": "",
         "refresh": 1,
-        "regex": "/.*infura_*./",
+        "regex": "/.*confura_*./",
         "skipUrlSync": false,
         "type": "datasource"
       },

diff --git a/grafana/Virtual-Filter.json b/grafana/Virtual-Filter.json
@@ -1439,8 +1439,8 @@
         {
           "current": {
             "selected": true,
-            "text": "infura_testnet",
-            "value": "infura_testnet"
+            "text": "confura_testnet",
+            "value": "confura_testnet"
           },
           "description": null,
           "error": null,
@@ -1453,7 +1453,7 @@
           "query": "influxdb",
           "queryValue": "",
           "refresh": 1,
-          "regex": "/.*infura_*./",
+          "regex": "/.*confura_*./",
           "skipUrlSync": false,
           "type": "datasource"
         },