The Logz.io Python Handler

This is a Python handler that sends logs in bulk over HTTPS to Logz.io.The handler uses a subclass named LogzioSender (which can be used without this handler as well, to ship raw data).The LogzioSender class opens a new Thread, that consumes from the logs queue. Each iteration (its frequency of which can be configured by the logs_drain_timeout parameter), will try to consume the queue in its entirety.Logs will get divided into separate bulks, based on their size.LogzioSender will check if the main thread is alive. In case the main thread quits, it will try to consume the queue one last time, and then exit. So your program can hang for a few seconds, until the logs are drained.In case the logs failed to be sent to Logz.io after a couple of tries, they will be written to the local file system. You can later upload them to Logz.io using curl.

Installation

pip install logzio-python-handler

Tested Python Versions

Travis CI will build this handler and test against:

• "3.5"
• "3.6"
• "3.7"
• "3.8"
• "3.9"

We can't ensure compatibility to any other version, as we can't test it automatically.

To run tests:

$ pip install tox$ tox...

Python configuration

Config File

[handlers]keys=LogzioHandler[handler_LogzioHandler]class=logzio.handler.LogzioHandlerformatter=logzioFormatargs=('token', 'my_type')[formatters]keys=logzioFormat[loggers]keys=root[logger_root]handlers=LogzioHandlerlevel=INFO[formatter_logzioFormat]format={"additional_field": "value"}

args=() arguments, by order

• Your logz.io token
• Log type, for searching in logz.io (defaults to "python")
• Time to sleep between draining attempts (defaults to "3")
• Logz.io Listener address (defaults to "https://listener.logz.io:8071")
• Debug flag. Set to True, will print debug messages to stdout. (defaults to "False")
• Backup logs flag. Set to False, will disable the local backup of logs in case of failure. (defaults to "True")
• Network timeout, in seconds, int or float, for sending the logs to logz.io. (defaults to 10)
• Retries number (retry_no, defaults to 4).
• Retry timeout (retry_timeout) in seconds (defaults to 2).

Please note, that you have to configure those parameters by this exact order.i.e. you cannot set Debug to true, without configuring all of the previous parameters as well.

Dict Config

LOGGING = {    'version': 1,    'disable_existing_loggers': False,    'formatters': {        'logzioFormat': {            'format': '{"additional_field": "value"}',            'validate': False        }    },    'handlers': {        'logzio': {            'class': 'logzio.handler.LogzioHandler',            'level': 'INFO',            'formatter': 'logzioFormat',            'token': '<<LOGZIO-TOKEN>>',            'logzio_type': 'python-handler',            'logs_drain_timeout': 5,            'url': 'https://<<LOGZIO-URL>>:8071',            'retries_no': 4,            'retry_timeout': 2,        }    },    'loggers': {        '': {            'level': 'DEBUG',            'handlers': ['logzio'],            'propagate': True        }    }}

Replace:

• <> - your logz.io account token.
• <> - logz.io url, as described here.

Serverless platforms

If you're using a serverless function, you'll need to import and add the LogzioFlusher annotation before your sender function. To do this, in the code sample below, uncomment the import statement and the @LogzioFlusher(logger) annotation line.
Note: For the LogzioFlusher to work properly, you'll need to make sure that the Logz.io. handler is added to the root logger. See the configuration above for an example.

Code Example

import loggingimport logging.config# If you're using a serverless function, uncomment.# from logzio.flusher import LogzioFlusher# Say I have saved my dictionary configuration in a variable named 'LOGGING' - see 'Dict Config' sample sectionlogging.config.dictConfig(LOGGING)logger = logging.getLogger('superAwesomeLogzioLogger')# If you're using a serverless function, uncomment.# @LogzioFlusher(logger)def my_func():    logger.info('Test log')    logger.warn('Warning')    try:        1/0    except:        logger.exception("Supporting exceptions too!")

Extra Fields

In case you need to dynamic metadata to your logger, other then the constant metadata from the formatter, you can use the "extra" parameter.All key values in the dictionary passed in "extra" will be presented in Logz.io as new fields in the log you are sending.Please note, that you cannot override default fields by the python logger (i.e. lineno, thread, etc..)For example:

logger.info('Warning', extra={'extra_key':'extra_value'})

Django configuration

LOGGING = {    'version': 1,    'disable_existing_loggers': False,    'formatters': {        'verbose': {            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'        },        'logzioFormat': {            'format': '{"additional_field": "value"}'        }    },    'handlers': {        'console': {            'class': 'logging.StreamHandler',            'level': 'DEBUG',            'formatter': 'verbose'        },        'logzio': {            'class': 'logzio.handler.LogzioHandler',            'level': 'INFO',            'formatter': 'logzioFormat',            'token': 'token',            'logzio_type': "django",            'logs_drain_timeout': 5,            'url': 'https://listener.logz.io:8071',            'debug': True,            'network_timeout': 10,        },    },    'loggers': {        'django': {            'handlers': ['console', ],            'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO')        },        'appname': {            'handlers': ['console', 'logzio'],            'level': 'INFO'        }    }}

Change

• token - Your logzio token
• url - Logz.io Listener address
• logs_drain_count - Number of logs to keep in buffer before draining
• logs_drain_timeout - Time to wait before draining, regardless of the previouse setting
• logzio_type - Log type, for searching in logz.io (defaults to "python"), it cannot contain a space.
• appname - Your django app

Trace context

If you're sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context.That way, your logs will have traces data in it, such as service name, span id and trace id.To enable this feature, set the add_context param in your handler configuration to True, like in this example:

LOGGING = {    'version': 1,    'disable_existing_loggers': False,    'formatters': {        'logzioFormat': {            'format': '{"additional_field": "value"}',            'validate': False        }    },    'handlers': {        'logzio': {            'class': 'logzio.handler.LogzioHandler',            'level': 'INFO',            'formatter': 'logzioFormat',            'token': '<<LOGZIO-TOKEN>>',            'logzio_type': 'python-handler',            'logs_drain_timeout': 5,            'url': 'https://<<LOGZIO-URL>>:8071',            'retries_no': 4,            'retry_timeout': 2,            'add_context': True        }    },    'loggers': {        '': {            'level': 'DEBUG',            'handlers': ['logzio'],            'propagate': True        }    }}

Please note that if you are using python 3.8, it is preferred to use the logging.config.dictConfig method, as mentioned in python's documentation.

Release Notes

• 4.0.0

  • Add ability to automatically attach trace context to the logs.

• 3.1.1

  • Bug fixes (issue #68, exception message formatting)
  • Added CI: Tests and Auto release

• 3.1.0

  • Bug fixes
  • Retry number and timeout is now configurable