Add dynamic log level (!1)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing

Reviewed-on: #1
This commit is contained in:
Kim Oliver Drechsel 2022-08-13 12:30:20 +02:00
parent ee25613eda
commit 16820fa083
3 changed files with 67 additions and 21 deletions

View File

@ -6,16 +6,18 @@ workspace:
path: /drone/src path: /drone/src
steps: steps:
- name: test with DEBUG_MODE - name: LOG_LEVEL var set to debug
image: python:alpine depends_on:
- clone
image: python:3.10-alpine
pull: if-not-exists pull: if-not-exists
environment: environment:
DEBUG_MODE: 'True' LOG_LEVEL: 'debug'
TZ: 'Europe/Berlin' TZ: 'Europe/Berlin'
commands: commands:
- apk --no-cache add gcc musl-dev tzdata - apk --no-cache add gcc musl-dev tzdata
- pip3 install --no-cache-dir -r requirements.txt - pip3 install --no-cache-dir -r requirements.txt
- echo "$DEBUG_MODE" - echo "$LOG_LEVEL"
- | - |
python3 -c 'from loghandler import logger; python3 -c 'from loghandler import logger;
def main(): def main():
@ -27,16 +29,40 @@ steps:
main()' main()'
- name: test without DEBUG_MODE - name: LOG_LEVEL var set to warning
image: python:alpine depends_on:
- clone
image: python:3.10-alpine
pull: if-not-exists pull: if-not-exists
environment: environment:
DEBUG_MODE: 'False' LOG_LEVEL: 'warning'
TZ: 'Europe/Berlin' TZ: 'Europe/Berlin'
commands: commands:
- apk --no-cache add gcc musl-dev tzdata - apk --no-cache add gcc musl-dev tzdata
- pip3 install --no-cache-dir -r requirements.txt - pip3 install --no-cache-dir -r requirements.txt
- echo "$DEBUG_MODE" - echo "$LOG_LEVEL"
- |
python3 -c 'from loghandler import logger;
def main():
logger.debug("This is a Debug Message")
logger.info("This is a Info Message")
logger.warning("This is a Warning Message")
logger.error("This is a Error Message")
logger.critical("This is a Critical Message")
main()'
- name: Unset LOG_LEVEL var
depends_on:
- clone
image: python:3.10-alpine
pull: if-not-exists
environment:
TZ: 'Europe/Berlin'
commands:
- apk --no-cache add gcc musl-dev tzdata
- pip3 install --no-cache-dir -r requirements.txt
- echo "$LOG_LEVEL"
- | - |
python3 -c 'from loghandler import logger; python3 -c 'from loghandler import logger;
def main(): def main():

View File

@ -4,15 +4,27 @@
Simple logger class with colored LogLevel designed to run inside Docker container Simple logger class with colored LogLevel designed to run inside Docker container
> Debug can be enabled by setting the environment variable > Use the environment variable `LOG_LEVEL` to set the log level.
> >
> **DEBUG_MODE** = *True* > **LOG_LEVEL** = *debug*
## Possible values
Values can be set case insensitive (DEBUG, debug, Debug).
- debug
- info
- warn
- warning
- crit
- critical
## Requirements
- Python 3.10 or higher
## Usage example ## Usage example
```python ```python
# Usage with os only necessary if environment variable has not been set before (e.g. outside Docker) # Setting LOG_LEVEL with `os.environ` is only necessary if environment variable has not been set before (e.g. outside Docker)
import os import os
os.environ['DEBUG_MODE'] = 'True' os.environ['LOG_LEVEL'] = 'DEBUG'
from loghandler import logger from loghandler import logger

View File

@ -6,18 +6,26 @@ import colorlog
def loghandler(): def loghandler():
debug_mode = os.getenv('DEBUG_MODE', "False")
if debug_mode.lower() == "false":
debug_mode = False
_logger = colorlog.getLogger(__name__) _logger = colorlog.getLogger(__name__)
if debug_mode:
_logger.setLevel(logging.DEBUG) loglevel = os.getenv('LOG_LEVEL', "INFO")
else:
_logger.setLevel(logging.INFO) match loglevel.lower():
case "debug":
_logger.setLevel(logging.DEBUG)
case "info":
_logger.setLevel(logging.INFO)
case "warn" | "warning":
_logger.setLevel(logging.WARNING)
case "error":
_logger.setLevel(logging.ERROR)
case "crit" | "critical":
_logger.setLevel(logging.CRITICAL)
case _:
raise ValueError("Definied value of LOG_LEVEL is not known. Possible values are debug, info, warn, warning, error, crit and critical.")
handler = colorlog.StreamHandler(sys.stdout) handler = colorlog.StreamHandler(sys.stdout)
if debug_mode: if loglevel:
handler.setLevel(logging.DEBUG) handler.setLevel(logging.DEBUG)
else: else:
handler.setLevel(logging.INFO) handler.setLevel(logging.INFO)