feat(textfile_collectors): added IPMI textfile collector

pillar.example

@@ -168,4 +168,8 @@ prometheus:
 
   exporters:
     node_exporter:
-      textfile_collectors: {}
+      textfile_collectors:
+        ipmitool:
+          # You must enable individual collectors
+          enable: true
+          # pkg: ipmitool

prometheus/config/node_exporter/textfile_collectors/files/ipmitool

@@ -0,0 +1,91 @@
+#!/usr/bin/awk -f
+
+# Source: https://github.com/prometheus/node_exporter/blob/master/text_collector_examples/ipmitool
+
+#
+# Converts output of `ipmitool sensor` to prometheus format.
+#
+# With GNU awk:
+#   ipmitool sensor | ./ipmitool > ipmitool.prom
+#
+# With BSD awk:
+#   ipmitool sensor | awk -f ./ipmitool > ipmitool.prom
+#
+
+function export(values, name) {
+	if (values["metric_count"] < 1) {
+		return
+	}
+	delete values["metric_count"]
+
+	printf("# HELP %s%s %s sensor reading from ipmitool\n", namespace, name, help[name]);
+	printf("# TYPE %s%s gauge\n", namespace, name);
+	for (sensor in values) {
+		printf("%s%s{sensor=\"%s\"} %f\n", namespace, name, sensor, values[sensor]);
+	}
+}
+
+# Fields are Bar separated, with space padding.
+BEGIN {
+	FS = "[ ]*[|][ ]*";
+	namespace = "node_ipmi_";
+
+	# Friendly description of the type of sensor for HELP.
+	help["temperature_celsius"] = "Temperature";
+	help["volts"] = "Voltage";
+	help["power_watts"] = "Power";
+	help["speed_rpm"] = "Fan";
+	help["status"] = "Chassis status";
+
+	temperature_celsius["metric_count"] = 0;
+	volts["metric_count"] = 0;
+	power_watts["metric_count"] = 0;
+	speed_rpm["metric_count"] = 0;
+	status["metric_count"] = 0;
+}
+
+# Not a valid line.
+{
+	if (NF < 3) {
+		next
+	}
+}
+
+# $2 is value field.
+$2 ~ /na/ {
+	next
+}
+
+# $3 is type field.
+$3 ~ /degrees C/ {
+	temperature_celsius[$1] = $2;
+	temperature_celsius["metric_count"]++;
+}
+
+$3 ~ /Volts/ {
+	volts[$1] = $2;
+	volts["metric_count"]++;
+}
+
+$3 ~ /Watts/ {
+	power_watts[$1] = $2;
+	power_watts["metric_count"]++;
+}
+
+$3 ~ /RPM/ {
+	speed_rpm[$1] = $2;
+	speed_rpm["metric_count"]++;
+}
+
+$3 ~ /discrete/ {
+	status[$1] = $2;
+	status["metric_count"]++;
+}
+
+END {
+	export(temperature_celsius, "temperature_celsius");
+	export(volts, "volts");
+	export(power_watts, "power_watts");
+	export(speed_rpm, "speed_rpm");
+	export(status, "status");
+}

prometheus/config/node_exporter/textfile_collectors/ipmitool/clean.sls

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# vim: ft=sls
+
+{#- Get the `tplroot` from `tpldir` #}
+{%- set tplroot = tpldir.split('/')[0] %}
+{%- from tplroot ~ "/map.jinja" import prometheus with context %}
+
+{%- set config = prometheus.exporters.node_exporter.textfile_collectors.ipmitool %}
+{%- set dir = prometheus.service.node_exporter.args.get('collector.textfile.directory') %}
+{%- set script = prometheus.dir.textfile_collectors ~ '/ipmitool' %}
+
+prometheus-exporters-node-textfile_collectors-ipmitool-pkg:
+  pkg.removed:
+    - name: {{ config.pkg }}
+
+prometheus-exporters-node-textfile_collectors-ipmitool-script:
+  file.absent:
+    - name: {{ script }}
+
+prometheus-exporters-node-textfile_collectors-ipmitool-output:
+  file.absent:
+    - name: {{ dir }}/ipmitool.prom
+
+prometheus-exporters-node-textfile_collectors-ipmitool-cronjob:
+  cron.absent:
+    - identifier: prometheus-exporters-node-textfile_collectors-ipmitool-cronjob

prometheus/config/node_exporter/textfile_collectors/ipmitool/init.sls

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# vim: ft=sls
+
+{#- Get the `tplroot` from `tpldir` #}
+{%- set tplroot = tpldir.split('/')[0] %}
+{%- from tplroot ~ "/map.jinja" import prometheus with context %}
+
+{%- set config = prometheus.exporters.node_exporter.textfile_collectors.ipmitool %}
+{%- set dir = prometheus.service.node_exporter.args.get('collector.textfile.directory') %}
+{%- set script = prometheus.dir.textfile_collectors ~ '/ipmitool' %}
+{%- set cmd_prefix = 'awk -f ' if grains.os_family in ['FreeBSD'] else '' %}
+
+prometheus-exporters-node-textfile_collectors-ipmitool-pkg:
+  pkg.installed:
+    - name: {{ config.pkg }}
+
+prometheus-exporters-node-textfile_collectors-ipmitool-script:
+  file.managed:
+    - name: {{ script }}
+    - source: salt://prometheus/config/node_exporter/textfile_collectors/files/ipmitool
+    - mode: 755
+    - require:
+      - file: prometheus-node_exporter-textfile_collectors-dir
+
+prometheus-exporters-node-textfile_collectors-ipmitool-cronjob:
+  cron.present:
+    - identifier: prometheus-exporters-node-textfile_collectors-ipmitool-cronjob
+    - name: cd {{ dir }} && LANG=C ipmitool sensor | {{ cmd_prefix }}{{ script }} > .ipmitool.prom$$; mv .ipmitool.prom$$ ipmitool.prom
+    - minute: "{{ config.get('minute', '*') }}"
+    - comment: Prometheus' node_exporter's ipmitool textfile collector
+    - require:
+      - file: prometheus-exporters-node-textfile_collectors-ipmitool-script

prometheus/defaults.yaml

@@ -122,4 +122,8 @@ prometheus:
   exporters:
     node_exporter:
       textfile_collectors_dependencies: []
-      textfile_collectors: {}
+      textfile_collectors:
+        ipmitool:
+          enable: false
+          remove: false
+          pkg: ipmitool

test/integration/default/controls/config_spec.rb

@@ -11,4 +11,10 @@ control 'Prometheus configuration' do
     its('content') { should include 'global:' }
     its('content') { should include 'alerting:' }
   end
+
+  describe file('/opt/prometheus/textfile_collectors/ipmitool') do
+    it { should be_file }
+    it { should be_owned_by 'root' }
+    its('mode') { should cmp '0755' }
+  end
 end