Update observ lib 'schema'

windows-mixin/mixin.libsonnet

@@ -13,15 +13,17 @@ local config = (import 'config.libsonnet')._config;
     {
       config+: config,
     },
-  prometheusAlerts+:: windows.alerts,
+  prometheusAlerts+:: windows.prometheus.alerts,
   grafanaDashboards+::
     (windows {
-       variables+: {
-         datasources+: {
-           loki+: var.datasource.withRegex('Loki|.+logs'),
-           prometheus+: var.datasource.withRegex('Prometheus|Cortex|Mimir|grafanacloud-.+-prom'),
+       grafana+: {
+         variables+: {
+           datasources+: {
+             loki+: var.datasource.withRegex('Loki|.+logs'),
+             prometheus+: var.datasource.withRegex('Victoria|Prometheus|Cortex|Mimir|grafanacloud-.+-prom'),
+           },
          },
        },
      })
-    .dashboards,
+    .grafana.dashboards,
 }

windows-observ-lib/dashboards.libsonnet

@@ -2,19 +2,17 @@ local g = import './g.libsonnet';
 local logslib = import 'github.com/grafana/jsonnet-libs/logs-lib/logs/main.libsonnet';
 {
   local root = self,
-  new(
-    this
-  ):
+  new(this):
     local prefix = this.config.dashboardNamePrefix;
-    local links = this.links;
+    local links = this.grafana.links;
     local tags = this.config.dashboardTags;
     local uid = g.util.string.slugify(this.config.uid);
-    local vars = this.variables;
-    local annotations = this.annotations;
+    local vars = this.grafana.variables;
+    local annotations = this.grafana.annotations;
     local refresh = this.config.dashboardRefresh;
     local period = this.config.dashboardPeriod;
     local timezone = this.config.dashboardTimezone;
-    local panels = this.panels;
+    local panels = this.grafana.panels;
     local stat = g.panel.stat;
     {
       fleet:
@@ -110,16 +108,17 @@ local logslib = import 'github.com/grafana/jsonnet-libs/logs-lib/logs/main.libso
     then
       {
         logs:
-
-          logslib.new(prefix + 'Windows logs',
-                      datasourceName=this.variables.datasources.loki.name,
-                      datasourceRegex=this.variables.datasources.loki.regex,
-                      filterSelector=this.config.filteringSelector,
-                      labels=this.config.groupLabels + this.config.instanceLabels + this.config.extraLogLabels,
-                      formatParser='json',
-                      showLogsVolume=this.config.showLogsVolume,
-                      logsVolumeGroupBy=this.config.logsVolumeGroupBy,
-                      extraFilters=this.config.logsExtraFilters)
+          logslib.new(
+            prefix + 'Windows logs',
+            datasourceName=this.grafana.variables.datasources.loki.name,
+            datasourceRegex=this.grafana.variables.datasources.loki.regex,
+            filterSelector=this.config.filteringSelector,
+            labels=this.config.groupLabels + this.config.instanceLabels + this.config.extraLogLabels,
+            formatParser='json',
+            showLogsVolume=this.config.showLogsVolume,
+            logsVolumeGroupBy=this.config.logsVolumeGroupBy,
+            extraFilters=this.config.logsExtraFilters
+          )
           {
             dashboards+:
               {
@@ -138,7 +137,7 @@ local logslib = import 'github.com/grafana/jsonnet-libs/logs-lib/logs/main.libso
             variables+: {
               // add prometheus datasource for annotations processing
               toArray+: [
-                this.variables.datasources.prometheus { hide: 2 },
+                this.grafana.variables.datasources.prometheus { hide: 2 },
               ],
             },
           }.dashboards.logs,

windows-observ-lib/main.libsonnet

@@ -8,41 +8,40 @@ local variables = import './variables.libsonnet';
 local commonlib = import 'github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet';
 
 {
-
-  // any modular library should inlcude as inputs:
-  // 'dashboardNamePrefix' - Use as prefix for all Dashboards and (optional) rule groups
-  // 'filteringSelector' - Static selector to apply to ALL dashboard variables of type query, panel queries, alerts and recording rules.
-  // 'groupLabels' - one or more labels that can be used to identify 'group' of instances. In simple cases, can be 'job' or 'cluster'.
-  // 'instanceLabels' - one or more labels that can be used to identify single entity of instances. In simple cases, can be 'instance' or 'pod'.
-  // 'uid' - UID to prefix all dashboards original uids
-
   new(
     filteringSelector,
     groupLabels=['job'],
     instanceLabels=['instance'],
     dashboardNamePrefix='',
     dashboardTags=[uid],
     uid,
-
   ): {
 
     local this = self,
     config: {
-      ignoreVolumes: 'HarddiskVolume.*',
+      // any modular library should inlcude as inputs:
+      // 'dashboardNamePrefix' - Use as prefix for all Dashboards and (optional) rule groups
+      // 'filteringSelector' - Static selector to apply to ALL dashboard variables of type query, panel queries, alerts and recording rules.
+      // 'groupLabels' - one or more labels that can be used to identify 'group' of instances. In simple cases, can be 'job' or 'cluster'.
+      // 'instanceLabels' - one or more labels that can be used to identify single entity of instances. In simple cases, can be 'instance' or 'pod'.
+      // 'uid' - UID to prefix all dashboards original uids
       groupLabels: groupLabels,
       instanceLabels: instanceLabels,
       filteringSelector: filteringSelector,
       dashboardTags: dashboardTags,
       uid: uid,
       dashboardNamePrefix: dashboardNamePrefix,
 
+      // optional
+      ignoreVolumes: 'HarddiskVolume.*',
       alertsCPUThresholdWarning: '90',
       alertMemoryUsageThresholdCritical: '90',
       alertDiskUsageThresholdCritical: '90',
       dashboardPeriod: 'now-1h',
       dashboardTimezone: 'default',
       dashboardRefresh: '1m',
 
+      // logs lib related
       enableLokiLogs: true,
       extraLogLabels: ['channel', 'source', 'keywords', 'level'],
       logsVolumeGroupBy: 'level',
@@ -54,67 +53,63 @@ local commonlib = import 'github.com/grafana/jsonnet-libs/common-lib/common/main
           | line_format `{{ if eq "[[instance]]" ".*" }}{{ alignLeft 25 .instance}}|{{end}}{{alignLeft 12 .channel }}| {{ alignLeft 25 .source}}| {{ .message }}`
         |||,
     },
-
-    variables: variables.new(this),
-
-    targets: targets.new(this),
-
-    annotations:
-      {
-        reboot: commonlib.annotations.reboot.new(
-                  title='Reboot',
-                  target=this.targets.reboot,
-                  instanceLabels=std.join(',', instanceLabels),
-                )
-                + commonlib.annotations.base.withTagKeys(std.join(',', groupLabels + instanceLabels)),
-      }
-      +
-      if
-        this.config.enableLokiLogs
-      then
+    grafana: {
+      variables: variables.new(this),
+      targets: targets.new(this),
+      annotations:
         {
-          serviceFailed: commonlib.annotations.serviceFailed.new(
-                           title='Service failed',
-                           target=this.targets.serviceFailed,
-                         )
-                         + commonlib.annotations.base.withTagKeys(std.join(',', groupLabels + instanceLabels + ['level']))
-                         + commonlib.annotations.base.withTextFormat('{{message}}'),
-          criticalEvents: commonlib.annotations.fatal.new(
-                            title='Critical system event',
-                            target=this.targets.criticalEvents,
-                          )
-                          + commonlib.annotations.base.withTagKeys(std.join(',', groupLabels + instanceLabels + ['level']))
-                          + commonlib.annotations.base.withTextFormat('{{message}}'),
+          reboot: commonlib.annotations.reboot.new(
+                    title='Reboot',
+                    target=this.grafana.targets.reboot,
+                    instanceLabels=std.join(',', instanceLabels),
+                  )
+                  + commonlib.annotations.base.withTagKeys(std.join(',', this.config.groupLabels + this.config.instanceLabels)),
         }
-      else
-        {},
+        +
+        if
+          this.config.enableLokiLogs
+        then
+          {
+            serviceFailed: commonlib.annotations.serviceFailed.new(
+                             title='Service failed',
+                             target=this.grafana.targets.serviceFailed,
+                           )
+                           + commonlib.annotations.base.withTagKeys(std.join(',', this.config.groupLabels + this.config.instanceLabels + ['level']))
+                           + commonlib.annotations.base.withTextFormat('{{message}}'),
+            criticalEvents: commonlib.annotations.fatal.new(
+                              title='Critical system event',
+                              target=this.grafana.targets.criticalEvents,
+                            )
+                            + commonlib.annotations.base.withTagKeys(std.join(',', this.config.groupLabels + this.config.instanceLabels + ['level']))
+                            + commonlib.annotations.base.withTextFormat('{{message}}'),
+          }
+        else
+          {},
+      // common links here
+      links: {
+        local link = g.dashboard.link,
+        backToFleet:
+          link.link.new('Back to Windows fleet', '/d/' + this.grafana.dashboards.fleet.uid)
+          + link.link.options.withKeepTime(true),
+        backToOverview:
+          link.link.new('Back to Windows overview', '/d/' + this.grafana.dashboards.overview.uid)
+          + link.link.options.withKeepTime(true),
+        otherDashboards:
+          link.dashboards.new('All Windows dashboards', this.config.dashboardTags)
+          + link.dashboards.options.withIncludeVars(true)
+          + link.dashboards.options.withKeepTime(true)
+          + link.dashboards.options.withAsDropdown(true),
+      },
 
-    // common links here
-    links: {
-      local link = g.dashboard.link,
-      backToFleet:
-        link.link.new('Back to Windows fleet', '/d/' + this.dashboards.fleet.uid)
-        + link.link.options.withKeepTime(true),
-      backToOverview:
-        link.link.new('Back to Windows overview', '/d/' + this.dashboards.overview.uid)
-        + link.link.options.withKeepTime(true),
-      otherDashboards:
-        link.dashboards.new('All Windows dashboards', dashboardTags)
-        + link.dashboards.options.withIncludeVars(true)
-        + link.dashboards.options.withKeepTime(true)
-        + link.dashboards.options.withAsDropdown(true),
+      panels: panels.new(this),
+      dashboards: dashboards.new(this),
     },
 
-    panels: panels.new(
-      this
-    ),
-
-    dashboards: dashboards.new(
-      this
-    ),
+    prometheus: {
+      alerts: alerts.new(this),
+      recordingRules: {},
+    },
 
-    alerts: alerts.new(this),
-    recordingRules: {},
   },
 
 }

windows-observ-lib/panels.libsonnet

@@ -4,7 +4,7 @@ local utils = commonlib.utils;
 {
   new(this):
     {
-      local t = this.targets,
+      local t = this.grafana.targets,
       local table = g.panel.table,
       local fieldOverride = g.panel.table.fieldOverride,
       local instanceLabel = this.config.instanceLabels[0],
@@ -66,7 +66,7 @@ local utils = commonlib.utils;
             {
               targetBlank: false,
               title: 'Drill down to ${__field.name} ${__value.text}',
-              url: 'd/%s?var-%s=${__data.fields.%s}&${__url_time_range}' % [this.dashboards.overview.uid, instanceLabel, instanceLabel],
+              url: 'd/%s?var-%s=${__data.fields.%s}&${__url_time_range}' % [this.grafana.dashboards.overview.uid, instanceLabel, instanceLabel],
             },
           ]),
           fieldOverride.byRegexp.new(std.join('|', std.map(utils.toSentenceCase, this.config.groupLabels)))
@@ -75,7 +75,7 @@ local utils = commonlib.utils;
             {
               targetBlank: false,
               title: 'Filter by ${__field.name}',
-              url: 'd/%s?var-${__field.name}=${__value.text}&${__url_time_range}' % [this.dashboards.fleet.uid],
+              url: 'd/%s?var-${__field.name}=${__value.text}&${__url_time_range}' % [this.grafana.dashboards.fleet.uid],
             },
           ]),
           fieldOverride.byName.new('CPU count')
@@ -221,7 +221,7 @@ local utils = commonlib.utils;
         target=t.cpuUsage,
         topk=25,
         instanceLabels=this.config.instanceLabels,
-        drillDownDashboardUid=this.dashboards.overview.uid,
+        drillDownDashboardUid=this.grafana.dashboards.overview.uid,
       ),
       cpuUsageStat: commonlib.panels.cpu.stat.usage.new(targets=[t.cpuUsage]),
       cpuUsageByMode: commonlib.panels.cpu.timeSeries.utilizationByMode.new(
@@ -259,7 +259,7 @@ local utils = commonlib.utils;
         target=t.memoryUsagePercent,
         topk=25,
         instanceLabels=this.config.instanceLabels,
-        drillDownDashboardUid=this.dashboards.overview.uid,
+        drillDownDashboardUid=this.grafana.dashboards.overview.uid,
       ),
       memoryUsageTsBytes: commonlib.panels.memory.timeSeries.usageBytes.new(targets=[t.memoryUsedBytes, t.memoryTotalBytes]),
       diskTotalC:
@@ -288,7 +288,7 @@ local utils = commonlib.utils;
         target=t.diskUsagePercent,
         topk=25,
         instanceLabels=this.config.instanceLabels + ['volume'],
-        drillDownDashboardUid=this.dashboards.overview.uid,
+        drillDownDashboardUid=this.grafana.dashboards.overview.uid,
       ),
       diskIOBytesPerSec: commonlib.panels.disk.timeSeries.ioBytesPerSec.new(
         targets=[t.diskIOreadBytesPerSec, t.diskIOwriteBytesPerSec, t.diskIOutilization]
@@ -299,7 +299,7 @@ local utils = commonlib.utils;
           target=t.diskIOutilization,
           topk=25,
           instanceLabels=this.config.instanceLabels + ['volume'],
-          drillDownDashboardUid=this.dashboards.overview.uid,
+          drillDownDashboardUid=this.grafana.dashboards.overview.uid,
         ),
       diskIOps:
         commonlib.panels.disk.timeSeries.iops.new(

windows-observ-lib/targets.libsonnet

@@ -4,7 +4,7 @@ local lokiQuery = g.query.loki;
 
 {
   new(this): {
-    local variables = this.variables,
+    local variables = this.grafana.variables,
     local config = this.config,
     uptimeQuery:: 'windows_system_system_up_time',
 

windows-observ-lib/variables.libsonnet

@@ -41,10 +41,12 @@ local utils = commonlib.utils;
        datasources: {
          prometheus:
            var.datasource.new('datasource', 'prometheus')
-           + var.datasource.generalOptions.withLabel('Data source'),
+           + var.datasource.generalOptions.withLabel('Data source')
+           + var.datasource.withRegex(''),
          loki:
            var.datasource.new('loki_datasource', 'loki')
            + var.datasource.generalOptions.withLabel('Loki data source')
+           + var.datasource.withRegex('')
            + var.datasource.generalOptions.showOnDashboard.withNothing(),
        },
        // Use on dashboards where multiple entities can be selected, like fleet dashboards
@@ -64,7 +66,7 @@ local utils = commonlib.utils;
      }
      + if this.config.enableLokiLogs then self.withLokiLogs(this) else {},
   withLokiLogs(this): {
-    multiInstance+: [this.variables.datasources.loki],
-    singleInstance+: [this.variables.datasources.loki],
+    multiInstance+: [this.grafana.variables.datasources.loki],
+    singleInstance+: [this.grafana.variables.datasources.loki],
   },
 }