Skip to content

Commit

Permalink
docs: add info about grafana dashboard
Browse files Browse the repository at this point in the history
  • Loading branch information
turtleDev committed Jul 29, 2024
1 parent 6337fb2 commit 3f27abf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion dashboards/prometheus.json → dashboards/raccoon.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"type": "prometheus",
"uid": "bdt4t6a61qn0ge"
},
"description": "uration from the time request is processed to the time events are published. This metric is calculated per event by following formula(PublishedTime - ProcessedTime)/CountEvents",
"description": "duration from the time request is processed to the time events are published. This metric is calculated per event by following formula(PublishedTime - ProcessedTime)/CountEvents",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
8 changes: 8 additions & 0 deletions docs/docs/guides/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,11 @@ Raccoon provides fine-grained metrics that denote latency. That gives clues as t
- [`event_processing_duration_milliseconds`](reference/metrics.md#event_processing_duration_milliseconds) This metrics denotes overall latency. You need to look at other latency metrics to find the root cause when this metric is high.
- [`server_processing_latency_milliseconds`](reference/metrics.md#server_processing_latency_milliseconds) Correlate this metric with `event_processing_duration_milliseconds` to infer whether the issue is with Raccoon itself, or something wrong with the network, or the way [sent_time](https://github.com/raystack/proton/blob/main/raystack/raccoon/v1beta1/raccoon.proto#L47) is generated.-
- [`worker_processing_duration_milliseconds`](reference/metrics.md#worker_processing_duration_milliseconds) High value of this metric indicates that the publisher is slow or can't keep up.


### Dashboard

There is a pre-built [grafana dashboard](https://github.com/raystack/raccoon/tree/dashboards/raccoon.json) available with support for Prometheus data source.

If you're running the statsd + telegraf setup, you can configure telegraf to push metrics to Prometheus.

0 comments on commit 3f27abf

Please sign in to comment.