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

Use monitoring-mixins for dashboards and alerts #48

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

janhorstmann
Copy link
Contributor

Monitoring-mixins ([1]) allow upstream collaboration on alerts and grafana dashboards and convergence on monitoring best practices through bundling mixins with the corresponding software.
Downstream customization of alerts and dashboards may be done using jsonnet ([2]).
Usage of jsonnet-bundler ([3]) gives a clear reference of where dashboards and alerts originated and which version is used through .src/jsonnetfile.json and .src/jsonnetfile.lock.json.

[1]
https://monitoring.mixins.dev/

[2]
https://github.com/google/jsonnet

[3]
https://github.com/jsonnet-bundler/jsonnet-bundler

@janhorstmann janhorstmann requested a review from berendt October 17, 2024 07:10
@janhorstmann janhorstmann marked this pull request as draft October 17, 2024 07:12
@janhorstmann
Copy link
Contributor Author

If we want to use this, then I would like to also add a check to make sure that checked in alerts and dashboards are in sync.
Maybe some of the exisitng dashboards/alerts are redundent now and should be deleted.
Still needs testing

@janhorstmann janhorstmann force-pushed the feature/monitoring-mixins branch from fec59fd to d9ac2d0 Compare October 17, 2024 15:02
@janhorstmann janhorstmann force-pushed the feature/monitoring-mixins branch 21 times, most recently from 6117d5a to 299b20e Compare November 8, 2024 12:00
@janhorstmann
Copy link
Contributor Author

Waiting on

prometheus/prometheus#15334
prometheus/node_exporter#3147

in order not to regress on the angular deprecation of grafana

@janhorstmann janhorstmann force-pushed the feature/monitoring-mixins branch from 299b20e to b279b89 Compare December 7, 2024 09:32
@janhorstmann janhorstmann marked this pull request as ready for review December 7, 2024 09:34
@janhorstmann janhorstmann force-pushed the feature/monitoring-mixins branch from b279b89 to c0a70b1 Compare December 7, 2024 11:31
Monitoring-mixins ([1]) allow upstream collaboration on alerts and
grafana dashboards and convergence on monitoring best practices through
bundling mixins with the corresponding software.
Downstream customization of alerts and dashboards may be done using
jsonnet ([2]).
Usage of jsonnet-bundler ([3]) gives a clear reference of where
dashboards and alerts originated and which version is used through
`.src/jsonnetfile.json` and `.src/jsonnetfile.lock.json`.

[1]
https://monitoring.mixins.dev/

[2]
https://github.com/google/jsonnet

[3]
https://github.com/jsonnet-bundler/jsonnet-bundler

Signed-off-by: Jan Horstmann <[email protected]>
With the proposed workflow mixin output is generated offline and
checked into version control for direct usage.
A test is added to check whether the generated rules and dashboards
match the checked-in version.
Additionally a check for the script generating the mixins is added.

Signed-off-by: Jan Horstmann <[email protected]>
With the alerts of the added node-exporter mixin some alerts became
redundant and are removed.

Signed-off-by: Jan Horstmann <[email protected]>
With the alerts of the added prometheus-exporter mixin some alerts
became redundant and are removed.

Signed-off-by: Jan Horstmann <[email protected]>
@janhorstmann janhorstmann force-pushed the feature/monitoring-mixins branch from c0a70b1 to 574ca26 Compare December 19, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant