Extension to Python `logging` functionality.
Project description
logging-fortified
This Python project is an extension of the native Python component logging providing more robust message formatting for standard and JSON logging output, and in addtion allowing for extra content populated as dictionaries.
Important Note
This Python project is a refactoring of logging-mv-integrations for the purpose of general usage intent.
Work In Progress
The following still needs to be performed for this Python project:
Unit-testing: This project will be switching over to using Python native Unit testing framework unittest.
More concise documentation is required.
Travis CI
Badges
Badges
docs |
|
|---|---|
package |
|
Install
pip install logging_fortifiedArchitecture
logging-fortified is an extension of the logging facility for Python used for providing custom logger levels, format, and output.
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
):get_logger(): Parameters
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 Python logging levels, including one additional level NOTE.
Level |
Purpose |
|---|---|
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):
"""Logging Format ENUM
"""
STDOUT = "stdout"
STDOUT_COLOR = "color"
FILE = "file"Logging JSON Format
import logging
from logging_fortified 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__})Logging JSON Example Output
$ python3 examples/example_logging_json.py
{"asctime": "2018-05-11 05:41:39 -0700", "levelname": "INFO", "name": "__main__",
"version": "0.1.6", "message": "logging: info", "test": "__main__"}
{"asctime": "2018-05-11 05:41:39 -0700", "levelname": "NOTE", "name": "__main__",
"version": "0.1.6", "message": "logging: note", "test": "__main__"}
{"asctime": "2018-05-11 05:41:39 -0700", "levelname": "WARNING", "name": "__main__",
"version": "0.1.6", "message": "logging: warning", "test": "__main__"}
{"asctime": "2018-05-11 05:41:39 -0700", "levelname": "ERROR", "name": "__main__",
"version": "0.1.6", "message": "logging: error", "test": "__main__"}
{"asctime": "2018-05-11 05:41:39 -0700", "levelname": "CRITICAL", "name": "__main__",
"version": "0.1.6", "message": "logging: critical", "test": "__main__"}
{"asctime": "2018-05-11 05:41:39 -0700", "levelname": "ERROR", "name": "__main__",
"version": "0.1.6", "message": "logging: exception", "exc_info": "NoneType: None",
"test": "__main__"}Requirements
logging-fortified module is built upon Python 3 and has dependencies upon several Python modules available within Python Package Index PyPI.
make install-requirementsor
python3 -m pip uninstall --yes --no-input -r requirements.txt
python3 -m pip install --upgrade -r requirements.txtDependencies
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
safe-cast: https://pypi.python.org/pypi/safe-cast
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 Distribution
Hashes for logging_fortified-0.1.5-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 55bcf9a9c90137b3d216ce0d797819c1179c7234e84e18c342a09ebf8d8212c7 |
|
| MD5 | a1541fe1d66d338d1ea300c35b3d6469 |
|
| BLAKE2b-256 | 6c37819b98d1f9a41d0b61fcd41c186603317011f0a6388da8d4a5f63f57ae3d |
