https://github.com/markstory/rust-statsd-server
A statsd server implemented in Rustlang
https://github.com/markstory/rust-statsd-server
graphite metrics rust rust-statsd statsd-server
Last synced: 6 months ago
JSON representation
A statsd server implemented in Rustlang
- Host: GitHub
- URL: https://github.com/markstory/rust-statsd-server
- Owner: markstory
- License: mit
- Created: 2015-07-26T04:18:15.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-09-02T12:55:52.000Z (about 5 years ago)
- Last Synced: 2025-04-11T01:52:54.940Z (6 months ago)
- Topics: graphite, metrics, rust, rust-statsd, statsd-server
- Language: Rust
- Size: 54.7 KB
- Stars: 19
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rust Statsd Server
[](https://travis-ci.org/markstory/rust-statsd-server)
This is a statsd server implementation written in rust. It aims to be as
compatible as possible with etsy/statsd.
# Building the application
1. Clone the repository.
2. Run `make install`.
3. The generated binary will be in `dist/statsd`.
# Running tests
After cloning the repository you can run either the unit tests, and or the
integration tests. The integration tests require python 2.7 and that port 8125
be free on your system.
```
make test
```
Will run both the unit and integration tests.
# Usage
The statsd server has several options to control which ports it runs on:
```
-p, --port=
The UDP port to bind to [default: 8125].
--admin-host=
The host to bind the management server on. [default: 127.0.0.1]
--admin-port=
The port to bind the management server to. [default: 8126]
```
## Changing how frequently metrics are output
```
--flush-interval=
How frequently to flush metrics to the backends in seconds. [default: 10].
```
On each flush interval event, derived metrics for timers are calculated. This
duration is tracked as `statsd.processing_time`. You can use this metric to
track how long statsd is spending generating derived metrics.
## Enabling the console or graphite backends
By default no backends are enabled. In this mode the statsd server doesn't do
that much. To enable one or both backends use the CLI flags:
```
--console Enable the console backend.
--graphite Enable the graphite backend.
```
The graphite backend has additional options for defining where graphite/carbon
runs:
```
--graphite-port=
The port graphite/carbon is running on. [default: 2003].
--graphite-host=
The host graphite/carbon is running on. [default: 127.0.0.1]
```
## Internal metrics
This server tracks a few internal metrics:
* `statsd.bad_messages` The number of invalid metrics that have been sent since
the last flush.
* `statsd.total_messages` The number of messages received including invalid
messages.
* `statsd.processing_time` How many ms were spent calculating derived metrics
in the current flush cycle.
## Prior Art
I took a bunch of inspiration in how to implement and structure this
implementation from [erik/rust-statsd](https://github.com/erik/rust-statsd).