Metadata-Version: 1.0
Name: Elasticsearch-Raven
Version: 1.2
Summary: Proxy that allows to send logs from Raven to Elasticsearch.
Home-page: https://github.com/pozytywnie/elasticsearch-raven/
Author: Tomasz Wysocki
Author-email: tomasz@pozytywnie.pl
License: MIT
Description: elasticsearch-raven
        ===================
        
        |Build Status|
        
        Proxy that allows to log from raven to elasticsearch.
        
        Installation
        ------------
        
        Package
        ~~~~~~~
        
        elasticsearch-raven can be installed as a normal Python package. Example
        installation for pip:
        
        ::
        
            $ pip install elasticsearch-raven
        
        Configuration
        -------------
        
        settings.py
        ~~~~~~~~~~~
        
        Configure Ravan to your proxy location
        
        ::
        
            RAVEN_CONFIG = {
                'dsn': 'protocol://public:secret@host:port/index',
            }
        
        public:secret is required by Raven, for valid Sentry dsn pattern, but it
        doesn't affect log sending.
        
        Indexes are formatted with actual date. Suggested format:
        
        **basic-index-{0:%Y.%m.%d}** will result in **basic-index-YYYY.MM.DD**
        
        Environment Variables
        ~~~~~~~~~~~~~~~~~~~~~
        
        Define elasticsearch location by setting environment variable
        ELASTICSEARCH\_HOST (default: 'localhost:9200')
        
        ::
        
            export ELASTICSEARCH_HOST='localhost:9100'
        
        If you use your elasticsearch with https protocol, you should set
        environment variable USE\_SSL to True
        
        ::
        
            export USE_SSL=True
        
        To use http authentication just set ELASTICSEARCH\_AUTH variable using
        'login:password' format
        
        ::
        
            export ELASTICSEARCH_AUTH=login:password
        
        Usage
        -----
        
        Option 1: wsgi
        ~~~~~~~~~~~~~~
        
        You can run wsgi.py with any http server that supports wsgi. Example
        using python simple HTTP server.
        
        ::
        
             #!/usr/bin/env python
             from elasticsearch_raven.wsgi import application
             from wsgiref.simple_server import make_server
        
             httpd = make_server('', 8000, application)
             httpd.serve_forever()
        
        Option 2: UDP server
        ~~~~~~~~~~~~~~~~~~~~
        
        You can run udp server with command:
        
        ::
        
            elasticsearch-raven.py host port
        
        .. |Build Status| image:: https://travis-ci.org/pozytywnie/elasticsearch-raven.svg?branch=master
           :target: https://travis-ci.org/pozytywnie/elasticsearch-raven
        
Platform: UNKNOWN
