Metadata-Version: 2.1
Name: simpleelasticlogging
Version: 0.1.1
Summary: A logger using Elasticsearch in the background with a focus on simplicity.
Home-page: https://github.com/JustinGuese/pip-simple-elasticsearch-logging
Author: Justin Guese
Author-email: guese.justin@gmail.com
License: UNKNOWN
Description: Simple python pip package to log to elasticsearch.
        The main focus of this package is simplicity, such that errorlogging becomes super easy and needs only to be set up once. 
        
        # Install
        
        Hosted on PyPi now: https://pypi.org/project/simpleelasticlogging/
        
        So just simply run `pip install simpleelasticlogging´
        
        Bleeding Edge version: 
        
        `pip install git+https://github.com/JustinGuese/pip-simple-elasticsearch-logging´
        
        # Usage
        
        ```
        from simpleelasticlogging import ElasticLogger
        el = Elasticlogger()
        
        def boundToFail():
            array = [2, 6, "tendies"]
            for elem in array:
                try:
                    elem = elem / 2
                except Exception as e:
                    msg = {
                        "error" : repr(e),
                        "elementWhereItHappened": elem,
                        "otherNotes": "boundToFail Function"
                    }
                    el.log(msg)
                    # raise
        
        boundToFail()
        ```
        ## Elasticsearch connection
        
        The connection supports host, port, user and password for elastic. 
        
        The default values are - which can be changed:
        
        - host="localhost"
        - port=9200
        - es_user = None
        - es_pass = None
        - appname = "app"
        - errorindexname = "errors"
        
        es_user and es_pass only need to be passed if xpack security in Elasticsearch is enabled, together with the Elasticsearch user. 
        
        
        # Description
        
        The good thing with a NoSql database is, that you can basically submit anything you want to the `log()` function as it takes everything. 
        
        I created this even though other packages exist to make it even simpler to log to elastic, and to support username and password with Elasticsearch.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
