Skip to content
A C client library for the Riemann monitoring system.
C Roff M4 Makefile C++ Clojure Shell
Branch: master
Clone or download
algernon drone: Upgrade the Drone pipeline to 1.0
We need tighter control over when the riemann service starts, so push it to the
steps and make it detached instead of keeping it as a separate service that'd
start too early.

Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
Latest commit ec8dee6 Apr 11, 2019

README.md

Riemann C client library

CI status

This is a C client library for the Riemann monitoring system, providing a convenient and simple API, high test coverage and a copyleft license, along with API and ABI stability.

The library uses semantic versioning.

Features

  • Sending events over TCP, TLS and UDP
  • Launching queries (TCP & TLS only)
  • Support for tags and attributes on events
  • Ability to send multiple events in a single message
  • Convenient and straightforward API (see the API docs and the demo below!)
  • A comprehensive test suite
  • API and ABI stability (including symbol versioning on platforms where it is available).

Demo

A simple program that sends a static event to Riemann is included below. A few more useful programs are included in the src directory of the source code.

#include <riemann/riemann-client.h>
#include <riemann/simple.h>

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

int
main (void)
{
  riemann_client_t *client;
  riemann_message_t *r;

  client = riemann_client_create (RIEMANN_CLIENT_TCP, "localhost", 5555);
  if (!client)
    {
      fprintf (stderr, "Error while connecting to Riemann: %s\n",
               strerror (errno));
      exit (EXIT_FAILURE);
    }

  r = riemann_communicate_event
    (client,
     RIEMANN_EVENT_FIELD_HOST, "localhost",
     RIEMANN_EVENT_FIELD_SERVICE, "demo-client",
     RIEMANN_EVENT_FIELD_STATE, "ok",
     RIEMANN_EVENT_FIELD_TAGS, "demo-client", "riemann-c-client", NULL,
     RIEMANN_EVENT_FIELD_NONE);

  if (!r)
    {
      fprintf (stderr, "Error while sending message: %s\n", strerror (errno));
      exit (EXIT_FAILURE);
    }

  if (r->ok != 1)
    {
      fprintf (stderr,  "Error communicating with Riemann: %s\n",
               (r->error) ? r->error : strerror (errno));
      exit (EXIT_FAILURE);
    }

  riemann_message_free (r);
  riemann_client_free (client);

  return EXIT_SUCCESS;
}

Installation

The library follows the usual autotools way of installation:

$ git clone https://git.madhouse-project.org/algernon/riemann-c-client.git
$ cd riemann-c-client
$ autoreconf -i
$ ./configure && make && make check && make install

For the build to succeed, one will need libtool 2.2+ (only if building from a git checkout), the protobuf-c compiler. Optionally, for TLS support, one needs GnuTLS 2.8+, and to enable the JSON output support in riemann-client, one also needs the json-c library installed.

From this point onward, the library is installed and fully functional, and one can use pkg-config to compile programs against it:

${CC} $(pkg-config --cflags --libs riemann-client) demo.c -o demo -Wall

If, for some reason the build fails, one may need to regenerate the protobuf-c-compiler generated headers (changes in the compiler are known to cause issues). To do this, do a make distclean first, and then start over from configure.

License

Copyright (C) 2013-2018 Gergely Nagy algernon@madhouse-project.org, released under the terms of the GNU Lesser General Public License, version 3+.

You can’t perform that action at this time.