diff --git a/documentation/examples/contrib/kubernetes/rabbitmq/README.md b/documentation/examples/kubernetes-rabbitmq/README.md similarity index 61% rename from documentation/examples/contrib/kubernetes/rabbitmq/README.md rename to documentation/examples/kubernetes-rabbitmq/README.md index 0a61fffff..e3457759e 100644 --- a/documentation/examples/contrib/kubernetes/rabbitmq/README.md +++ b/documentation/examples/kubernetes-rabbitmq/README.md @@ -1,28 +1,28 @@ # RabbitMQ Scraping -This is an example on how to setup RabbitMQ so Prometheus can scrap data from it. +This is an example on how to setup RabbitMQ so Prometheus can scrape data from it. It uses a third party [RabbitMQ exporter](https://github.com/kbudde/rabbitmq_exporter). Since the [RabbitMQ exporter](https://github.com/kbudde/rabbitmq_exporter) needs to -connect on RabbitMQ management API to scrap data, and it defaults to localhost, it is +scrape the RabbitMQ management API to scrap data, and it defaults to localhost, it is easier to simply embed the **kbudde/rabbitmq-exporter** on the same pod as RabbitMQ, this way they share the same network. -With this pod running you will have the exporter scraping data, but Prometheus have not +With this pod running you will have the exporter scraping data, but Prometheus has not yet found the exporter and is not scraping data from it. -For more details on how to use kubernetes service discovery take a look on the +For more details on how to use Kubernetes service discovery take a look at the [documentation](http://prometheus.io/docs/operating/configuration/#kubernetes-sd-configurations-kubernetes_sd_config) -and on the [available examples](./documentation/examples). +and at the [available examples](./documentation/examples). After you got Kubernetes service discovery up and running you just need to advertise that RabbitMQ is exposing metrics. To do that you need to define a service that: * Exposes the exporter port -* Add the annotation: prometheus.io/scrape: "true" -* Add the annotation: prometheus.io/port: "9090" +* Has a **prometheus.io/scrape: "true"** annotation +* Has a **prometheus.io/port: "9090"** annotation -And you should be able to see your RabbitMQ exporter being scraped on Prometheus status page. -Since the ip that will be scraped will be the pod endpoint it is important that the node -where Prometheus is running have access to the Kubernetes overlay network -(flannel, weave, aws, or any of the other options that Kubernetes gives to you). +And you should be able to see your RabbitMQ exporter being scraped on the Prometheus status page. +Since the IP that will be scraped will be the pod endpoint it is important that the node +where Prometheus is running has access to the Kubernetes overlay network +(flannel, Weave, AWS, or any of the other options that Kubernetes gives to you). diff --git a/documentation/examples/contrib/kubernetes/rabbitmq/rc.yml b/documentation/examples/kubernetes-rabbitmq/rc.yml similarity index 100% rename from documentation/examples/contrib/kubernetes/rabbitmq/rc.yml rename to documentation/examples/kubernetes-rabbitmq/rc.yml diff --git a/documentation/examples/contrib/kubernetes/rabbitmq/svc.yml b/documentation/examples/kubernetes-rabbitmq/svc.yml similarity index 100% rename from documentation/examples/contrib/kubernetes/rabbitmq/svc.yml rename to documentation/examples/kubernetes-rabbitmq/svc.yml