riemannx v4.0.4 API Reference

Modules

Riemannx is a riemann client that supports UDP/TCP/TLS sockets and also supports a hybrid connection where smaller packets are sent via UDP and the rest over TCP. All connection types can also have a batching layer added over the top

This is the behaviour specification for all connections as well as a generic API for communication with them based on the settings given in your config

The batch connector is a pass through module that adds batching functionality on top of the existing protocol connections

The combined connection worker works out when it’s possible to use UDP and will transmit via TCP when the message size exceeds the total max byte size

Using the TCP connection will only send traffic via TCP, all traffic can be sent via TCP as opposed to UDP where you are limited by packet size, there is however an overhead penalty using purely TCP which is why the combined connection is the recommended default

TLS is a secure TCP connection, you can use this if communicating with your riemann server securely is important - it carries some overhead and is much slower than UDP/combined but the trade-off is obviously worth it if security is a concern

Using the UDP connection is not recommended at all, events will be dropped if they exceed the max_udp_size set. You can increase this server side and set the desired value in this client

This is the callback module for metrics, you can extend this to report metrics to any kind of metric software (graphite, influx etc.)

The default metrics backend which does nothing

This is the callback module for settings, you can extend this if you wish to store your riemannx settings elsewhere like a database

This module follows the default config format as of 3.0.0

Exceptions