twnel/journald-wrapper repository overview

⁠Nuxeo.io systemd journal wrapper to CloudWatch Logs

This repository holds the Dockerfile for our journald wrapper to Amazon CloudWatch Logs⁠.

⁠Notes

This container is designed to be run over a CoreOS⁠ system, due to his dependency on Etcd. Etcd is used to hold last logs pushed, stored under /config/journald/{prefix}_{instance_id}/cursor key.

Also, it needs the service systemd-journal-gatewayd.service⁠ to be started, that exposes journald logs throught a webpage allowing to use Server-Sent Events⁠.

If you are running this wrapper with an old instance, with lots of existing logs; I strongly recommend you to use the standard gateway web interface to set the last cursor in etcd with a recent log cursor.

⁠Improvements

• Make the script available as a gem, using a gemfile to install container dependencies.
• Extract some concepts like; abstract the store used for the last cursor, stack events before sending them to AWS, ...
• Make it less dependends of an EC2 instance

⁠Mandatory container parameters

• CURSOR_PATH: the path in which the last cursor is written. Should be also defined as a volume to be saved in the container host.
• AWS_ACCESS_KEY_ID: AWS access key id used to push logs
• AWS_SECRET_ACCESS_KEY: AWS access secret
• AWS_REGION: AWS region
• PREFIX: a prefix to help you identify your cluster. The log group name will be: PREFIX_INSTANCE-ID.

⁠Running this container

# Ensure to have start `systemd-journal-gatewayd.service` service
sudo systemctl start systemd-journal-gatewayd.service

# build container
docker build -t journald_wrapper .

# run container
docker run -d -v /data/journald:/var/journald -e CURSOR_PATH=/var/journald -e AWS_ACCESS_KEY_ID={YOUR_KEY_ID} -e AWS_SECRET_ACCESS_KEY={YOUR_SECRET} -e AWS_REGION={YOUR_REGION} -e PREFIX={A_PREFIX_IDENTIFIER} journald_wrapper

⁠About Nuxeo

Nuxeo provides a modular, extensible Java-based open source software platform for enterprise content management⁠, and packaged applications for document management⁠, digital asset management⁠ and case management⁠.

Designed by developers for developers, the Nuxeo platform offers a modern architecture, a powerful plug-in model and extensive packaging capabilities for building content applications.

More information on: http://www.nuxeo.com/⁠