Python logging package extensions for TUNE mv-integrations.
Project description
Overview
docs |
|
---|---|
tests |
|
package |
logging-mv-integrations
logging-mv-integrations is a Python logging library for TUNE Multiverse Integrations.
Usage
Function: get_logger()
def get_logger(
logger_name,
logger_version=None,
logger_level=logging.INFO,
logger_format=LoggingFormat.JSON,
logger_output=LoggingOutput.STDOUT_COLOR,
logger_handler=None
):
Parameter |
Purpose |
---|---|
logger_name |
Return a logger with the specified name or, if name is None, return a logger which is the root logger of the hierarchy. |
logger_version |
|
logger_format |
LoggingFormat |
logger_output |
LoggingOutput |
logger_handler |
logging.StreamHandler() or logging.FileHandler() |
Logging Levels
Same logging levels, however, including one additional level NOTE.
Level |
When it’s used |
---|---|
DEBUG |
Detailed information, typically of interest only when diagnosing problems. |
NOTE |
Detailed information, request processing, for example, request using cURL |
INFO |
Confirmation that things are working as expected. [DEFAULT] |
WARNING |
An indication that something unexpected happened, or indicative of some problem in the near future. The software is still working as expected. |
ERROR |
Due to a more serious problem, the software has not been able to perform some function. |
CRITICAL |
A serious error, indicating that the program itself may be unable to continue running. |
Logging Format
Format |
Purpose |
---|---|
STANDARD |
Standard logging format. |
JSON |
JSON logging format. [DEFAULT] |
class LoggingFormat(object):
"""TUNE Logging Format ENUM
"""
STANDARD = "standard"
JSON = "json"
Logging Output
Output |
Purpose |
---|---|
STDOUT |
Standard Output to terminal |
STDOUT_COLOR |
Standard Output using colored terminal |
FILE |
Standard Output to file created within ./tmp/log_<epoch time seconds>.json. |
class LoggingOutput(object):
"""TUNE Logging Output ENUM
"""
STDOUT = "stdout"
STDOUT_COLOR = "color"
FILE = "file"
Example: Logging JSON Format
import logging
from logging_mv_integrations import (LoggingFormat, get_logger, __version__)
log = get_logger(
logger_name=__name__,
logger_version=__version__,
logger_format=LoggingFormat.JSON,
logger_level=logging.NOTE
)
log.info("logging: info", extra={'test': __name__})
log.note("logging: note", extra={'test': __name__})
log.debug("logging: debug", extra={'test': __name__})
log.warning("logging: warning", extra={'test': __name__})
log.error("logging: error", extra={'test': __name__})
log.critical("logging: critical", extra={'test': __name__})
log.exception("logging: exception", extra={'test': __name__})
python3 examples/example_logging_json.py
{“asctime”: “2017-10-20 08:31:14 -0700”, “levelname”: “INFO”, “name”: “__main__”, “version”: “0.1.6”, “message”: “logging: info”, “test”: “__main__”} {“asctime”: “2017-10-20 08:31:14 -0700”, “levelname”: “NOTE”, “name”: “__main__”, “version”: “0.1.6”, “message”: “logging: note”, “test”: “__main__”} {“asctime”: “2017-10-20 08:31:14 -0700”, “levelname”: “WARNING”, “name”: “__main__”, “version”: “0.1.6”, “message”: “logging: warning”, “test”: “__main__”} {“asctime”: “2017-10-20 08:31:14 -0700”, “levelname”: “ERROR”, “name”: “__main__”, “version”: “0.1.6”, “message”: “logging: error”, “test”: “__main__”} {“asctime”: “2017-10-20 08:31:14 -0700”, “levelname”: “CRITICAL”, “name”: “__main__”, “version”: “0.1.6”, “message”: “logging: critical”, “test”: “__main__”} {“asctime”: “2017-10-20 08:31:14 -0700”, “levelname”: “ERROR”, “name”: “__main__”, “version”: “0.1.6”, “message”: “logging: exception”, “exc_info”: “NoneType: None”, “test”: “__main__”}
Dependencies
logging-mv-integrations module is built upon Python 3 and is build upon several custom modules that are held within PyPI: https://pypi.python.org/pypi
make install-requirements
or
python3 -m pip uninstall --yes --no-input -r requirements.txt
python3 -m pip install --upgrade -r requirements.txt
TUNE Multiverse Custom Support Packages
These packages provide support functionality but are not core to Multiverse. Thereby, test and documentation could be shared amongst the team.
safe-cast: https://pypi.python.org/pypi/safe-cast
Support Packages
coloredlogs: https://pypi.python.org/pypi/coloredlogs
pprintpp: https://pypi.python.org/pypi/pprintpp
python-json-logger: https://pypi.python.org/pypi/python-json-logger
Pygments: https://pypi.python.org/pypi/Pygments
Release History
0.1.6 (2017-10-19)
Logging Output: FILE, STDOUT, STDOUT_COLOR
0.1.5 (2017-10-17)
Fix standard format
0.1.4 (2017-10-09)
Multiple handlers fix
0.1.3 (2017-09-12)
Use python standard logging instead of tune_logging and remove all unneeded files
0.1.2 (2017-02-03)
Switch to using casting from safe-cast package
0.1.1 (2017-02-03)
Python 3.6 Upgrade
0.0.1 (2016-11-19)
First Commit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for logging-mv-integrations-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0192b7eb9d5904d97dce73697f7aa02d2e577e6f8d2ebec2fdf62189794cc54 |
|
MD5 | 6f27463d581a9de0cc107879f975c632 |
|
BLAKE2b-256 | 4bdc03699e75cb5498950d33504a19c9ae38d00039da55328ec1e8a54a841a88 |
Hashes for logging_mv_integrations-0.1.6-py3.6.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | fff76d9cb25235798f6086d2e48804ba27aa328e36888e61d747924dca20b6db |
|
MD5 | 2be0dd7c753feea79322f35f31b04f23 |
|
BLAKE2b-256 | 7b4ff8f2a1137b9a072fe2008285495f8890d17c5cdfc28f2557c02e1d224b2a |
Hashes for logging_mv_integrations-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a002fd3b1c4f4a6377a61e66fe5ed72f205028f5b2d0f9f22563e553bee54532 |
|
MD5 | 9cf146ae7eb405786720f6a78c7ddea4 |
|
BLAKE2b-256 | ec3b29d5f2833976e1c33a97abfd8e5265e51904c5614537d53e6c82a8269c3c |