• Add a PEP 561 marker
• Add basic mypy configuration
• Run mypy from tox
• Minor code modifications to make mypy happy

This is intended to be a relatively minimal change just to enable basic type checking. Future changes should fill out the type annotations more and enable stricter mypy configuration (set all mypy options to 'true').

This change is a small step towards https://github.com/madzak/python-json-logger/issues/118

Note that the marker is intentionally not shipped via setup.py -- the annotations need more cleanup first (turn on a few key mypy config options, e.g. no-untyped-defs).

Jsonformatter will not format the newline character that is inside the message fields too.

Ex: without this commit { "rid": "6c0320a4-ed87-4d0a-a668-b7ceef94eecf", "asctime": "2021-03-23 14:13:50,151", "filename": "", "module": "", "funcName": "", "lineno": 16, "levelname": "INFO", "message": "log line 1\nlog line 2" }

After this commit { "rid": "6c0320a4-ed87-4d0a-a668-b7ceef94eecf", "asctime": "2021-03-23 14:13:50,151", "filename": "", "module": "", "funcName": "", "lineno": 16, "levelname": "INFO", "message": "log line 1 log line 2" }

This encompasses #39 and #40 with the "addition" of removing Python 2.6 from the list of allowed failures. Merging this in will close those too.

Hello.

I'm trying to use this module to format django's log. The problem I'm having is that the full message of the stack trace when there's an exception, including the actual Exception name and message, is not showing up in my log files.

Any idea for how I might fix this?

To allow for typing annotations and enforcement of typing annotations, we need to:

• Drop Python 3.5 support since it doesn't support the syntax
• Drop pypy 3.6 support since it doesn't support mypy

See https://github.com/madzak/python-json-logger/pull/129#issuecomment-1030708627 for additional background.

See #86 See #74

This PR fixes up a couple of small issues encountered when upgrading to Python 3.8:

• updates examples in README.md to be compatible with Python 3.8
• updates test code to match the formatting example provided in the readme
• adds Python 3.8 testing to Travis and tox
• marks the package as Python 3.8 compatible in setup.py

It seems like with Python 3.8 the format string needs to be specified differently.

I have this small test setup:

This is test.py:

import os
import logging
from pythonjsonlogger import jsonlogger

logger = logging.getLogger()
logHandler = logging.StreamHandler()
formatter = jsonlogger.JsonFormatter("(levelname) (name) (message)")
logHandler.setFormatter(formatter)
logger.handlers = [logHandler]
logger.setLevel(logging.INFO)

logger.info("Hello world")

and this Dockerfile:

FROM python:3.7
RUN pip install python-json-logger
COPY test.py .
CMD ["python", "test.py"]

If I run docker build -t test . && docker run -it test it works as expected, the output is {"levelname": "INFO", "name": "root", "message": "Hello world"}.

Under Python 3.8 this results in ValueError: Invalid format '(levelname) (name) (message)' for '%' style. I have to change the format line to read formatter = jsonlogger.JsonFormatter("%(levelname) %(name) %(message)"). I'm not sure if this is expected, but it might (at least) warrant an update of the documentation.

Thanks for the nice library ! I tried your example which is given in the readme section. It's working fine.

My problem is I am using logging.FileHandler('reuben.json') to write the dump in a file. What happening is every time a log message is entering as a separate entry instead of an item of a list or dictionary.

Is it possible to create the json in the given below format :

log.error({"host": "host1", "message": "Failed to install"})
log.info({"host": "host2", "message": "successfully installed"})

json :

[{"host": "host1", "message": "Failed to install"}, {"host": "host2", "message": "successfully installed"}]

One more thing related to https://github.com/madzak/python-json-logger/issues/16: I just noticed that while process_log_record returns the log_record, that returned value isn't actually stored in a variable. By making the change in this commit, the user can use two approaches in process_log_record in a subclass to modify the log_record:

• modify the given log_record in process_log_record (in-place) and return that,
• or, use the given log_record to compute an entirely new dictionary instance and return that instead.

