Skip to main content

Python CloudWatch Logging

Project description

Watchtower is a log handler for Amazon Web Services CloudWatch Logs.

CloudWatch Logs is a log management service built into AWS. It is conceptually similar to services like Splunk and Loggly, but is more lightweight, cheaper, and tightly integrated with the rest of AWS.

Watchtower, in turn, is a lightweight adapter between the Python logging system and CloudWatch Logs. It uses the boto3 AWS SDK, and lets you plug your application logging directly into CloudWatch without the need to install a system-wide log collector. It aggregates logs into batches to avoid sending an API request per each log message, while guaranteeing a delivery deadline (60 seconds by default).

Installation

pip install watchtower

Synopsis

Install awscli and set your AWS credentials (run aws configure).

import watchtower, logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)
logger.addHandler(watchtower.CloudWatchLogHandler())
logger.info("Hi")
logger.info(dict(foo="bar", details={}))

After running the example, you can see the log output in your AWS console.

Example: Flask logging with Watchtower

import watchtower, flask, logging

logging.basicConfig(level=logging.INFO)
app = flask.Flask("loggable")
handler = watchtower.CloudWatchLogHandler()
app.logger.addHandler(handler)
logging.getLogger("werkzeug").addHandler(handler)

@app.route('/')
def hello_world():
    return 'Hello World!'

if __name__ == '__main__':
    app.run()

(See also http://flask.pocoo.org/docs/errorhandling/.)

Examples: Querying CloudWatch logs

This section is not specific to Watchtower. It demonstrates the use of awscli and jq to read and search CloudWatch logs on the command line.

For the Flask example above, you can retrieve your application logs with the following two commands:

aws logs get-log-events --log-group-name watchtower --log-stream-name loggable | jq '.events[].message'
aws logs get-log-events --log-group-name watchtower --log-stream-name werkzeug | jq '.events[].message'

CloudWatch Logs supports alerting and dashboards based on metric filters, which are pattern rules that extract information from your logs and feed it to alarms and dashboard graphs. The following example shows logging structured JSON data using Watchtower, setting up a metric filter to extract data from the log stream, a dashboard to visualize it, and an alarm that sends an email:

TODO

Authors

  • Andrey Kislyuk

Bugs

Please report bugs, issues, feature requests, etc. on GitHub.

License

Licensed under the terms of the Apache License, Version 2.0.

https://travis-ci.org/kislyuk/watchtower.svg https://coveralls.io/repos/kislyuk/watchtower/badge.svg?branch=master https://img.shields.io/pypi/v/watchtower.svg https://img.shields.io/pypi/dm/watchtower.svg https://img.shields.io/pypi/l/watchtower.svg https://readthedocs.org/projects/watchtower/badge/?version=latest

Project details


Download files

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

Source Distribution

watchtower-0.1.8.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

watchtower-0.1.8-py2.py3-none-any.whl (10.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file watchtower-0.1.8.tar.gz.

File metadata

  • Download URL: watchtower-0.1.8.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for watchtower-0.1.8.tar.gz
Algorithm Hash digest
SHA256 b8889baa0cb6be7b8edf3231f4fd9f5420e0cfc14928fdaa720fa1f93749c4de
MD5 0440f5d2d320b701e8bbc2e4a15a2077
BLAKE2b-256 f0a65047fa3e6baa4ce788e04ee6b1b56c5e68cd04d2e2e07e8920c7f39ebc7c

See more details on using hashes here.

File details

Details for the file watchtower-0.1.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for watchtower-0.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c82c5a9415ca32566f6affd57ac4906e4742cde3c68791c7c0b08a3ab2060499
MD5 6df62edfd14c3383541075d0405927ae
BLAKE2b-256 60f38109d4c35222fd91961a4f5c900f6565a40200464416f9b115b483ed63cb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page