Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blind-oracle/riemann-relay
Service for relaying Riemann events to Riemann/Carbon destinations
https://github.com/blind-oracle/riemann-relay
balance carbon go golang json load protobuf relay riemann
Last synced: 3 months ago
JSON representation
Service for relaying Riemann events to Riemann/Carbon destinations
- Host: GitHub
- URL: https://github.com/blind-oracle/riemann-relay
- Owner: blind-oracle
- License: mpl-2.0
- Created: 2019-04-23T14:17:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-29T15:00:14.000Z (about 5 years ago)
- Last Synced: 2024-07-31T20:52:54.507Z (6 months ago)
- Topics: balance, carbon, go, golang, json, load, protobuf, relay, riemann
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - riemann-relay - Relay to load-balance Riemann events and/or convert them to Carbon. (Server Applications / HTTP Clients)
- zero-alloc-awesome-go - riemann-relay - Relay to load-balance Riemann events and/or convert them to Carbon. (Server Applications / HTTP Clients)
- awesome-go-extra - riemann-relay - 04-23T14:17:12Z|2019-10-29T15:00:14Z| (Server Applications / HTTP Clients)
README
[](https://goreportcard.com/report/github.com/blind-oracle/riemann-relay)
[](https://coveralls.io/github/blind-oracle/riemann-relay?branch=master)
[](https://travis-ci.org/blind-oracle/riemann-relay)
[](https://github.com/avelino/awesome-go)
# riemann-relay
This is a service that receives a Riemann Protobuf-formatted event stream and sends it to one or more targets in Riemann or Graphite format.
Although that can be done in Riemann itself, this service is simpler, probably faster and lightweight (no Java)
## Features
* Receive event batches in Riemann Protobuf format (see *riemann.proto*)
* Receive events in Riemann JSON format using Websocket API
* Convert Riemann events to Carbon metrics using flexible field mapping syntax
* Send events in configurable batch sizes to any number of Riemann/Carbon targets
* Supports TCP and Unix Sockets
* Different target selection algorithms:
- Round-Robin
- Hash
- Failover
- Broadcast
* Optional failover to other targets if the selected one is down (in Hash and Round-Robin modes)
* Prometheus metrics
* Log stats periodically
* Configurable batch and buffer sizes, flush intervals, timeouts
* Build RPM and DEB packages
See *riemann-relay.conf* for more details on features and how to configure them
## Performance
On 2 average CPU cores it's able to handle about 500k events per second, depending on batch size and incoming Riemann message sizes.
It will scale to more CPUs when using more targets and clients (each target and client gets it's own thread).
There's a room for optimizations, though.
## JSON URI and Event structure for Websocket
URI: ws://1.1.1.1:1234/events
```json
{
"host": "host1",
"service": "svc1",
"description": "cool",
"state": "ok",
"tags": ["tag1", "tag2"],
"metric": 123,
"time": "2018-04-10T13:36:04.787Z",
"attributes": [
{
"key": "key1",
"value": "val1"
}
]
}
```
## Install
For now in the releases only binaries for *linux-amd64* are available. For other platforms see the *Build* section below.
## Build
**riemann-relay** is written in [Go](https://golang.org/) and uses [dep](https://github.com/golang/dep) as a dependency manager, so you need to install them first.
Then:
```bash
# dep ensure
# go build
```
## Packaging
To build RPM & DEB packages you'll need [gox](https://github.com/mitchellh/gox) and [fpm](https://github.com/jordansissel/fpm).
Then just do one of:
```bash
# make rpm
# make deb
```
## Run
```bash
# /path/to/riemann-relay -config /etc/riemann-relay.conf
```
The logging currently goes to stdout.
Use *-debug* option to get a lot more detailed output (not for production).