RIEMANN-CLIENT(1) riemann-c-client RIEMANN-CLIENT(1)

riemann-client - Riemann communication tool

riemann-client query [OPTIONS...] QUERY [HOST] [PORT]
riemann-client send [OPTIONS...] [HOST] [PORT]
riemann-client --help|-?
riemann-client --version

riemann-client is a very simple tool to facilitate communication with a Riemann event stream processing server. It can be used both for sending events to one, and to query it too.

In both query and send mode, HOST and PORT default to localhost and 5555, respectively.

In query mode, riemann-client takes one mandatory argument: the query itself. It must be a single argument, which will be sent to Riemann as-is, and the response dumped to the standard output, or, in case of an error, the error message will be written to the standard error.

See the Riemann documentation http://riemann.io/concepts.html for more information about the query syntax.

Apart from the mandatory argument, the riemann-client accepts the following options in query mode:

Print the result in JSON format, instead of the default, human-readable one.

Send the event via TCP (the default).

Send the event via TLS.

Set one client option to the given value.

Available client options are:

Path to the file containing trusted certificate authority certificates. Only used for TLS connections.

Path to the file containing the public client certificate. Only used for TLS connections.

Path to the file containing the private client key. Only used for TLS connections.

Priorities for the cipher suites to be used for the session.

In submit mode, riemann-client accepts the following options:

The state the event should describe, free-form text, optional.

The service the event is coming from.

The host the event originates from. Not to be confused with the optional HOST parameter of riemann-client itself, which sets where to send the events to.

The description of the event, optional.

This option can be used multiple times to add tags to the event.

This option can be used multiple times to add custom attributes to the event.

Sets the metric for the event, using integer precision.

Sets the metric of the event, using double precision.

Sets the metric of the event, using floating point precision.

An optional time-to-live of the event, in seconds (floating point number).

Send the event via TCP (the default).

Send the event via UDP.

Send the event via TLS.

Set one client option to the given value.

Available client options are:

Path to the file containing trusted certificate authority certificates. Only used for TLS connections.

Path to the file containing the public client certificate. Only used for TLS connections.

Path to the file containing the private client key. Only used for TLS connections.

Priorities for the cipher suites to be used for the session.

-0, --stdin
Continuously read and send metrics and states from standard input. Uses all other fields specified on the command line. For each line on standard input, a new event will be sent to Riemann. If the input is a number, it will be used as a metric. If not, it will be used as the state. If it is a number, followed by a space and some string, then both metric and state will be set for the outgoing event. 

$ riemann-client send --state ok \
                      --service "client-test" \
                      --host "my-host" \
                      --description "A message from the Manual" \
                      --tag tag-1 --tag tag-2 \
                      --attribute x-manual=best-friend \
                      --metric-sint64 1 \
                      --ttl 300.5 \
                      --tcp

$ echo "1.5 ok" |  \
  riemann-client send --service "client-test: stdin" \
                      --host "my-host" \
                      --description "A message from STDIN" \
                      --tag stdin \
                      --tcp \
                      --stdin

$ riemann-client query 'host = "my-host"'

$ riemann-client query 'host = "my-host"' \
                       --tls \
                       --option cafile=tests/data/cacert.pem \
                       --option certfile=tests/data/client.crt \
                       --option keyfile=tests/data/client.key \
                       --option priorities=NORMAL \
                       localhost 5554

Gergely Nagy algernon@madhouse-project.org

March 2016 The MadHouse Project