Skip to content
Merged
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
Empty file removed docs/examples/prometheus/.ci-skip
Empty file.
13 changes: 0 additions & 13 deletions docs/examples/prometheus/README.md

This file was deleted.

27 changes: 27 additions & 0 deletions observability/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Observability

This directory contains scrape targets, RabbitMQ alerting rules, Alertmanager configuration, and RabbitMQ dashboards published in a format that is compatible with [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator).

If you don't have Prometheus and Grafana installed, the quickest way to try out RabbitMQ observability is as follows:

Make sure
1. `kubectl` (version 1.18+) pointing to any running Kubernetes cluster
1. `helm` (version 3+) being installed

Optionally, if you want to receive Slack notifications for RabbitMQ alerts, you will need a Slack Webhook URL (see [here](https://api.slack.com/messaging/webhooks) how to create one).

```bash
# Optionally, to receive Slack notifications on RabbitMQ alerts, set the name of the Slack channel and the Slack Webhook URL:
export SLACK_CHANNEL='#my-channel'
export SLACK_API_URL='https://hooks.slack.com/services/paste/your/token'

./quickstart.sh
```

This will install Prometheus Operator, Prometheus, kube-state-metrics, Alertmanager, Grafana and will set up RabbitMQ scrape targets, RabbitMQ alerting rules, Slack notifications, and RabbitMQ Grafana dashboards.
Note that the [quickstart.sh](./quickstart.sh) script is not a production-ready setup. Refer to the official Prometheus and Grafana documentation on how to deploy a production-ready monitoring stack.

Learn more on RabbitMQ monitoring in:
* [RabbitMQ Prometheus documentation](https://www.rabbitmq.com/prometheus.html)
* [Operator monitoring documentation](https://www.rabbitmq.com/kubernetes/operator/operator-monitoring.html)
* [TGIR S01E07: How to monitor RabbitMQ?](https://youtu.be/NWISW6AwpOE)
10 changes: 10 additions & 0 deletions observability/grafana/dashboards/erlang-distribution.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
apiVersion: v1
kind: ConfigMap
metadata:
name: erlang-distribution-dashboard
labels:
grafana_dashboard: "true"
data:
# https://grafana.com/grafana/dashboards/11352
erlang-distribution-dashboard.json.url: https://grafana.com/api/dashboards/11352/revisions/7/download
10 changes: 10 additions & 0 deletions observability/grafana/dashboards/erlang-distributions-compare.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
apiVersion: v1
kind: ConfigMap
metadata:
name: erlang-distributions-compare-dashboard
labels:
grafana_dashboard: "true"
data:
# https://grafana.com/grafana/dashboards/10988
erlang-distributions-compare-dashboard.json.url: https://grafana.com/api/dashboards/10988/revisions/11/download
10 changes: 10 additions & 0 deletions observability/grafana/dashboards/erlang-memory-allocators.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
apiVersion: v1
kind: ConfigMap
metadata:
name: erlang-memory-allocators-dashboard
labels:
grafana_dashboard: "true"
data:
# https://grafana.com/grafana/dashboards/11350
erlang-memory-allocators-dashboard.json.url: https://grafana.com/api/dashboards/11350/revisions/5/download
Loading