Hello @madzak.

The readme says:

NOTICE: Python2.7 is only supported up to v0.1.11. The next release, v2.0, will support Python3 only

Python 2 is unsupported since 1st Jan 2020. Is there any roadmap for 2.0 or could you just make a new release supporting only Python3?

Thanks!

1. Removed setuptools from requirements. Fix #58
2. Fix flake8 warnings in setup.py
3. Improve python version checks as recommend in setuptools documentation

+ /usr/bin/pytest -ra
=========================================================================== test session starts ============================================================================
platform linux -- Python 3.8.15, pytest-7.2.0, pluggy-1.0.0
rootdir: /home/tkloczko/rpmbuild/BUILD/python-json-logger-2.0.4
collected 0 items

========================================================================== no tests ran in 0.01s ===========================================================================

However

+ /usr/bin/pytest -ra tests/tests.py
=========================================================================== test session starts ============================================================================
platform linux -- Python 3.8.15, pytest-7.2.0, pluggy-1.0.0
rootdir: /home/tkloczko/rpmbuild/BUILD/python-json-logger-2.0.4
collected 16 items

tests/tests.py ................                                                                                                                                      [100%]

============================================================================ 16 passed in 0.03s ============================================================================

pytest automacically scans tests_*.py files so tests/tests.py should be renamed to fix this.

Hello, this isn't an issue, but wanted to know if there was an easier way to call Message instead of message or do we have to go the CustomJsonFormatter class route? For example, how to change the message here

formatter = jsonlogger.JsonFormatter("%(asctime)s %(filename)s %(module)s %(funcName)s %(lineno)s %(message)s")

to Message, because changing it directly in this line of code wouldn't work?

Thank you.

With this patch we can do something like this:

    formatter = jsonlogger.JsonFormatter(dict_as_object=True)
    # ...
    my_dict = {
        "result": 0,
        "text": "some text",
    }
    logger.info("Just text")
    logger.info(my_dict)

Output:

{
  "message": "Just text"
}
{
  "message": {
    "result": 0,
    "text": "some text",
  }
}

While browsing the code, I realized that some code is written with python2 in mind (especially the test). python2 is not supported since January 2020 (https://www.python.org/doc/sunset-python-2/).

I'd also suggest changing the packaging of this library to drop the support of python3.5 (EOL 2020-09-13) and python3.6 (EOL 2021-12-23) (source: https://endoflife.date/python)

Some guidance can be found here: https://packaging.python.org/en/latest/guides/dropping-older-python-versions/

Currently, I am writing a custom formatter to include all fields with the intention of adding some of my own later.

I have two sets of questions

Q1 : Is this the correct way? i.e. subclass the formatter and than copying field by field over ? or am I going about it the wrong way ?

Ultimately, I will want to include most of the default fields plus I am going to add some custom in-house fields.

class CustomJsonFormatter(jsonlogger.JsonFormatter):
    
    def add_fields(self, log_record, record, message_dict):
        import datetime
        super(CustomJsonFormatter, self).add_fields(log_record, record, message_dict)

        log_record['args'] = record.args
        # log_record['asctime'] = record.asctime
        log_record['created'] = record.created
        log_record['exc_info'] = record.exc_info
        log_record['exc_text'] = record.exc_text
        log_record['filename'] = record.filename
        log_record['funcName'] = record.funcName
        log_record['levelname'] = record.levelname
        log_record['levelno'] = record.levelno
        log_record['lineno'] = record.lineno
        log_record['module'] = record.module
        log_record['msecs'] = record.msecs
        log_record['message'] = record.message
        log_record['msg'] = record.msg
        log_record['name'] = record.name
        log_record['pathname'] = record.pathname
        log_record['process'] = record.process
        log_record['processName'] = record.processName
        log_record['relativeCreated'] = record.relativeCreated
        log_record['stack_info'] = record.stack_info
        log_record['thread'] = record.thread
        log_record['threadName'] = record.threadName

Q2 : What if I want most but not all the default fields, is there some pythonic way to do that ?