Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor mixin dashboards #885

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/mixin.yml
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ elasticsearch_exporter
*-stamp
.tarballs
/vendor
vendor/
29 changes: 29 additions & 0 deletions elasticsearch-mixin/README.md
Original file line number Diff line number Diff line change
@@ -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
```
1 change: 1 addition & 0 deletions elasticsearch-mixin/compiled/alerts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
Loading
Loading