Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Forward systemd journal logs to cloudwatch

Project description

Build status

Forward systemd journal logs to CloudWatch.

A log forwarder daemon similar to Amazon’s awslogs agent, but using per systemd unit journal output instead of text log files.

Installing

Use your system package manager to install systemd Python 3 binding. The required package is named python3-systemd both in Ubuntu and Fedora:

dnf install python3-systemd

If on Ubuntu, install python3-venv too:

apt install python3-venv

Create dedicated virtualenv for awslogs-sd:

python3 -m venv --system-site-packages /opt/awslogs-sd
/opt/awslogs-sd/bin/pip install wheel

And finally:

/opt/awslogs-sd/bin/pip install awslogs-sd

Daemon binary will be available under /opt/awslogs-sd/bin/awslogs-sd.

AWS setup

Similarly to Amazon’s awslogs, awslogs-sd requires an IAM policy attached to EC2 instance. Configuration is the same as in Amazon awslogs documentation.

Usage

awslogs-sd requires path to configuration file as a positional argument.

You can use --logging-conf to pass optional YAML logging configuration in dictConfig format. See Python logging documentation. Following loggers can be configured:

  • awslogs: main daemon logger
  • metrics: daemon statistics printed at INFO level every 10 seconds

Configuration

Configuration file uses ini format and is designed to be similar to Amazon awslogs configuration.

There are two main ini sections general and include. Every other section has arbitrary name and contains a single systemd unit configuration.

general

Following option is required:

  • state_file: path to daemon database. Must be in persistent storage.

Example:

[general]
state_file = /var/lib/awslogs-sd/state

include

Optional section with a single option:

  • path: an Unix glob pattern to specify locations of additional configuration files to load and merge with main one. Used mostly to support popular conf.d drop-in pattern.

Example:

[include]
path = /etc/awslogs-sd.conf.d/*.conf

Unit sections

Example:

[httpd_error]
unit = httpd.service
priority = ERR
syslog_ident = httpd_error
syslog_facility = local1
log_group_name = httpd-access
log_stream_name = {instance_id}

Following options are supported:

  • unit (required): systemd unit name
  • log_group_name (required): destination CloudWatch log group
  • log_stream_name (required): CloudWatch stream name inside group; support basic variable interpolation (see below)
  • priority: minimum journal priority to match (default: INFO). See Arch wiki.
  • format: output log format, one of text or json (default: text)
  • datetime_format: datetime format in strftime format if text output is used (default: %b %d %H:%M:%S)
  • syslog_ident: match by syslog ident (aka “tag”) if syslog transport is used
  • syslog_facility: match by syslog facility if syslog transport is used

Stream name variables

Stream names support variable interpolation with {var} syntax. Following variables are available:

  • instance_id: local EC2 instance id
  • hostname: machine hostname

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
awslogs_sd-0.5-py3-none-any.whl (10.8 kB) Copy SHA256 hash SHA256 Wheel py3
awslogs-sd-0.5.tar.gz (11.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page