Add Macos observability lib

docs/node-observ-lib/vendor/github.com/jsonnet-libs/xtd/.gitignore → docs/node-observ-lib/.gitignore

@@ -1,3 +1,2 @@
-.jekyll-cache
 jsonnetfile.lock.json
 vendor

docs/node-observ-lib/jsonnetfile.json

@@ -4,20 +4,20 @@
     {
       "source": {
         "git": {
-          "remote": "https://github.com/grafana/jsonnet-libs.git",
-          "subdir": "common-lib"
+          "remote": "https://github.com/grafana/grafonnet.git",
+          "subdir": "gen/grafonnet-v10.0.0"
         }
       },
-      "version": "master"
+      "version": "main"
     },
     {
       "source": {
         "git": {
-          "remote": "https://github.com/grafana/grafonnet.git",
-          "subdir": "gen/grafonnet-v10.0.0"
+          "remote": "https://github.com/grafana/jsonnet-libs.git",
+          "subdir": "common-lib"
         }
       },
-      "version": "main"
+      "version": "master"
     },
     {
       "source": {

docs/node-observ-lib/README.md → docs/node-observ-lib/linux/README.md

@@ -17,7 +17,7 @@ You can use observ-lib to fill in monitoring-mixin structure:
 
 ```jsonnet
 // mixin.libsonnet file
-local nodelib = import 'node-observ-lib/main.libsonnet';
+local nodelib = import 'node-observ-lib/linux/main.libsonnet';
 
 local linux =
   nodelib.new()
@@ -45,7 +45,7 @@ local linux =
 
 ```jsonnet
 // mixin.libsonnet file
-local nodelib = import 'node-observ-lib/main.libsonnet';
+local nodelib = import 'node-observ-lib/linux/main.libsonnet';
 
 local linux =
   nodelib.new()
@@ -82,7 +82,7 @@ local linux =
 
 // mixin.libsonnet file
 local configOverride = import './overrides.libsonnet';
-local nodelib = import 'node-observ-lib/main.libsonnet';
+local nodelib = import 'node-observ-lib/linux/main.libsonnet';
 
 local linux =
   nodelib.new()
@@ -101,7 +101,7 @@ local linux =
 ```jsonnet
 local g = import './g.libsonnet';
 // mixin.libsonnet file
-local nodelib = import 'node-observ-lib/main.libsonnet';
+local nodelib = import 'node-observ-lib/linux/main.libsonnet';
 
 local linux =
   nodelib.new()

docs/node-observ-lib/alerts.libsonnet → docs/node-observ-lib/linux/alerts.libsonnet

@@ -2,7 +2,7 @@
   new(this): {
     groups: [
       {
-        name: if this.config.uid == 'node' then 'node-exporter-filesystem' else this.config.uid + '-linux-filesystem-alerts',
+        name: if this.config.uid == 'node' then 'node-exporter-filesystem' else this.config.uid + '-filesystem-alerts',
         rules: [
           {
             alert: 'NodeFilesystemSpaceFillingUp',
@@ -160,7 +160,7 @@
       },
       {
         // defaults to 'node-exporter for backward compatibility with old node-mixin
-        name: if this.config.uid == 'node' then 'node-exporter' else this.config.uid + '-linux-alerts',
+        name: if this.config.uid == 'node' then 'node-exporter' else this.config.uid + '-alerts',
         rules: [
           {
             alert: 'NodeNetworkReceiveErrs',

docs/node-observ-lib/annotations.libsonnet → docs/node-observ-lib/linux/annotations.libsonnet

@@ -1,4 +1,4 @@
-local g = import './g.libsonnet';
+local g = import '../g.libsonnet';
 local commonlib = import 'common-lib/common/main.libsonnet';
 {
   new(this):

docs/node-observ-lib/config.libsonnet → docs/node-observ-lib/linux/config.libsonnet

@@ -7,7 +7,7 @@
   // '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
 
-  filteringSelector: std.get(self, 'nodeExporterSelector', default='"job="node"'),
+  filteringSelector: std.get(self, 'nodeExporterSelector', default='job="node"'),
   groupLabels: ['job'],
   instanceLabels: ['instance'],
   dashboardNamePrefix: 'Node exporter / ',

docs/node-observ-lib/dashboards.libsonnet → docs/node-observ-lib/linux/dashboards.libsonnet

@@ -1,4 +1,4 @@
-local g = import './g.libsonnet';
+local g = import '../g.libsonnet';
 local logslib = import 'github.com/grafana/jsonnet-libs/logs-lib/logs/main.libsonnet';
 {
   local root = self,
@@ -59,7 +59,7 @@ local logslib = import 'github.com/grafana/jsonnet-libs/logs-lib/logs/main.libso
               panels.diskUsage { gridPos+: { w: 12, h: 8 } },
               g.panel.row.new('Network'),
               panels.networkUsagePerSec { gridPos+: { w: 12, h: 8 } },
-              panels.networkErrorsPerSec { gridPos+: { w: 12, h: 8 } },
+              panels.networkErrorsAndDroppedPerSec { gridPos+: { w: 12, h: 8 } },
             ], 6, 2
           )
         )

docs/node-observ-lib/links.libsonnet → docs/node-observ-lib/linux/links.libsonnet

@@ -1,4 +1,4 @@
-local g = import './g.libsonnet';
+local g = import '../g.libsonnet';
 local commonlib = import 'common-lib/common/main.libsonnet';
 {
   new(this):

docs/node-observ-lib/panels.libsonnet → docs/node-observ-lib/linux/panels.libsonnet

@@ -1,4 +1,4 @@
-local g = import './g.libsonnet';
+local g = import '../g.libsonnet';
 local commonlib = import 'common-lib/common/main.libsonnet';
 local utils = commonlib.utils;
 {

docs/node-observ-lib/targets.libsonnet → docs/node-observ-lib/linux/targets.libsonnet

@@ -1,4 +1,4 @@
-local g = import './g.libsonnet';
+local g = import '../g.libsonnet';
 local prometheusQuery = g.query.prometheus;
 local lokiQuery = g.query.loki;
 

docs/node-observ-lib/variables.libsonnet → docs/node-observ-lib/linux/variables.libsonnet

@@ -1,5 +1,5 @@
 // variables.libsonnet
-local g = import './g.libsonnet';
+local g = import '../g.libsonnet';
 local var = g.dashboard.variable;
 local commonlib = import 'common-lib/common/main.libsonnet';
 local utils = commonlib.utils;

docs/node-observ-lib/macos/README.md

@@ -0,0 +1,86 @@
+# MacOS exporter observability lib
+
+This jsonnet observability lib can be used to generate observability package for node exporter(MacOS).
+
+## Import
+
+```sh
+jb init
+jb install https://github.com/grafana/node_exporter/docs/node-observ-lib
+```
+
+## Examples
+
+### Example 1: Basic example
+
+You can use observ-lib to fill in monitoring-mixin structure:
+
+```jsonnet
+// mixin.libsonnet file
+local macoslib = import 'node-observ-lib/macos/main.libsonnet';
+
+local mac =
+  macoslib.new()
+  + macoslib.withConfigMixin({
+    filteringSelector: 'job=~".*mac.*"',
+    groupLabels: ['job'],
+    instanceLabels: ['instance'],
+    dashboardNamePrefix: 'MacOS / ',
+    dashboardTags: ['macos-mixin'],
+    uid: 'darwin',
+    // enable loki logs
+    enableLokiLogs: true,
+  });
+
+{
+  grafanaDashboards+:: mac.grafana.dashboards,
+  prometheusAlerts+:: mac.prometheus.alerts,
+  prometheusRules+:: mac.prometheus.recordingRules,
+}
+
+```
+For more examples see [node-observ-lib/linux](../linux).
+
+## Collectors used:
+
+Grafana Agent or combination of node_exporter/promtail can be used in order to collect data required.
+
+### Logs collection
+
+Loki logs are used to populate logs dashboard and also for annotations.
+
+To use logs, you need to opt-in, with setting `enableLokiLogs: true` in config.
+
+See example above.
+
+The following scrape snippet can be used in grafana-agent/promtail:
+
+```yaml
+    - job_name: integrations/node_exporter_direct_scrape
+      static_configs:
+      - targets:
+        - localhost
+        labels:
+          __path__: /var/log/*.log
+          instance: '<your-instance-name>'
+          job: integrations/macos-node
+      pipeline_stages:
+      - multiline:
+          firstline: '^([\w]{3} )?[\w]{3} +[\d]+ [\d]+:[\d]+:[\d]+|[\w]{4}-[\w]{2}-[\w]{2} [\w]{2}:[\w]{2}:[\w]{2}(?:[+-][\w]{2})?'
+      - regex:
+          expression: '(?P<timestamp>([\w]{3} )?[\w]{3} +[\d]+ [\d]+:[\d]+:[\d]+|[\w]{4}-[\w]{2}-[\w]{2} [\w]{2}:[\w]{2}:[\w]{2}(?:[+-][\w]{2})?) (?P<hostname>\S+) (?P<sender>.+?)\[(?P<pid>\d+)\]:? (?P<message>(?s:.*))$'
+      - labels:
+          sender:
+          hostname:
+          pid:
+      - match:
+          selector: '{sender!="", pid!=""}'
+          stages:
+            - template:
+                source: message
+                template: '{{ .sender }}[{{ .pid }}]: {{ .message }}'
+            - labeldrop:
+                - pid
+            - output:
+                source: message
+```

docs/node-observ-lib/macos/alerts.libsonnet

@@ -0,0 +1,23 @@
+{
+  new(this, parentPrometheus):
+    {
+      groups:
+        //keep only alerts listed in alertsMacKeep
+        std.filter(
+          function(group) std.length(group.rules) > 0,
+          [
+            {
+              name: group.name,
+              rules: [
+                rule
+                for rule in group.rules
+                if std.length(std.find(rule.alert, this.config.alertsMacKeep)) > 0
+              ],
+            }
+            for group in parentPrometheus.alerts.groups
+          ],
+
+        ),
+
+    },
+}

docs/node-observ-lib/macos/config.libsonnet

@@ -0,0 +1,59 @@
+{
+
+  //  any modular observability 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
+
+  filteringSelector: 'job="integrations/macos-node"',
+  groupLabels: ['job'],
+  instanceLabels: ['instance'],
+  dashboardNamePrefix: 'MacOS / ',
+  uid: 'darwin',
+
+  dashboardTags: [self.uid],
+
+  // Select the fstype for filesystem-related queries. If left
+  // empty, all filesystems are selected. If you have unusual
+  // filesystem you don't want to include in dashboards and
+  // alerting, you can exclude them here, e.g. 'fstype!="tmpfs"'.
+  fsSelector: 'fstype!=""',
+
+  // Select the mountpoint for filesystem-related queries. If left
+  // empty, all mountpoints are selected. For example if you have a
+  // special purpose tmpfs instance that has a fixed size and will
+  // always be 100% full, but you still want alerts and dashboards for
+  // other tmpfs instances, you can exclude those by mountpoint prefix
+  // like so: 'mountpoint!~"/var/lib/foo.*"'.
+  fsMountpointSelector: 'mountpoint!=""',
+
+  // Select the device for disk-related queries. If left empty, all
+  // devices are selected. If you have unusual devices you don't
+  // want to include in dashboards and alerting, you can exclude
+  // them here, e.g. 'device!="tmpfs"'.
+  diskDeviceSelector: 'device!=""',
+  dashboardPeriod: 'now-1h',
+  dashboardTimezone: 'default',
+  dashboardRefresh: '1m',
+
+  // Alerts to keep from node-observ-lib:
+  alertsMacKeep: [
+    'NodeFilesystemAlmostOutOfSpace',
+    'NodeNetworkReceiveErrs',
+    'NodeNetworkTransmitErrs',
+    'NodeTextFileCollectorScrapeError',
+    'NodeFilesystemFilesFillingUp',
+    'NodeFilesystemAlmostOutOfFiles',
+  ],
+  // logs lib related
+  enableLokiLogs: true,
+  extraLogLabels: ['filename', 'sender'],
+  logsVolumeGroupBy: 'sender',
+  showLogsVolume: true,
+  logsFilteringSelector: self.filteringSelector,
+  logsExtraFilters: '',
+
+
+}