Skip to content

Commit 3c2ea7b

Browse files
author
Cory G Watson
committed
Example usage
1 parent eae8816 commit 3c2ea7b

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,33 @@
11
# redis-statsd
22

33
Redis statsd is a small, dependency free Python program for periodically fetching stats via Redis' INFO
4-
command and emitting them to a local StatsD.
4+
command and emitting them to a local StatsD.
5+
6+
# Optional DogStatsD Tag Support
7+
8+
The `--no-tags` option will disable support for [DogStatsD](http://docs.datadoghq.com/guides/dogstatsd/)
9+
10+
# Usage
11+
12+
```
13+
usage: redis-statsd.py [-h] [--period PERIOD] [--prefix PREFIX]
14+
[--redis-host REDIS_HOST] [--redis-port REDIS_PORT]
15+
[--statsd-host STATSD_HOST] [--statsd-port STATSD_PORT]
16+
[--no-tags]
17+
18+
Collect metrics from Redis and emit to StatsD
19+
20+
optional arguments:
21+
-h, --help show this help message and exit
22+
--period PERIOD The period at which to collect and emit metrics
23+
--prefix PREFIX The prefix to use for metric names
24+
--redis-host REDIS_HOST
25+
The address of the Redis host to connect to
26+
--redis-port REDIS_PORT
27+
The port of the Redis host to connect to
28+
--statsd-host STATSD_HOST
29+
The port of the StatsD host to connect to
30+
--statsd-port STATSD_PORT
31+
The port of the Redis port to connect to
32+
--no-tags Disable tags for use with DogStatsD
33+
```

0 commit comments

Comments
 (0)