Add node-observ-lib

docs/node-observ-lib/README.md

@@ -0,0 +1,111 @@
+# Node exporter observ lib
+
+This jsonnet observ lib can be used to generate observ package for node exporter.
+
+## 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 nodelib = import 'node-observ-lib/main.libsonnet';
+
+local linux =
+  nodelib.new()
+  + nodelib.withConfigMixin({
+    filteringSelector: 'job=~".*node.*"',
+    groupLabels: ['job'],
+    instanceLabels: ['instance'],
+    dashboardNamePrefix: 'Node exporter / ',
+    dashboardTags: ['node-exporter-mixin'],
+    uid: 'node',
+  })
+  + nodelib.withConfigMixin(
+    {
+      // enable loki logs
+      enableLokiLogs: true,
+    }
+  );
+
+{
+  grafanaDashboards+:: linux.grafana.dashboards,
+  prometheusAlerts+:: linux.prometheus.alerts,
+  prometheusRules+:: linux.prometheus.recordingRules,
+}
+
+```
+
+### Example 2: Modify specific panel before rendering dashboards
+
+```jsonnet
+local g = import './g.libsonnet';
+// mixin.libsonnet file
+local nodelib = import 'node-observ-lib/main.libsonnet';
+
+local linux =
+  nodelib.new()
+  + nodelib.withConfigMixin({
+    filteringSelector: 'job=~".*node.*"',
+    groupLabels: ['job'],
+    instanceLabels: ['instance'],
+    dashboardNamePrefix: 'Node exporter / ',
+    dashboardTags: ['node-exporter-mixin'],
+    uid: 'node',
+  })
+  + {
+      grafana+: {
+        panels+: {
+          networkSockstatAll+:
+            + g.panel.timeSeries.fieldConfig.defaults.custom.withDrawStyle('bars')
+        }
+      }
+    };
+
+{
+  grafanaDashboards+:: linux.grafana.dashboards,
+  prometheusAlerts+:: linux.prometheus.alerts,
+  prometheusRules+:: linux.prometheus.recordingRules,
+}
+
+```
+
+## 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_journal_scrape
+      journal:
+        max_age: 24h
+        labels:
+          instance: '<your-instance-name>'
+          job: integrations/node_exporter
+      relabel_configs:
+      - source_labels: ['__journal__systemd_unit']
+        target_label: 'unit'
+      - source_labels: ['__journal__boot_id']
+        target_label: 'boot_id'
+      - source_labels: ['__journal__transport']
+        target_label: 'transport'
+      - source_labels: ['__journal_priority_keyword']
+        target_label: 'level'
+```