src | ||
.gitignore | ||
.travis.yml | ||
build.rs | ||
Cargo.lock | ||
Cargo.toml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
default.nix | ||
LICENSE | ||
README.md |
journaldriver
This is a small daemon used to forward logs from journald
(systemd's
logging service) to Stackdriver Logging.
Most existing log services are written in inefficient dynamic languages with error-prone "cover every use-case" configuration. This tool aims to fit a specific use-case very well, instead of covering every possible logging setup.
journaldriver
can be run on GCP-instances with no additional
configuration as authentication tokens are retrieved from the
metadata server.
Features
journaldriver
persists the last forwarded position in the journal and will resume forwarding at the same position after a restartjournaldriver
will recognise log entries in JSON format and forward them appropriately to make structured log entries available in Stackdriverjournaldriver
can be used outside of GCP by configuring static credentials
Usage on Google Cloud Platform
journaldriver
does not require any configuration when running on GCP
instances.
-
Install
journaldriver
on the instance from which you wish to forward logs. -
Ensure that the instance has the appropriate permissions to write to Stackdriver. Google continously changes how IAM is implemented on GCP, so you will have to refer to Google's documentation.
By default instances have the required permissions if Stackdriver Logging support is enabled in the project.
-
Start
journaldriver
, for example viasystemd
.
Usage outside of Google Cloud Platform
When running outside of GCP, the following extra steps need to be performed:
-
Create a Google Cloud Platform service account with the "Log Writer" role and download its private key in JSON-format.
-
When starting
journaldriver
, configure the following environment variables:GOOGLE_CLOUD_PROJECT
: Name of the GCP project to which logs should be written.GOOGLE_APPLICATION_CREDENTIALS
: Filesystem path to the JSON-file containing the service account's private key.LOG_STREAM
: Name of the target log stream in Stackdriver Logging. This will be automatically created if it does not yet exist.LOG_NAME
: Name of the target log to write to. This defaults tojournaldriver
if unset, but it is recommended to - for example - set it to the machine hostname.
NixOS module
At Aprila we deploy all of our software using NixOS, including
journaldriver
. The NixOS package repository contains a module
for setting up journaldriver
.
On a GCP instance the only required option is this:
services.journaldriver.enable = true;
When running outside of GCP, the configuration looks as follows:
services.journaldriver = {
enable = true;
logStream = "prod-environment";
logName = "hostname";
googleCloudProject = "gcp-project-name";
applicationCredentials = keyFile;
};
Note: The journaldriver
-module is not yet included in a stable
release of NixOS, but it is available on the unstable
-channel.
Upcoming features:
journaldriver
will be added to [nixpkgs][] with a complementary NixOS module for easy configuration.