Skip to content

Commit

Permalink
Added documentation for grabbit metrics (#117)
Browse files Browse the repository at this point in the history
* added initial documentation for grabbit metrics

*  including metrics section in readme.md
  • Loading branch information
Guy Baron committed Aug 9, 2019
1 parent 2b4ea92 commit 459fd66
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ A lightweight transactional message bus on top of RabbitMQ supporting:
5) [Reliable messaging](https://github.com/wework/grabbit/blob/master/docs/OUTBOX.md) and local service transactivity via Transaction Outbox pattern
6) Deadlettering
7) [Structured logging](https://github.com/wework/grabbit/blob/master/docs/LOGGING.md)
8) Reporting [metrics](https://github.com/wework/grabbit/blob/master/docs/METRICS.md) via Prometheus

Planned:

Expand Down
9 changes: 9 additions & 0 deletions docs/METRICS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Metrics

grabbit exposes and reports operational the following metrics to Prometheus

| Namespace | Subsystem | Name | Description |
| ------------- | ------------- | ----------------------------------| --------------------------------------------------------------------------- |
| grabbit | handler | [name of message handler]_result | records and counts each succesfull or failed execution of a message handler |
| grabbit | handler | [name of message handler]_latency | records the execution time of each handler |
| grabbit | messages | rejected_messages | increments each time a message gets rejected |

0 comments on commit 459fd66

Please sign in to comment.