{"id":23062015,"url":"https://github.com/mbachry/awslogs-sd","last_synced_at":"2025-08-15T08:33:08.600Z","repository":{"id":57413290,"uuid":"117854780","full_name":"mbachry/awslogs-sd","owner":"mbachry","description":"Forward systemd journal logs to cloudwatch","archived":false,"fork":false,"pushed_at":"2021-02-01T22:07:56.000Z","size":21,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-30T15:41:20.045Z","etag":null,"topics":["aws","cloudwatch","journal","logging","systemd"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mbachry.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-17T15:28:41.000Z","updated_at":"2023-02-20T20:14:57.000Z","dependencies_parsed_at":"2022-08-29T16:52:16.601Z","dependency_job_id":null,"html_url":"https://github.com/mbachry/awslogs-sd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbachry%2Fawslogs-sd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbachry%2Fawslogs-sd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbachry%2Fawslogs-sd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbachry%2Fawslogs-sd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbachry","download_url":"https://codeload.github.com/mbachry/awslogs-sd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229902245,"owners_count":18141860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","cloudwatch","journal","logging","systemd"],"created_at":"2024-12-16T03:19:37.374Z","updated_at":"2024-12-16T03:19:37.893Z","avatar_url":"https://github.com/mbachry.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"awslogs-sd\n==========\n\n.. image:: https://travis-ci.org/mbachry/awslogs-sd.svg?branch=master\n    :alt: Build status\n    :target: https://travis-ci.org/mbachry/awslogs-sd\n\nForward systemd journal logs to CloudWatch.\n\nA log forwarder daemon similar to Amazon's awslogs agent, but using\nper systemd unit journal output instead of text log files.\n\nInstalling\n----------\n\nUse your system package manager to install systemd Python 3\nbinding. The required package is named ``python3-systemd`` both in\nUbuntu and Fedora::\n\n    dnf install python3-systemd\n\nIf on Ubuntu, install ``python3-venv`` too::\n\n    apt install python3-venv\n\nCreate dedicated virtualenv for awslogs-sd::\n\n    python3 -m venv --system-site-packages /opt/awslogs-sd\n    /opt/awslogs-sd/bin/pip install wheel\n\nAnd finally::\n\n    /opt/awslogs-sd/bin/pip install awslogs-sd\n\nDaemon binary will be available under\n``/opt/awslogs-sd/bin/awslogs-sd``.\n\nAWS setup\n---------\n\nSimilarly to Amazon's awslogs, ``awslogs-sd`` requires an IAM policy\nattached to EC2 instance. Configuration is the same as in `Amazon\nawslogs documentation`_.\n\n.. _Amazon awslogs documentation: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/QuickStartEC2Instance.html\n\nUsage\n-----\n\n``awslogs-sd`` requires path to configuration file as a positional\nargument.\n\nYou can use ``--logging-conf`` to pass optional YAML logging\nconfiguration in ``dictConfig`` format. See `Python logging\ndocumentation`_. Following loggers can be configured:\n\n* ``awslogs``: main daemon logger\n\n* ``metrics``: daemon statistics printed at ``INFO`` level every 10\n  seconds\n\n.. _Python logging documentation: https://docs.python.org/2/library/logging.config.html#configuration-dictionary-schema\n\nConfiguration\n-------------\n\nConfiguration file uses ini format and is designed to be similar to\nAmazon `awslogs configuration`_.\n\nThere are two main ini sections ``general`` and ``include``. Every\nother section has arbitrary name and contains a single systemd unit\nconfiguration.\n\n.. _awslogs configuration: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html\n\n``general``\n~~~~~~~~~~~\n\nFollowing option is required:\n\n* ``state_file``: path to daemon database. Must be in persistent storage.\n\nExample::\n\n    [general]\n    state_file = /var/lib/awslogs-sd/state\n\n``include``\n~~~~~~~~~~~\n\nOptional section with a single option:\n\n* ``path``: an Unix glob pattern to specify locations of additional\n  configuration files to load and merge with main one. Used mostly to\n  support popular ``conf.d`` drop-in pattern.\n\nExample::\n\n    [include]\n    path = /etc/awslogs-sd.conf.d/*.conf\n\nUnit sections\n~~~~~~~~~~~~~\n\nExample::\n\n    [httpd_error]\n    unit = httpd.service\n    priority = ERR\n    syslog_ident = httpd_error\n    syslog_facility = local1\n    log_group_name = httpd-access\n    log_stream_name = {instance_id}\n\nFollowing options are supported:\n\n* ``unit`` (required): systemd unit name\n\n* ``log_group_name`` (required): destination CloudWatch log group\n\n* ``log_stream_name`` (required): CloudWatch stream name inside group;\n  support basic variable interpolation (see below)\n\n* ``priority``: minimum journal priority to match (default:\n  ``INFO``). See `Arch wiki`_.\n\n* ``format``: output log format, one of ``text`` or ``json`` (default:\n  ``text``)\n\n* ``datetime_format``: datetime format in strftime format if text\n  output is used (default: ``%b %d %H:%M:%S``)\n\n* ``syslog_ident``: match by syslog ident (aka \"tag\") if syslog\n  transport is used\n\n* ``syslog_facility``: match by syslog facility if syslog transport is\n  used\n\n.. _Arch wiki: https://wiki.archlinux.org/index.php/systemd#Journal\n\nStream name variables\n~~~~~~~~~~~~~~~~~~~~~\n\nStream names support variable interpolation with ``{var}``\nsyntax. Following variables are available:\n\n* ``instance_id``: local EC2 instance id\n\n* ``hostname``: machine hostname\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbachry%2Fawslogs-sd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbachry%2Fawslogs-sd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbachry%2Fawslogs-sd/lists"}