Metadata-Version: 1.1
Name: watchtower
Version: 0.3.3
Summary: Python CloudWatch Logging
Home-page: https://github.com/kislyuk/watchtower
Author: Andrey Kislyuk
Author-email: kislyuk@gmail.com
License: Apache Software License
Description: Watchtower: Python CloudWatch Logging
        =====================================
        Watchtower is a log handler for `Amazon Web Services CloudWatch Logs
        <https://aws.amazon.com/blogs/aws/cloudwatch-log-service/>`_.
        
        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
        <https://docs.python.org/library/logging.html>`_ and CloudWatch Logs. It uses the `boto3 AWS SDK
        <https://github.com/boto/boto3>`_, and lets you plug your application logging directly into CloudWatch without the need
        to install a system-wide log collector like `awscli-cwlogs <https://pypi.python.org/pypi/awscli-cwlogs>`_ and round-trip
        your logs through the instance's syslog. 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 <https://pypi.python.org/pypi/awscli>`_ and set your AWS credentials (run ``aws configure``).
        
        .. code-block:: python
        
            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
        <https://console.aws.amazon.com/cloudwatch/home>`_.
        
        Example: Flask logging with Watchtower
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code-block:: python
        
            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/ <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
        <http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/FilterAndPatternSyntax.html>`_, 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
        
        Links
        -----
        * `Project home page (GitHub) <https://github.com/kislyuk/watchtower>`_
        * `Documentation (Read the Docs) <https://watchtower.readthedocs.io/en/latest/>`_
        * `Package distribution (PyPI) <https://pypi.python.org/pypi/watchtower>`_
        * `AWS CLI CloudWatch Logs plugin <https://pypi.python.org/pypi/awscli-cwlogs>`_
        * `Docker awslogs adapter <https://github.com/docker/docker/blob/master/daemon/logger/awslogs/cloudwatchlogs.go>`_
        
        Bugs
        ~~~~
        Please report bugs, issues, feature requests, etc. on `GitHub <https://github.com/kislyuk/watchtower/issues>`_.
        
        License
        -------
        Licensed under the terms of the `Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_.
        
        .. image:: https://travis-ci.org/kislyuk/watchtower.svg
                :target: https://travis-ci.org/kislyuk/watchtower
        .. image:: https://codecov.io/github/kislyuk/watchtower/coverage.svg?branch=master
                :target: https://codecov.io/github/kislyuk/watchtower?branch=master
        .. image:: https://img.shields.io/pypi/v/watchtower.svg
                :target: https://pypi.python.org/pypi/watchtower
        .. image:: https://img.shields.io/pypi/dm/watchtower.svg
                :target: https://pypi.python.org/pypi/watchtower
        .. image:: https://img.shields.io/pypi/l/watchtower.svg
                :target: https://pypi.python.org/pypi/watchtower
        .. image:: https://readthedocs.org/projects/watchtower/badge/?version=latest
                :target: https://watchtower.readthedocs.io/
        
Platform: MacOS X
Platform: Posix
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
