Skip to content

Commit

Permalink
DOCS-5309 Remove Mention of OpenMetrics V2 in TeamCity and RabbitMQ I…
Browse files Browse the repository at this point in the history
…ntegrations (#15235)

* Remove Mention of OpenMetrics V2

* Copy Nit

Co-authored-by: Ursula Chen <[email protected]>

* Add OpenMetrics V2 Back

* One More

* Metrics Cleanup

* One More

Co-authored-by: Ilia Kurenkov <[email protected]>

---------

Co-authored-by: Ursula Chen <[email protected]>
Co-authored-by: Ilia Kurenkov <[email protected]>
  • Loading branch information
3 people authored Sep 19, 2023
1 parent 86eb7b6 commit 454fbde
Show file tree
Hide file tree
Showing 4 changed files with 484 additions and 494 deletions.
39 changes: 17 additions & 22 deletions rabbitmq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@

This check monitors [RabbitMQ][2] through the Datadog Agent. It allows you to:

- Track queue-based stats: queue size, consumer count, unacknowledged messages, redelivered messages, etc.
- Track node-based stats: waiting processes, used sockets, used file descriptors, etc.
- Monitor vhosts for aliveness and number of connections

And more.
- Track queue-based stats: queue size, consumer count, unacknowledged messages, redelivered messages, and more.
- Track node-based stats: waiting processes, used sockets, used file descriptors, and more.
- Monitor vhosts for aliveness and number of connections.

## Setup

Expand All @@ -20,15 +18,15 @@ The RabbitMQ check is included in the [Datadog Agent][3] package. No additional

### Configuration

RabbitMQ exposes metrics in two ways: the [RabbitMQ Management Plugin][4] and the [Rabbitmq Prometheus Plugin][19]. The Datadog integration supports both versions. Please follow the configuration instruction in this file that pertain to the version you intend to use. The metrics accessible via the Prometheus plugin version of the integration are marked with [OpenMetricsV2] in their `metadata.csv` descriptions. The Datadog integration also comes with an out-of-the-box dashboard and monitors for each version, as labelled by the Dashboard and Monitor titles.
RabbitMQ exposes metrics in two ways: the [RabbitMQ Management Plugin][4] and the [RabbitMQ Prometheus Plugin][19]. The Datadog integration supports both versions. Follow the configuration instruction in this file that pertain to the version you intend to use. The Datadog integration also comes with an out-of-the-box dashboard and monitors for each version, as labeled by the Dashboard and Monitor titles.

#### Prepare RabbitMQ

##### [RabbitMQ Prometheus Plugin][19].

*Starting with RabbitMQ v3.8, the [RabbitMQ Prometheus Plugin][19] is enabled by default and the integration communicates with it over HTTP API using OpenMetricsV2.*
*Starting with RabbitMQ v3.8, the [RabbitMQ Prometheus Plugin][19] is enabled by default.*

*The Prometheus plugin version of RabbitMQ requires Python 3 support by the Datadog agent, and so can only be supported by Agent V6 onwards. Please ensure your agent is updated before configuring the Prometheus plugin version of the integration.*
*The Prometheus plugin version of RabbitMQ requires Python 3 support by the Datadog Agent, and so can only be supported by Agent v6 or later. Please ensure your agent is updated before configuring the Prometheus plugin version of the integration.*

Configure the `prometheus_plugin` section in your instance configuration. When using the `prometheus_plugin` option, settings related to the Management Plugin are ignored.

Expand Down Expand Up @@ -121,7 +119,7 @@ _Available for Agent versions >6.0_

#### Containerized

You can take advantage of Datadog's [Docker container Autodiscovery][21], see the `auto_conf.yaml` example configuration for Rabbitmq-specific settings.
You can take advantage of Datadog's [Docker container Autodiscovery][21], see the `auto_conf.yaml` example configuration for RabbitMQ-specific settings.

For container environments such as Kubernetes, see the [Autodiscovery Integration Templates][9] for guidance on applying the parameters below.

Expand All @@ -135,7 +133,7 @@ For container environments such as Kubernetes, see the [Autodiscovery Integratio

##### Log collection

_Available for Agent versions >6.0_
_Available for Agent v6.0 or later_

Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][10].

Expand Down Expand Up @@ -164,16 +162,6 @@ See [service_checks.json][14] for a list of service checks provided by this inte

## Troubleshooting

Need help? Contact [Datadog support][13].

## Further Reading

Additional helpful documentation, links, and articles:

- [Key metrics for RabbitMQ monitoring][15]
- [Collecting metrics with RabbitMQ monitoring tools][16]
- [Monitoring RabbitMQ performance with Datadog][17]

### Migrating to Prometheus Plugin

The Prometheus Plugin exposes a different set of metrics from the Management Plugin.
Expand All @@ -192,10 +180,17 @@ The Prometheus Plugin changes some tags. The table below describes the changes t
| `rabbitmq_vhost` | `vhost`, `exchange_vhost`, `queue_vhost` |
| `rabbitmq_exchange` | `exchange` |

For more information, see [Tagging RabbitMQ queues by tag family][18].

Need help? Contact [Datadog support][13].

## Further Reading

### FAQ
Additional helpful documentation, links, and articles:

- [Tagging RabbitMQ queues by tag family][18]
- [Key metrics for RabbitMQ monitoring][15]
- [Collecting metrics with RabbitMQ monitoring tools][16]
- [Monitoring RabbitMQ performance with Datadog][17]

[1]: https://raw.githubusercontent.com/DataDog/integrations-core/master/rabbitmq/images/rabbitmq_dashboard.png
[2]: https://www.rabbitmq.com
Expand Down
Loading

0 comments on commit 454fbde

Please sign in to comment.