Updated signal files to align to dashboards. Reworked signals to better use builder pattern. Updated panels for best practices

Author: postnati

opensearch-mixin/config.libsonnet

@@ -1,33 +1,28 @@
 {
   local this = self,
-  filteringSelector: if self.enableMultiCluster then 'cluster!="",opensearch_cluster!=""' else 'opensearch_cluster!=""',
-  groupLabels: if self.enableMultiCluster then ['job', 'cluster', 'opensearch_cluster'] else ['job', 'opensearch_cluster'],
-  logLabels: ['job', 'cluster', 'node'],
-  instanceLabels: ['node'],
+  filteringSelector: 'job="integrations/opensearch"',
+  groupLabels: ['job', 'cluster', 'opensearch_cluster'],
+  logLabels: ['job', 'cluster', 'opensearch_cluster'],
+  instanceLabels: ['instance'],
 
-  dashboardTags: [self.uid],
   uid: 'opensearch',
+  dashboardTags: [self.uid],
   dashboardNamePrefix: 'OpenSearch',
   dashboardPeriod: 'now-1h',
   dashboardTimezone: 'default',
   dashboardRefresh: '1m',
   metricsSource: 'prometheus',  // metrics source for signals
 
-  // Agg Lists
-  groupAggList: std.join(',', this.groupLabels),
-  groupAggListWithInstance: std.join(',', this.groupLabels + this.instanceLabels),
-  
-  // Multi-cluster support
-  enableMultiCluster: false,
-  opensearchSelector: if self.enableMultiCluster then 'job=~"$job", instance=~"$instance", cluster=~"$cluster"' else 'job=~"$job", instance=~"$instance"',
-
   // Logging configuration
   enableLokiLogs: true,
   extraLogLabels: ['level', 'severity'],  // Required by logs-lib
   logsVolumeGroupBy: 'level',
   showLogsVolume: true,
-  logExpression: '{job=~"$job", cluster=~"$cluster", instance=~"$instance", exception_class=~".+"} | json | line_format "{{.severity}} {{.exception_class}} - {{.exception_message}}" | drop time_extracted, severity_extracted, exception_class_extracted, correlation_id_extracted',
 
+  // Agg Lists
+  groupAggList: std.join(',', this.groupLabels),
+  groupAggListWithInstance: std.join(',', this.groupLabels + this.instanceLabels),
+  
   // Alerts configuration
   alertsWarningShardReallocations: 0,  // count
   alertsWarningShardUnassigned: 0,  // count
@@ -42,11 +37,8 @@
 
   // Signals configuration
   signals+: {
-    cluster: (import './signals/cluster.libsonnet')(this),
-    node: (import './signals/node.libsonnet')(this),
-    topk: (import './signals/topk.libsonnet')(this),
-    roles: (import './signals/roles.libsonnet')(this),
-    search: (import './signals/search.libsonnet')(this),
-    indexing: (import './signals/indexing.libsonnet')(this),
+    clusterOverview: (import './signals/cluster-overview.libsonnet')(this),
+    nodeOverview: (import './signals/node-overview.libsonnet')(this),
+    searchAndIndexOverview: (import './signals/search-and-index-overview.libsonnet')(this),
   },
-}
+}

opensearch-mixin/dashboards.libsonnet

