Skip to content

Commit

Permalink
Exchange (kbudde#12)
Browse files Browse the repository at this point in the history
added exchange metrics. Some refactoring was done to remove duplicated code.
closes kbudde#10

Signed-off-by: Kris Budde <[email protected]>
  • Loading branch information
kbudde authored Sep 4, 2016
1 parent 330f93b commit 55fc8f7
Show file tree
Hide file tree
Showing 9 changed files with 341 additions and 113 deletions.
100 changes: 65 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,46 +40,76 @@ Example

### Metrics

#### Overview
#### Global

Total number of:

* channels
* connections
* consumers
* exchanges
* queues
metric | description
-------| ------------
|up | Was the last scrape of rabbitmq successful.|
|channelsTotal | Total number of open channels|
|connectionsTotal | Total number of open connections|
|consumersTotal | Total number of message consumers|
|queuesTotal | Total number of queues in use|
|exchangesTotal | Total number of exchanges in use|

#### Queues

For each queue the number of:

* messages_ready
* messages_unacknowledged
* messages
* messages_ready_ram
* messages_unacknowledged_ram
* messages_ram
* messages_persistent
* message_bytes
* message_bytes_ready
* message_bytes_unacknowledged
* message_bytes_ram
* message_bytes_persistent
* disk_reads
* disk_writes
* consumers
* consumer_utilisation
* memory
* messages_published_total
* messages_confirmend_total
* messages_delivered_total
* messages_delivered_noack_total
* messages_get_total
* messages_get_noack_total
* messages_redelivered_total
* messages_returned_total
#### Queues

Labels: vhost, queue

##### Gauge

metric | description
-------| ------------
|queue_messages_ready|Number of messages ready to be delivered to clients.|
|queue_messages_unacknowledged|Number of messages delivered to clients but not yet acknowledged.|
|queue_messages|Sum of ready and unacknowledged messages (queue depth).|
|queue_messages_ready_ram|Number of messages from messages_ready which are resident in ram.|
|queue_messages_unacknowledged_ram|Number of messages from messages_unacknowledged which are resident in ram.|
|queue_messages_ram|Total number of messages which are resident in ram.|
|queue_messages_persistent|Total number of persistent messages in the queue (will always be 0 for transient queues).|
|queue_message_bytes|Sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead.|
|queue_message_bytes_ready|Like message_bytes but counting only those messages ready to be delivered to clients.|
|queue_message_bytes_unacknowledged|Like message_bytes but counting only those messages delivered to clients but not yet acknowledged.|
|queue_message_bytes_ram|Like message_bytes but counting only those messages which are in RAM.|
|queue_message_bytes_persistent|Like message_bytes but counting only those messages which are persistent.|
|queue_consumers|Number of consumers.|
|queue_consumer_utilisation|Fraction of the time (between 0.0 and 1.0) that the queue is able to immediately deliver messages to consumers. This can be less than 1.0 if consumers are limited by network congestion or prefetch count.|
|queue_memory|Bytes of memory consumed by the Erlang process associated with the queue, including stack, heap and internal structures.|

##### Counter

metric | description
-------| ------------
|queue_disk_reads|Total number of times messages have been read from disk by this queue since it started.|
|queue_disk_writes|Total number of times messages have been written to disk by this queue since it started.|
|queue_messages_published_total|Count of messages published.|
|queue_messages_confirmed_total|Count of messages confirmed. |
|queue_messages_delivered_total|Count of messages delivered in acknowledgement mode to consumers.|
|queue_messages_delivered_noack_total|Count of messages delivered in no-acknowledgement mode to consumers. |
|queue_messages_get_total|Count of messages delivered in acknowledgement mode in response to basic.get.|
|queue_messages_get_noack_total|Count of messages delivered in no-acknowledgement mode in response to basic.get.|
|queue_messages_redelivered_total|Count of subset of messages in deliver_get which had the redelivered flag set.|
|queue_messages_returned_total|Count of messages returned to publisher as unroutable.|

#### Exchanges - Counter

Labels: vhost, exchange

metric | description
-------| ------------
|exchange_messages_published_total|Count of messages published.|
|exchange_messages_published_in_total|Count of messages published in to an exchange, i.e. not taking account of routing.|
|exchange_messages_published_out_total|Count of messages published out of an exchange, i.e. taking account of routing.|
|exchange_messages_confirmed_total|Count of messages confirmed. |
|exchange_messages_delivered_total|Count of messages delivered in acknowledgement mode to consumers.|
|exchange_messages_delivered_noack_total|Count of messages delivered in no-acknowledgement mode to consumers. |
|exchange_messages_get_total|Count of messages delivered in acknowledgement mode in response to basic.get.|
|exchange_messages_get_noack_total|Count of messages delivered in no-acknowledgement mode in response to basic.get.|
|exchange_messages_ack_total|Count of messages delivered in acknowledgement mode in response to basic.get.|
|exchange_messages_redelivered_total|Count of subset of messages in deliver_get which had the redelivered flag set.|
|exchange_messages_returned_total|Count of messages returned to publisher as unroutable.|

## Docker

To create a docker image locally it is recommened to use the Makefile.
Expand Down
30 changes: 27 additions & 3 deletions exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ type exporter struct {
queueMetricsCounter map[string]*prometheus.CounterVec
overviewMetrics map[string]prometheus.Gauge
upMetric prometheus.Gauge
exchangeMetrics map[string]*prometheus.CounterVec
}

func newExporter() *exporter {
Expand All @@ -21,14 +22,16 @@ func newExporter() *exporter {
queueMetricsCounter: queueCounterVec,
overviewMetrics: overviewMetricDescription,
upMetric: upMetricDescription,
exchangeMetrics: exchangeCounterVec,
}
}

func (e *exporter) fetchRabbit() {
rabbitMqOverviewData, overviewError := getOverviewMap(config)
rabbitMqQueueData, queueError := getQueueInfo(config)
rabbitMqOverviewData, overviewError := getMetricMap(config, "overview")
rabbitMqQueueData, queueError := getStatsInfo(config, "queues")
exchangeData, exchangeError := getStatsInfo(config, "exchanges")

if overviewError != nil || queueError != nil {
if overviewError != nil || queueError != nil || exchangeError != nil {
e.upMetric.Set(0)
} else {
e.upMetric.Set(1)
Expand Down Expand Up @@ -66,6 +69,17 @@ func (e *exporter) fetchRabbit() {
}
}

for key, countvec := range e.exchangeMetrics {
for _, exchange := range exchangeData {
if value, ok := exchange.metrics[key]; ok {
log.WithFields(log.Fields{"vhost": exchange.vhost, "exchange": exchange.name, "key": key, "value": value}).Debug("Set exchange metric for key")
countvec.WithLabelValues(exchange.vhost, exchange.name).Set(value)
} else {
//log.WithFields(log.Fields{"queue": queue, "key": key}).Warn("Queue data not found")
}
}
}

log.Info("Metrics updated successfully.")
}

Expand All @@ -80,6 +94,9 @@ func (e *exporter) Describe(ch chan<- *prometheus.Desc) {
for _, countervec := range e.queueMetricsCounter {
countervec.Describe(ch)
}
for _, exchangeMetric := range e.exchangeMetrics {
exchangeMetric.Describe(ch)
}
}

func (e *exporter) Collect(ch chan<- prometheus.Metric) {
Expand All @@ -92,6 +109,9 @@ func (e *exporter) Collect(ch chan<- prometheus.Metric) {
for _, countvec := range e.queueMetricsCounter {
countvec.Reset()
}
for _, exchangeMetric := range e.exchangeMetrics {
exchangeMetric.Reset()
}

e.fetchRabbit()

Expand All @@ -108,5 +128,9 @@ func (e *exporter) Collect(ch chan<- prometheus.Metric) {
countervec.Collect(ch)
}

for _, exchangeMetric := range e.exchangeMetrics {
exchangeMetric.Collect(ch)
}

BuildInfo.Collect(ch)
}
Loading

0 comments on commit 55fc8f7

Please sign in to comment.