Refactor mixin dashboards (#885)

This is a complete refactor of the dashboard system. It brings the dashboard creation, metrics, alerting, etc into alignment with other projects that use jsonnet/grafonnet/mixins. This should allow users to customize what we have created and deploy into their environments. The dashboard was the focus of this iteration, reaching parity with the previous dashboard.

- Add in jsonnet and grafonnet
- Add scripts to compile and lint mixin
- Add CI for the mixin

---------

Signed-off-by: Joe Adams <[email protected]>

.github/workflows/mixin.yml

@@ -0,0 +1,34 @@
+---
+name: mixin
+on:
+  pull_request:
+    paths:
+      - "elasticsearch-mixin/**"
+
+jobs:
+  check-mixin:
+      name: check
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+        - name: Setup Go
+          uses: actions/setup-go@v5
+          with:
+            go-version: 1.22.5
+        - name: Install dependencies
+          run: |
+            go install github.com/google/go-jsonnet/cmd/[email protected]
+            go install github.com/google/go-jsonnet/cmd/[email protected]
+            go install github.com/google/go-jsonnet/cmd/[email protected]
+            go install github.com/monitoring-mixins/mixtool/cmd/mixtool@16dc166166d91e93475b86b9355a4faed2400c18
+            go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/[email protected]
+        - name: Lint
+          run: bash ./scripts/lint-jsonnet.sh
+        - name: Compile mixin
+          run: bash ./scripts/compile-mixin.sh
+        - name: Verify compiled mixin matches repo
+          run: |
+            git diff --exit-code -- ./elasticsearch-mixin || (echo "Compiled mixin does not match repo" && exit 1)
+            # Check if there are any new untracked files
+            test -z "$(git status --porcelain)" || (echo "Untracked files found, please run ./scripts/compile-mixin.sh" && exit 1)

.gitignore

@@ -4,3 +4,4 @@ elasticsearch_exporter
 *-stamp
 .tarballs
 /vendor
+vendor/

elasticsearch-mixin/README.md

@@ -0,0 +1,29 @@
+# Elasticsearch Exporter Mixin
+
+This is a mixin for the elasticsearch_exporter to define dashboards, alerts, and monitoring queries for use with this exporter.
+
+Good example of upstream mixin for reference: https://github.com/kubernetes-monitoring/kubernetes-mixin
+
+## Development
+
+### JSONNET
+https://jsonnet.org/
+
+```go install github.com/google/go-jsonnet/cmd/jsonnet@latest```
+
+### JSONNET BUNDLER
+jsonnet bundler is a package manager for jsonnet
+
+https://github.com/jsonnet-bundler/jsonnet-bundler
+
+```go install -a github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest```
+
+### Grafonnet
+Grafana libraries for jsonnet: https://grafana.github.io/grafonnet/
+
+```jb install github.com/grafana/grafonnet/gen/grafonnet-latest@main```
+
+### Run the build
+```bash
+./scripts/compile-mixin.sh
+```

elasticsearch-mixin/compiled/alerts.yaml

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