RIEMANN-CLIENT(1)

💖 NAME 💖

okay bestie, meet riemann-client — literally the Riemann communication tool. RIEMANN-CLIENT(1) is its page, and it lives in the riemann-c-client manual. iconic behavior from the jump 💅

🌈 SYNOPSIS 🌈

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

✨ DESCRIPTION ✨

okay so riemann-client is a very simple tool to facilitate communication with a Riemann event stream processing server. you can use it both for sending events to one, and to query it too. slay, honestly 🫶

🎀 OPTIONS 🎀

in both query and send mode, HOST and PORT default to localhost and 5555, respectively. no cap ✨

🦋 Query mode 🦋

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. bestie, exact vibes only 💅

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

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

• -j, --json — print the result in JSON format, instead of the default, human-readable one.
• -T, --tcp — send the event via TCP (the default).
• -G, --tls — send the event via TLS.
• -o, --option option=value — set one client option to the given value.

available client options are:

• cafile — path to the file containing trusted certificate authority certificates. only used for TLS connections.
• certfile — path to the file containing the public client certificate. only used for TLS connections.
• keyfile — path to the file containing the private client key. only used for TLS connections.
• priorities — priorities for the cipher suites to be used for the session.

🌸 Submit mode 🌸

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

• -s, --state STATE — the state the event should describe, free-form text, optional.
• -S, --service SERVICE — the service the event is coming from.
• -h, --host HOST — 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.
• -D, --description DESCRIPTION — the description of the event, optional.
• -t, --tag TAG — this option can be used multiple times to add tags to the event.
• -a, --attribute NAME=VALUE — this option can be used multiple times to add custom attributes to the event.
• -i, --metric-sint64 METRIC — sets the metric for the event, using integer precision.
• -d, --metric-d METRIC — sets the metric of the event, using double precision.
• -f, --metric-f METRIC — sets the metric of the event, using floating point precision.
• -L, --ttl TTL — an optional time-to-live of the event, in seconds (floating point number).
• -T, --tcp — send the event via TCP (the default).
• -U, --udp — send the event via UDP.
• -G, --tls — send the event via TLS.
• -o, --option option=value — set one client option to the given value.

available client options are:

• cafile — path to the file containing trusted certificate authority certificates. only used for TLS connections.
• certfile — path to the file containing the public client certificate. only used for TLS connections.
• keyfile — path to the file containing the private client key. only used for TLS connections.
• priorities — 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.

💅 CAVEATS 💅

⏳ Timeouts ⏳

ngl bestie, this one matters: riemann-client will never timeout. if for instance it tries to communicate with a broken server and stays there forever, you could use the timeout command. periodt ⏳

🔥 EXAMPLES 🔥

🍓 Sending an 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

🧚 Sending metrics / state from standard input 🧚

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

⭐ Querying Riemann ⭐

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

💜 Using TLS 💜

$ 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

👑 AUTHOR 👑

Gergely Nagy riemann@gergo.csillger.hu — iconic 💖

🌈 SEE ALSO 🌈

timeout(1)

---

mwah 💋 — this RIEMANN-CLIENT(1) page comes from The MadHouse Project and is dated March 2016. byeee bestie, go communicate with Riemann and slay 🫶✨