@@ -16,12 +16,12 @@ local logslib = import 'logs-lib/logs/main.libsonnet';
     {
 
       'opensearch-cluster-overview.json':
-        g.dashboard.new(this.config.dashboardNamePrefix + ' Cluster Overview')
+        g.dashboard.new(this.config.dashboardNamePrefix + ' cluster overview')
         + g.dashboard.withPanels(
           g.util.panel.resolveCollapsedFlagOnRows(
             g.util.grid.wrapPanels([
               this.grafana.rows.clusterOverviewRow,
-              this.grafana.rows.rolesRow,
+              this.grafana.rows.clusterRolesRow,
               this.grafana.rows.resourceUsageRow,
               this.grafana.rows.storageAndTasksRow,
               this.grafana.rows.searchPerformanceRow,
@@ -40,18 +40,24 @@ local logslib = import 'logs-lib/logs/main.libsonnet';
           period,
         ),
       'opensearch-node-overview.json':
-        g.dashboard.new(this.config.dashboardNamePrefix + ' Node Overview')
+        g.dashboard.new(this.config.dashboardNamePrefix + ' node overview')
         + g.dashboard.withPanels(
           g.util.panel.resolveCollapsedFlagOnRows(
             g.util.grid.wrapPanels([
-            this.grafana.rows.nodeRolesRow,
             this.grafana.rows.nodeHealthRow,
+            this.grafana.rows.nodeRolesRow,
             this.grafana.rows.nodeJVMRow,
             this.grafana.rows.threadPoolsRow,
             ])
           )
         ) + root.applyCommon(
-          vars.multiInstance,
+          vars.multiInstance + [
+            g.dashboard.variable.query.new('node')
+            + g.dashboard.variable.custom.selectionOptions.withMulti(true)
+            + g.dashboard.variable.query.queryTypes.withLabelValues(label='node', metric='opensearch_os_cpu_percent{%(queriesSelector)s}' % vars)
+            + g.dashboard.variable.query.withDatasourceFromVariable(vars.datasources.prometheus),
+
+          ],
           uid + '-node-overview',
           tags,
           links { opensearchNodeOverview+:: {} },
@@ -61,17 +67,22 @@ local logslib = import 'logs-lib/logs/main.libsonnet';
           period,
         ),
       'opensearch-search-and-index-overview.json':
-        g.dashboard.new(this.config.dashboardNamePrefix + ' Search and Index Overview')
+        g.dashboard.new(this.config.dashboardNamePrefix + ' search and index overview')
         + g.dashboard.withPanels(
           g.util.panel.resolveCollapsedFlagOnRows(
             g.util.grid.wrapPanels([
-              this.grafana.rows.searchAndIndexSearchPerformanceRow,
+              this.grafana.rows.searchAndIndexRequestPerformanceRow,
               this.grafana.rows.searchAndIndexIndexingPerformanceRow,
               this.grafana.rows.searchAndIndexCapacityRow,
             ])
           )
         ) + root.applyCommon(
-          vars.multiInstance,
+          vars.multiInstance + [
+            g.dashboard.variable.query.new('index')
+            + g.dashboard.variable.custom.selectionOptions.withMulti(true)
+            + g.dashboard.variable.query.queryTypes.withLabelValues(label='index', metric='opensearch_index_search_fetch_count{%(queriesSelectorGroupOnly)s}' % vars)
+            + g.dashboard.variable.query.withDatasourceFromVariable(vars.datasources.prometheus),
+          ],
           uid + '-search-and-index-overview',
           tags,
           links { opensearchSearchAndIndexOverview+:: {} },
@@ -84,7 +95,7 @@ local logslib = import 'logs-lib/logs/main.libsonnet';
     } + if this.config.enableLokiLogs then {
       'opensearch-logs.json':
         logslib.new(
-          this.config.dashboardNamePrefix + ' Logs',
+          this.config.dashboardNamePrefix + ' logs',
           datasourceName=this.grafana.variables.datasources.loki.name,
           datasourceRegex=this.grafana.variables.datasources.loki.regex,
           filterSelector=this.config.filteringSelector,
@@ -96,7 +107,7 @@ local logslib = import 'logs-lib/logs/main.libsonnet';
           dashboards+:
             {
               logs+:
-                root.applyCommon(vars.multiInstance, uid=uid + '-logs', tags=tags, links=links { logs+:: {} }, annotations=annotations, timezone=timezone, refresh=refresh, period=period),
+                root.applyCommon(super.logs.templating.list, uid=uid + '-logs', tags=tags, links=links { logs+:: {} }, annotations=annotations, timezone=timezone, refresh=refresh, period=period),
             },
           panels+:
             {