CallsiteParameterAdder does not respect stacklevel

[fraser-langton]

Been playing around with a bunch of configs trying to get stacklevel to work, but CallsiteParameterAdder doesn't use it, which is a little annoying and defeats the purpose of stacklevel

import logging

import structlog

structlog.configure(
    processors=[
        structlog.stdlib.render_to_log_args_and_kwargs,
    ],
    logger_factory=structlog.stdlib.LoggerFactory(),
    wrapper_class=structlog.stdlib.BoundLogger,
    cache_logger_on_first_use=True,
)

formatter = structlog.stdlib.ProcessorFormatter(
    fmt="%(asctime)s - %(name)s - %(levelname)s - %(funcName)s - %(message)s",
    processors=[
        structlog.processors.CallsiteParameterAdder(
            {
                structlog.processors.CallsiteParameter.FUNC_NAME,
            },
        ),
        structlog.stdlib.ProcessorFormatter.remove_processors_meta,
        structlog.processors.KeyValueRenderer(),
    ],
)
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logging.basicConfig(level=logging.INFO, handlers=[handler])


logger = structlog.get_logger()
stdlib_logger = logging.getLogger()


def func1():
    logger.info("structlog_message", stacklevel=2)
    stdlib_logger.info("stdlib_message", stacklevel=2)


def func2():
    func1()


func2()

[hynek]

hopefully fixed by #763

[fraser-langton]

@hynek noticed that it doesn't work with structlog.stdlib.ProcessorFormatter.wrap_for_formatter

import logging

import structlog

structlog.configure(
    # processors=[structlog.stdlib.ProcessorFormatter.wrap_for_formatter],  # swap to this and doesn't work
    processors=[structlog.stdlib.render_to_log_args_and_kwargs],
    logger_factory=structlog.stdlib.LoggerFactory(),
    wrapper_class=structlog.stdlib.BoundLogger,
    cache_logger_on_first_use=True,
)

formatter = structlog.stdlib.ProcessorFormatter(
    fmt="%(message)s",
    processors=[
        structlog.processors.CallsiteParameterAdder(
            {
                structlog.processors.CallsiteParameter.FUNC_NAME,
                structlog.processors.CallsiteParameter.PATHNAME,
                structlog.processors.CallsiteParameter.LINENO,
            }
        ),
        structlog.stdlib.ProcessorFormatter.remove_processors_meta,
        structlog.processors.KeyValueRenderer(),
    ],
)
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logging.basicConfig(level=logging.INFO, handlers=[handler])


logger = structlog.get_logger()
stdlib_logger = logging.getLogger()


def func1():
    logger.info("structlog_message")
    stdlib_logger.info("stdlib_message")
    logger.info("structlog_message", stacklevel=2)
    stdlib_logger.info("stdlib_message", stacklevel=2)


def func2():
    func1()


def func3():
    func2()


func3()

✅ structlog.stdlib.render_to_log_args_and_kwargs

event='structlog_message' lineno=36 func_name='func1'
event='stdlib_message' lineno=37 func_name='func1'
event='structlog_message' lineno=43 func_name='func2'
event='stdlib_message' lineno=43 func_name='func2'

❌ structlog.stdlib.ProcessorFormatter.wrap_for_formatter

event='structlog_message' lineno=38 func_name='func1'
event='stdlib_message' lineno=39 func_name='func1'
stacklevel=2 event='structlog_message' lineno=40 func_name='func1'
event='stdlib_message' lineno=45 func_name='func2'

[hynek]

I believe that's a case of #537 (comment) – right?