Skip to content

Commit

Permalink
update readme and sample config with new trigger info
Browse files Browse the repository at this point in the history
  • Loading branch information
zbrox committed Jun 9, 2020
1 parent 66c3d24 commit 9fcea7f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,13 @@ Here are the currently available triggers and their type field. If you put an in
- **Total number of messages** (`type = "messages_total"`) - The total number of messages currently on the queue
- **Number of ready messages** (`type = "messages_ready"`) - The number of messages available to consumers, ready to be delivered
- **Number of unacknowledged messages** (`type = "messages_unacknowledged"`) - The number of messages delivered to a consumer but not yet acked
- **Number of redelivered messages** (`type = "messages_redelivered"`) - The number of redelivered messages (due to being rejected)
- **Total rate of messages** (`type = "messages_total_rate"`) - The rate (*per second*) at which messages move in and out of the queue
- **Rate of ready messages** (`type = "messages_ready_rate"`) - The rate (*per second*) at which ready messages change
- **Rate of unacknowledged messages** (`type = "messages_unacknowledged_rate"`) - The rate (*per second*) at which unacknowledged messages change
- **Publishing rate** (`type = "messages_publish_rate"`) - The rate (*per second*) at which messages are published on the queue
- **Delivery rate** (`type = "messages_delivery_rate"`) - The rate (*per second*) at which messages are delivered by the queue
- **Redelivery rate** (`type = "messages_redeliver_rate"`) - The rate (*per second*) at which messages are redelivered to the queue (because of rejection)

### Docker image

Expand Down
2 changes: 1 addition & 1 deletion config_sample.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ icon_url = "https://example.com/image.png"
# icon_emoji=":bowtie:" # you can also use icon_emoji if you're not using icon_url, reference icon emojis at http://emoji-cheat-sheet.com

[[triggers]]
# Options: consumers_total, memory_total, messages_total, messages_ready, messages_unacknowledged, messages_total_rate, messages_ready_rate, messages_unacknowledged_rate, messages_publish_rate, messages_delivery_rate
# Options: consumers_total, memory_total, messages_total, messages_ready, messages_unacknowledged, messages_redelivered, messages_total_rate, messages_ready_rate, messages_unacknowledged_rate, messages_publish_rate, messages_delivery_rate, messages_redeliver_rate
type = "messages_ready" # what value will be observed to pass the threshold
threshold = 10000
queue = "the_queue_name" # this is optional, if ommitted it will be a rule valid for all queues
Expand Down

0 comments on commit 9fcea7f

Please sign in to comment.