riemann-redis-output

A riemann Redis plugin.

Usage

In your riemann.config

(load-plugins) ; will load plugins from the classpath

(def redis-out (redis-output/sink))

(streams
    redis-out)

Or with options:

(load-plugins)
(def redis-out
  (redis-output/sink {:conn-spec {:host "redis" :port 6379 :db 13} :buff-size 1000 :encoder your-encoder}))

Note that sink creates a synchronous output, so you probably want to use async-queue! and perhaps batch events as well:

(def redis-out
  (async-queue! :redis {:queue-size 100
                        :core-pool-size 4
                        :max-pool-size 4}
                (redis-output/sink)))

(streams
 (batch 10 2 redis-out))

Options:

• :conn-spec - Carmine redis connection spec. See Carmine docs for more info
• :pool-spec - Carmine connection pool spec, basically apache-commons pool options
• :encoder - A function to convert Riemann event map to a string. Defaults to cheshire/generate-string (JSON serialization), see the source for more info.
• :key - The Redis key to output events to. Defaults to "riemann-events"
• :key-fn - A function to compute the Redis key from event; Overrides :key

Flapjack:

A Flapjack encoder is provided as flapjack-encoder function; it will rename keys as follows:

:service -> :check, :host -> :entity, :metric -> :perfdata, :description -> :summary

Flapjack is aware of more fields which may be of use: :details, :type, :state. If they are not present they will be assigned default values. See Flapjack docs for more info on these fields.

Additionally, set the Redis output key to "events":

(def flapjack (redis-output/output {:key "events" :encoder redis-output/flapjack-encoder}))

Installing

You will need to build this module for now and push it on riemann's classpath, for this you will need a working JDK, JRE and leiningen.

First build the project:

lein uberjar

The resulting artifact will be in target/riemann-redis-output-standalone-0.0.2.jar. You will need to push that jar on the machine(s) where riemann runs, for instance, in /usr/lib/riemann/riemann-redis-output.jar.

If you have installed riemann from a stock package you will only need to tweak /etc/default/riemann and change the line EXTRA_CLASSPATH to read:

EXTRA_CLASSPATH=/usr/lib/riemann/riemann-redis-output.jar

You can then use exposed functions, provided you have loaded the plugin in your configuration.

License

Copyright © 2014, 2022 Avishai Ish-Shalom Distributed under the Apache V2 License