Skip to content

Commit

Permalink
Clearer instructions for migrating to prometheus plugin (#14443)
Browse files Browse the repository at this point in the history 
* Clearer instructions for migrating to prometheus plugin

* fix link

Co-authored-by: Florent Clarret <florent.clarret@datadoghq.com>

* add note about mgmt-only metrics

* Apply suggestions from code review

Co-authored-by: May Lee <may.lee@datadoghq.com>

---------

Co-authored-by: Florent Clarret <florent.clarret@datadoghq.com>
Co-authored-by: May Lee <may.lee@datadoghq.com>
  • Loading branch information
@iliakur @FlorentClarret @maycmlee
3 people committed Apr 25, 2023
1 parent f24ae72 commit 37aab9c
Showing 1 changed file with 8 additions and 85 deletions.
93 changes: 8 additions & 85 deletions rabbitmq/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,91 +174,14 @@ Additional helpful documentation, links, and articles:
- [Collecting metrics with RabbitMQ monitoring tools][16]
- [Monitoring RabbitMQ performance with Datadog][17]

### Prometheus Plugin Migration Guide

The following table maps metrics coming from the Management plugin to their Prometheus plugin equivalents.

| Management Plugin metric | Prometheus Plugin Equivalent | Endpoint |
|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------|
| rabbitmq.connections | rabbitmq\_connections | |
| rabbitmq.node.disk\_alarm | rabbitmq\_alarms\_free\_disk\_space\_watermark | /metrics |
| rabbitmq.node.disk\_free | rabbitmq\_disk\_space\_available\_bytes | |
| rabbitmq.node.fd\_used | rabbitmq\_process\_open\_fds | |
| rabbitmq.node.mem\_alarm | rabbitmq\_alarms\_memory\_used\_watermark | /metrics |
| rabbitmq.node.mem\_limit | rabbitmq\_resident\_memory\_limit\_bytes | |
| rabbitmq.node.mem\_used | rabbitmq\_process\_resident\_memory\_bytes | |
| rabbitmq.node.sockets\_used | erlang\_vm\_port\_count | |
| rabbitmq.overview.messages.confirm.count | rabbitmq\_global\_messages\_confirmed\_total | |
| rabbitmq.overview.messages.deliver\_get.count | rabbitmq\_global\_messages\_delivered\_get\_auto\_ack\_total + rabbitmq\_global\_messages\_delivered\_get\_manual\_ack\_total | |
| rabbitmq.overview.messages.publish.count | rabbitmq\_queue\_messages\_published\_total | /metrics |
| rabbitmq.overview.messages.redeliver.count | rabbitmq\_global\_messages\_redelivered\_total | |
| rabbitmq.overview.messages.return\_unroutable.count | rabbitmq\_global\_messages\_unroutable\_returned\_total | |
| rabbitmq.overview.object\_totals.channels | rabbitmq\_channels | |
| rabbitmq.overview.object\_totals.connections | rabbitmq\_connections | |
| rabbitmq.overview.object\_totals.consumers | rabbitmq\_global\_consumers | |
| rabbitmq.overview.object\_totals.queues | rabbitmq\_queues | |
| rabbitmq.overview.queue\_totals.messages.count | rabbitmq\_queue\_messages | /metrics |
| rabbitmq.overview.queue\_totals.messages\_ready.count | rabbitmq\_queue\_messages\_ready | /metrics |
| rabbitmq.overview.queue\_totals.messages\_unacknowledged.count | rabbitmq\_queue\_messages\_unacked | /metrics |
| rabbitmq.queue.consumers | rabbitmq\_queue\_consumers | /metrics |
| rabbitmq.queue.head\_message\_timestamp | rabbitmq\_queue\_head\_message\_timestamp | /metrics/per-object |
| rabbitmq.queue.memory | rabbitmq\_queue\_process\_memory\_bytes | /metrics/per-object |
| rabbitmq.queue.message\_bytes | rabbitmq\_queue\_messages\_ready\_bytes | /metrics/per-object |
| rabbitmq.queue.messages | rabbitmq\_queue\_messages | /metrics/per-object |
| rabbitmq.queue.messages.publish.count | rabbitmq\_queue\_messages\_published\_total | /metrics |
| rabbitmq.queue.messages.redeliver.count | rabbitmq\_global\_messages\_redelivered\_total | |
| rabbitmq.queue.messages\_ready | rabbitmq\_queue\_messages\_ready | |
| rabbitmq.queue.messages\_unacknowledged | rabbitmq\_queue\_messages\_unacked | |

The following Management plugin metrics to our knowledge have no equivalent in the Prometheus plugin.

- rabbitmq.connections.state
- rabbitmq.exchange.messages.ack.count
- rabbitmq.exchange.messages.ack.rate
- rabbitmq.exchange.messages.confirm.count
- rabbitmq.exchange.messages.confirm.rate
- rabbitmq.exchange.messages.deliver\_get.count
- rabbitmq.exchange.messages.deliver\_get.rate
- rabbitmq.exchange.messages.publish.count
- rabbitmq.exchange.messages.publish.rate
- rabbitmq.exchange.messages.publish\_in.count
- rabbitmq.exchange.messages.publish\_in.rate
- rabbitmq.exchange.messages.publish\_out.count
- rabbitmq.exchange.messages.publish\_out.rate
- rabbitmq.exchange.messages.redeliver.count
- rabbitmq.exchange.messages.redeliver.rate
- rabbitmq.exchange.messages.return\_unroutable.count
- rabbitmq.exchange.messages.return\_unroutable.rate
- rabbitmq.node.partitions
- rabbitmq.node.run\_queue
- rabbitmq.node.running
- rabbitmq.overview.messages.ack.count
- rabbitmq.overview.messages.ack.rate
- rabbitmq.overview.messages.confirm.rate
- rabbitmq.overview.messages.deliver\_get.rate
- rabbitmq.overview.messages.publish.rate
- rabbitmq.overview.messages.publish\_in.count
- rabbitmq.overview.messages.publish\_in.rate
- rabbitmq.overview.messages.publish\_out.count
- rabbitmq.overview.messages.publish\_out.rate
- rabbitmq.overview.messages.redeliver.rate
- rabbitmq.overview.messages.return\_unroutable.rate
- rabbitmq.overview.queue\_totals.messages.rate
- rabbitmq.overview.queue\_totals.messages\_ready.rate
- rabbitmq.overview.queue\_totals.messages\_unacknowledged.rate
- rabbitmq.queue.active\_consumers
- rabbitmq.queue.bindings.count
- rabbitmq.queue.messages.ack.count
- rabbitmq.queue.messages.ack.rate
- rabbitmq.queue.messages.deliver.count
- rabbitmq.queue.messages.deliver.rate
- rabbitmq.queue.messages.deliver\_get.count
- rabbitmq.queue.messages.deliver\_get.rate
- rabbitmq.queue.messages.publish.rate
- rabbitmq.queue.messages.rate
- rabbitmq.queue.messages.redeliver.rate
- rabbitmq.queue.messages\_ready.rate
- rabbitmq.queue.messages\_unacknowledged.rate
### Migrating to Prometheus Plugin

When migrating from the Management Plugin to the Prometheus Plugin, review the metrics that you use because some of them might have new names or might not be available anymore.

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 tags in their descriptions.


### FAQ

Expand Down

0 comments on commit 37aab9c

Please sign in to comment.