riemann-relay

Service for relaying Riemann events to Riemann/Carbon destinations

Programming language: Go

License: Mozilla Public License 2.0

Tags: Server Applications    

Latest version: v1.1.2

README

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

{
    "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 and uses dep as a dependency manager, so you need to install them first.

Then:

# dep ensure
# go build

Packaging

To build RPM & DEB packages you'll need gox and fpm.

Then just do one of:

# make rpm
# make deb

Run

# /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).