Permalink
Browse files

add README information about the repeater backend

  • Loading branch information...
1 parent fc8e38b commit 96c488dc52a4f50fdf73343b8275e914be722655 @mrtazz mrtazz committed Sep 11, 2012
Showing with 10 additions and 0 deletions.
  1. +10 −0 README.md
View
@@ -103,6 +103,8 @@ StatsD includes the following backends:
web-browser interface.
* Console (`console`): The console backend outputs the received
metrics to stdout (e.g. for seeing what's going on during development).
+* Repeater (`repeater`): The repeater backend utilizes the `packet` emit API to
+ forward raw packets retrieved by StatsD to multiple backend StatsD instances.
By default, the `graphite` backend will be loaded automatically. To
select which backends are loaded, set the `backends` configuration
@@ -293,6 +295,14 @@ metrics: {
the `backend_name`. The backend should set `error` to *null*, or, in
the case of a failure, an appropriate error.
+* Event: **'packet'**
+
+ Parameters: `(packet, rinfo)`
+
+ This is emitted for every incoming packet. The `packet` parameter contains
+ the raw received message string and the `rinfo` paramter contains remote
+ address information from the UDP socket.
+
Inspiration
-----------

0 comments on commit 96c488d

Please sign in to comment.