Skip to content

Commit 27ab362

Browse files
Update documentation for RabbitMQ Prometheus family types (#20155)
* update documentation about RabbitMQ family types * Update rabbitmq/README.md Co-authored-by: Jen Gilbert <jen.gilbert@datadoghq.com> --------- Co-authored-by: Jen Gilbert <jen.gilbert@datadoghq.com>
1 parent 7623157 commit 27ab362

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

rabbitmq/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,14 @@ Configure the `prometheus_plugin` section in your instance configuration. When u
3838
url: http://<HOST>:15692
3939
```
4040
41-
This enables scraping of the [`/metrics` endpoint][20] on one RabbitMQ node. Datadog can also collect data from the [`/metrics/detailed` endpoint][22].
42-
43-
```yaml
41+
This enables scraping of the [`/metrics` endpoint][20] on one RabbitMQ node. Datadog can also collect data from the [`/metrics/detailed` endpoint][22]. The metrics collected will depend on which families are included.
42+
```yaml
4443
instances:
4544
- prometheus_plugin:
4645
url: http://<HOST>:15692
47-
unaggregated_endpoint: detailed?family=queue_coarse_metrics
46+
unaggregated_endpoint: detailed?family=queue_coarse_metrics&family=queue_consumer_count&family=channel_exchange_metrics&family=channel_queue_exchange_metrics&family=node_coarse_metrics
4847
```
49-
This enables scraping of the [`/metrics/detailed` endpoint][22] to collect queue coarse metrics.
48+
This configuration collects metrics for each queue, exchange, and node. See the [`/metrics/detailed` API documentation][22] for more information on the metrics provided by each family.
5049

5150
##### [RabbitMQ Management Plugin][4].
5251

@@ -169,7 +168,7 @@ See [service_checks.json][14] for a list of service checks provided by this inte
169168
The Prometheus Plugin exposes a different set of metrics from the Management Plugin.
170169
Here is what to be aware of as you migrate from the Management to the Prometheus Plugin.
171170

172-
- Look up your metrics in [this table][23]. If a metric's description contains an `[OpenMetricsV2]` tag, then it is available in the Prometheus Plugin. Metrics available only in the Management Plugin do not have any tags in their descriptions.
171+
- Look up your metrics in [this table][23]. If a metric's description contains an `[OpenMetrics]` tag, then it is available in the Prometheus Plugin. Metrics available only in the Management Plugin do not have any tags in their descriptions.
173172
- Any dashboards and monitors using Management Plugin metrics do not function. Switch to the dashboards and monitors marked as *OpenMetrics Version*.
174173
- The default configuration collects aggregated metrics. This means, for example, that there are no metrics tagged by queue. Configure the option `prometheus_plugin.unaggregated_endpoint` to get metrics without aggregation.
175174
- The `rabbitmq.status` service check is replaced by `rabbitmq.openmetrics.health`. The service check `rabbitmq.aliveness` has no equivalent in the Prometheus Plugin.

0 commit comments

Comments
 (0)