Skeleton code for mixin

Signed-off-by: Umanga Chapagain <[email protected]>

Author: umangachapagain

Makefile

@@ -0,0 +1,33 @@
+JSONNET_FMT := jsonnet fmt -n 2 --max-blank-lines 2 --string-style s --comment-style s
+
+all: fmt prometheus_alerts.yaml prometheus_rules.yaml dashboards_out lint test
+
+fmt:
+	find . -name 'vendor' -prune -o -name '*.libsonnet' -print -o -name '*.jsonnet' -print | \
+		xargs -n 1 -- $(JSONNET_FMT) -i
+
+prometheus_alerts.yaml: mixin.libsonnet lib/alerts.jsonnet alerts/*.libsonnet
+	jsonnet -S lib/alerts.jsonnet > $@
+
+prometheus_rules.yaml: mixin.libsonnet lib/rules.jsonnet rules/*.libsonnet
+	jsonnet -S lib/rules.jsonnet > $@
+
+dashboards_out: mixin.libsonnet lib/dashboards.jsonnet dashboards/*.libsonnet
+	@mkdir -p dashboards_out
+	jsonnet -J vendor -m dashboards_out lib/dashboards.jsonnet
+
+lint: prometheus_alerts.yaml prometheus_rules.yaml
+	find . -name 'vendor' -prune -o -name '*.libsonnet' -print -o -name '*.jsonnet' -print | \
+		while read f; do \
+			$(JSONNET_FMT) "$$f" | diff -u "$$f" -; \
+		done
+
+	promtool check rules prometheus_rules.yaml
+	promtool check rules prometheus_alerts.yaml
+
+clean:
+	rm -rf dashboards_out prometheus_alerts.yaml prometheus_rules.yaml
+
+test: prometheus_alerts.yaml prometheus_rules.yaml
+	promtool test rules tests.yaml
+

README.md

@@ -1 +1,20 @@
-# gluster-mixins
+# Prometheus Monitoring Mixin for Gluster
+
+A set of Grafana dashboards and Prometheus alerts for Gluster.
+
+The scope of this project is to provide Gluster specific Grafana dashboard configs and Prometheus rule files using Prometheus Mixins. 
+
+## Prerequisites
+1. Jsonnet ([How to Install Jsonnet?](https://github.com/google/jsonnet#building-jsonnet))
+
+## How to use?
+1. `$ git clone https://github.com/gluster/gluster-mixins.git`
+2. `$ cd gluster-mixins`
+3. `$ make prometheus_alerts.yaml`
+4. `$ make prometheus_rules.yaml`
+5. `$ make dashboards_out`
+
+The `prometheus_alerts.yaml` and `prometheus_rules.yaml` files then needs to be passed to your Prometheus Server, and the files in `dashboards_out` needs to be passed to your Grafana server.
+
+## Background
+* [Prometheus Monitoring Mixin design doc](https://docs.google.com/document/d/1A9xvzwqnFVSOZ5fD3blKODXfsat5fg6ZhnKu9LK3lB4/edit#)

alerts/alerts.libsonnet

@@ -0,0 +1,5 @@
+{
+  prometheusAlerts+:: {
+  },
+}
+

config.libsonnet

@@ -0,0 +1,4 @@
+{
+  _config+:: {
+  }
+}

dashboards/dashboards.libsonnet

@@ -0,0 +1,4 @@
+{
+  grafanaDashboards+:: {
+  }
+}

jsonnetfile.json

@@ -0,0 +1 @@
+{}

lib/alerts.jsonnet

@@ -0,0 +1 @@
+std.manifestYamlDoc((import '../mixin.libsonnet').prometheusAlerts)

lib/dashboards.jsonnet

@@ -0,0 +1,6 @@
+local dashboards = (import '../mixin.libsonnet').grafanaDashboards;
+
+{
+  [name]: dashboards[name]
+  for name in std.objectFields(dashboards)
+}

lib/rules.jsonnet

@@ -0,0 +1 @@
+std.manifestYamlDoc((import '../mixin.libsonnet').prometheusRules)

mixin.libsonnet

@@ -0,0 +1,4 @@
+(import 'config.libsonnet') +
+(import 'alerts/alerts.libsonnet') +
+(import 'dashboards/dashboards.libsonnet') +
+(import 'rules/rules.libsonnet')

rules/rules.libsonnet

@@ -0,0 +1,4 @@
+{
+  prometheusRules+:: {
+  }
+}