Skip to content

mheese/journalbeat

Repository files navigation

Deprecation warning

Journalbeat is no longer maintained and developed. It has been superseded by the official Elastic Filebeat Journald input. Please consult the official Elastic docs for further details.

Journalbeat

Journalbeat is the Beat used for log shipping from systemd/journald based Linux systems. It follows the system journal very much like journalctl -f and sends the data to Logstash/Elasticsearch (or whatever you configured for your beat).

Journalbeat is targeting pure systemd distributions like CoreOS, Atomic Host, or others. There are no intentions to add support for older systems that do not use journald.

Use Cases and Goals

Besides from the obvious use case (log shipping) the goal of this project is also to provide a common source for more advanced topics like:

  • FIM (File Integrity Monitoring)
  • SIEM
  • Audit Logs / Monitoring

This is all possible because of the tight integration of the Linux audit events into journald. That said journalbeat can only provide the data source for these more advanced use cases. We need to develop additional pieces for monitoring and alerting - as well as hopefully a standardized Kibana dashboard to cover these features.

Documentation

None so far. As of this writing, this is the first commit. There are things to come. You can find a journalbeat.yml config file in the etc folder which should be self-explanatory for the time being.

Install

You need to install systemd development packages beforehand. In a RHEL or Fedora environment, you need to install the systemd-devel package, libsystemd-dev in debian-based systems, et al.

go get github.com/mheese/journalbeat

NOTE: This is not the preferred way from Elastic on how to do it. Needs to be revised (of course).

Caveats

A few current caveats with journalbeat

cgo

The underlying system library go-systemd makes heavy usage of cgo and the final binary will be linked against all client libraries that are needed in order to interact with sd-journal. That means that the resulting binary is not really Linux distribution independent (which is kind of expected in a way).