Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
v-zhuravlev committed Jan 14, 2022
1 parent 835bb6c commit a3ece3b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions nsq-mixin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
NSQ mixin is a set of configurable Grafana dashboards and alerts based on the metrics exported by the [NSQ statsd integration](https://nsq.io/components/nsqd.html#statsd--graphite-integration).
In order to use it, you would need https://github.com/prometheus/statsd_exporter or https://grafana.com/docs/grafana-cloud/agent/ with statsd integration enabled.

This NSQ mixin interesting features:
1) Set of two dashboards:
NSQ Topics - view metrics grouped by topics and channels
![screenshot-0](https://user-images.githubusercontent.com/14870891/149538092-fa71774e-697d-45d7-a1e2-6f795977872e.png)
NSQ Instances - view metrics grouped by nsqd instances
![screenshot-1](https://user-images.githubusercontent.com/14870891/149538111-bbbe2712-d3f6-47f0-8b1b-396061f46eb4.png)

2) Dashboard links to quickly jump from one dashboard(view) to another.
3) [Data links ](https://grafana.com/docs/grafana/latest/linking/data-links/#data-links) to contextually jump from instance view to topics view and vice versa
![image](https://user-images.githubusercontent.com/14870891/149532730-6fdebd8d-204e-4962-861d-9c78af437afb.png)
4) Alerts for topics and channels depth.

## statsd_exporter/grafana agent configuration

In the Grafana agent configuration file, the agent's statsd_exporter integration must be enabled and configured the following way:
Expand Down

0 comments on commit a3ece3b

Please sign in to comment.