renamed replication, added shard and proxy-threads (#2497)

* renamed replication, added shard and proxy-threads * fix changelog and bump version * add summary to dashboard * corrected changelog * more changelog corrections * set type for node metrics that don't report it, add missing listener metrics * fixed tests to consider newly added metrics * lint * changed endpoint description to enterprise * add cluster_shard_limit * line-break lint * added missing descriptiions for new dashboards * fix typos * bump version in README * edit content description of proxy-threads dashboard * typo in readme * manifest edits
DataDog · Oct 17, 2024 · 36d8a8e · 36d8a8e
1 parent e64bd91
commit 36d8a8e
Show file tree

Hide file tree

Showing 13 changed files with 2,217 additions and 48 deletions.
diff --git a/redis_enterprise/CHANGELOG.md b/redis_enterprise/CHANGELOG.md
@@ -1,12 +1,28 @@
 # CHANGELOG - Redis Enterprise
 
+## 1.1.0 / 2024-10-06
+
+***Changed***:
+
+* Renamed Replication as Active-Active
+
+***Added***:
+
+* Added Shard dashboard
+* Added Proxy Threads dashboard
+
 ## 1.0.1 / 2024-08-09
 
-* Added Replication, Proxy, and Proxy Threads Dashboards
+***Changed***:
+
 * Fixed issue with extra_metrics not being reported
+* Updated configuration documentation
+
+***Added***:
+
+* Added Replication and Proxy Dashboards
 * Added tests to check all additional metrics
 * Added node_cert_expiration_seconds to Node metrics
-* Updated configuration documentation
 
 ## 1.0.0 / 2024-05-02
 

diff --git a/redis_enterprise/README.md b/redis_enterprise/README.md
@@ -16,7 +16,7 @@ For a full list of supported metrics, see the [Metrics](#metrics) section below.
 
 1. Run the following command to install the Agent integration:
    ```shell
-   datadog-agent integration install -t datadog-redis_enterprise==1.0.0
+   datadog-agent integration install -t datadog-redis_enterprise==1.1.0
    ```
 
 2. Configure the integration by setting the `openmetrics_endpoint` to your cluster's master node. See [Integration][2] for further information.
@@ -40,18 +40,18 @@ become 'bdb_up'. The full list of metrics is available on the 'Data Collected' t
 The following extra groups use the associated prefixes, which can be used to search for individual metrics on 
 the data collected page.
 
-| Group           | Prefix                      | Notes                                                |
-|-----------------|-----------------------------|------------------------------------------------------|
-| RDSE.NODE       | rdse.node_                  | This will return bigstore and flash metrics as well  |
-| RDSE.DATABASE   | rdse.bdb_                   | This will return replication metrics as well         |
-| RDSE.SHARD      | rdse.redis_                 | This will return shard replication metrics as well   |
-| RDSE.REPLCATION | rdse.bdb_crdt_              |                                                      |
-| RDSE.REPLCATION | rdse.bdb_replicaof_         |                                                      |
-| RDSE.SHARDREPL  | rdse.redis_crdt_            |                                                      |
-| RDSE.PROXY      | rdse.dmcproxy_              |                                                      |
-| RDSE.LISTENER   | rdse.listener_              |                                                      |
-| RDSE.BIGSTORE   | rdse.node_bigstore_         |                                                      |
-| RDSE.FLASH      | rdse.node_available_flash   | All flash metrics are of the form: rdse.node_*_flash |
+| Group            | Prefix                      | Notes                                                |
+|------------------|-----------------------------|------------------------------------------------------|
+| RDSE.NODE        | rdse.node_                  | This will return bigstore and flash metrics as well  |
+| RDSE.DATABASE    | rdse.bdb_                   | This will return replication metrics as well         |
+| RDSE.SHARD       | rdse.redis_                 | This will return shard replication metrics as well   |
+| RDSE.REPLICATION | rdse.bdb_crdt_              |                                                      |
+| RDSE.REPLICATION | rdse.bdb_replicaof_         |                                                      |
+| RDSE.SHARDREPL   | rdse.redis_crdt_            |                                                      |
+| RDSE.PROXY       | rdse.dmcproxy_              |                                                      |
+| RDSE.LISTENER    | rdse.listener_              |                                                      |
+| RDSE.BIGSTORE    | rdse.node_bigstore_         |                                                      |
+| RDSE.FLASH       | rdse.node_available_flash   | All flash metrics are of the form: rdse.node_*_flash |
 
 ### Validation
 

diff --git a/redis_enterprise/assets/configuration/spec.yaml b/redis_enterprise/assets/configuration/spec.yaml
@@ -11,7 +11,7 @@ files:
       overrides:
         openmetrics_endpoint.value.example: https://<host>:8070/metrics
         openmetrics_endpoint.description: |
-          The endpoint should be the URL of the metric exporter of the cloud instance
+          The endpoint should be the URL of the metric exporter of the enterprise instance
         openmetrics_endpoint.display_priority: 3
         tls_verify.value.example: false
         tls_verify.enabled: true

diff --git a/...hboards/redis_enterprise_replication.json → ...oards/redis_enterprise_active-active.json b/...hboards/redis_enterprise_replication.json → ...oards/redis_enterprise_active-active.json
@@ -1,16 +1,37 @@
 {
-  "title": "Redis Enterprise - Replication",
-  "description": "[[suggested_dashboards]]",
+  "title": "Redis Enterprise - Active-Active",
+  "description": "Redis Enterprise Active-Active provides details on the status of replication",
   "widgets": [
     {
       "id": 1612047639653128,
       "definition": {
         "title": "Summary",
-        "background_color": "vivid_blue",
+        "background_color": "blue",
         "show_title": true,
         "type": "group",
         "layout_type": "ordered",
         "widgets": [
+          {
+            "id": 2915118368107020,
+            "definition": {
+              "type": "note",
+              "content": "In Redis Enterprise, Active-Active geo-distribution is based on CRDT technology. The Redis Enterprise implementation of CRDT is called an Active-Active database (formerly known as CRDB). With Active-Active databases, applications can read and write to the same data set from different geographical locations seamlessly and with latency less than one millisecond (ms), without changing the way the application connects to the database.\n\nActive-Active databases also provide disaster recovery and accelerated data read-access for geographically distributed users.",
+              "background_color": "vivid_blue",
+              "font_size": "14",
+              "text_align": "left",
+              "vertical_align": "top",
+              "show_tick": false,
+              "tick_pos": "50%",
+              "tick_edge": "left",
+              "has_padding": true
+            },
+            "layout": {
+              "x": 0,
+              "y": 0,
+              "width": 6,
+              "height": 4
+            }
+          },
           {
             "id": 2930533713442618,
             "definition": {
@@ -43,7 +64,7 @@
               }
             },
             "layout": {
-              "x": 0,
+              "x": 6,
               "y": 0,
               "width": 2,
               "height": 2
@@ -81,16 +102,16 @@
               }
             },
             "layout": {
-              "x": 2,
+              "x": 8,
               "y": 0,
               "width": 2,
               "height": 2
             }
           },
           {
-            "id": 6989215750840428,
+            "id": 8236114950898096,
             "definition": {
-              "title": "Replication Backlog",
+              "title": "Pending Garbage Collection",
               "title_size": "16",
               "title_align": "left",
               "type": "query_value",
@@ -101,7 +122,7 @@
                     {
                       "data_source": "metrics",
                       "name": "query1",
-                      "query": "avg:rdse.redis_crdt_backlog_histlen{role:master , $cluster}",
+                      "query": "avg:rdse.redis_crdt_gc_collected{$cluster}",
                       "aggregator": "avg"
                     }
                   ],
@@ -119,7 +140,7 @@
               }
             },
             "layout": {
-              "x": 4,
+              "x": 10,
               "y": 0,
               "width": 2,
               "height": 2
@@ -158,15 +179,15 @@
             },
             "layout": {
               "x": 6,
-              "y": 0,
+              "y": 2,
               "width": 2,
               "height": 2
             }
           },
           {
-            "id": 3111427893009204,
+            "id": 6989215750840428,
             "definition": {
-              "title": "Pending Max Writes",
+              "title": "Replication Backlog",
               "title_size": "16",
               "title_align": "left",
               "type": "query_value",
@@ -177,7 +198,7 @@
                     {
                       "data_source": "metrics",
                       "name": "query1",
-                      "query": "avg:rdse.bdb_crdt_syncer_egress_bytes_max{$cluster}",
+                      "query": "avg:rdse.redis_crdt_backlog_histlen{role:master , $cluster}",
                       "aggregator": "avg"
                     }
                   ],
@@ -196,15 +217,15 @@
             },
             "layout": {
               "x": 8,
-              "y": 0,
+              "y": 2,
               "width": 2,
               "height": 2
             }
           },
           {
-            "id": 8236114950898096,
+            "id": 3111427893009204,
             "definition": {
-              "title": "Pending Garbage Collection",
+              "title": "Pending Max Writes",
               "title_size": "16",
               "title_align": "left",
               "type": "query_value",
@@ -215,7 +236,7 @@
                     {
                       "data_source": "metrics",
                       "name": "query1",
-                      "query": "avg:rdse.redis_crdt_gc_collected{$cluster}",
+                      "query": "avg:rdse.bdb_crdt_syncer_egress_bytes_max{$cluster}",
                       "aggregator": "avg"
                     }
                   ],
@@ -234,7 +255,7 @@
             },
             "layout": {
               "x": 10,
-              "y": 0,
+              "y": 2,
               "width": 2,
               "height": 2
             }
@@ -245,7 +266,7 @@
         "x": 0,
         "y": 0,
         "width": 12,
-        "height": 3
+        "height": 5
       }
     },
     {
@@ -359,7 +380,7 @@
       },
       "layout": {
         "x": 0,
-        "y": 3,
+        "y": 5,
         "width": 12,
         "height": 5
       }
@@ -475,9 +496,10 @@
       },
       "layout": {
         "x": 0,
-        "y": 8,
+        "y": 0,
         "width": 12,
-        "height": 5
+        "height": 5,
+        "is_column_break": true
       }
     },
     {
@@ -591,7 +613,7 @@
       },
       "layout": {
         "x": 0,
-        "y": 13,
+        "y": 5,
         "width": 12,
         "height": 5
       }