Support custom formatter for LoggingIntegration

[bityob]

Problem Statement

We use in our code custom formatter for all our logging, and we want Sentry to use it with BreadcrumbHandler.

Currently there is no such option, and the default logging.Formatter is being used.

(
In the meantime in our code, we have two optional workarounds, but there are a bit hacky.

import sentry_sdk.integrations.logging as sentry_logging
import sentry_sdk

from src import CustomFormatter

SENTRY_DSN = "..."


class BreadcrumbHandlerWithCustomFormatter(sentry_logging.BreadcrumbHandler):
    def __init__(self, level):
        super(BreadcrumbHandlerWithCustomFormatter, self).__init__(level)
        self.setFormatter(CustomFormatter())

sentry_logging.BreadcrumbHandler = BreadcrumbHandlerWithCustomFormatter

sentry_sdk.init(
    dsn=SENTRY_DSN,
    integrations=[
        sentry_logging.LoggingIntegration(),
    ],
)

from sentry_sdk.integrations.logging import LoggingIntegration
import sentry_sdk

from src import CustomFormatter

SENTRY_DSN = "..."

log_integ = LoggingIntegration()
log_integ._breadcrumb_handler.setFormatter(CustomFormatter)

sentry_sdk.init(
    dsn=SENTRY_DSN,
    integrations=[
        log_integ,
    ],
)

Solution Brainstorm

I think there are two possible options how to support it.

First, add an optional argument for LoggingIntegration to specify a formatter -

class LoggingIntegration(Integration):
    identifier = "logging"

    def __init__(self, level=DEFAULT_LEVEL, event_level=DEFAULT_EVENT_LEVEL, formatter=None):
        # type: (Optional[int], Optional[int], Optional[logging.Formatter]) -> None
        self._handler = None
        self._breadcrumb_handler = None

        if level is not None:
            self._breadcrumb_handler = BreadcrumbHandler(level=level)
           if formatter:
               self._breadcrumb_handler.setFormatter(formatter())

Second option is to provide a set method for LoggingIntegration after initialization to update the formatter (like setFormatter).

I'll be happy to provide a PR for this if you agree,

Thanks.

[antonpirker]

Hey @bityob !
Thanks for the great suggestion!
I think having a optional formatter parameter could be a good Idea.
This could potentially also solve issues other people are having. Like those:

• Grouping and JSON log messages #587 (its about JSON log message)
• Log message formatting options #228 (its about structlog log messages (that are also JSON)
• Add support of loguru logger. #653 (its about a logguru integration, but maybe it can be tackled with just a formatter?)

Could you please have a look at those Issue and see if there is stuff in there that could also help your problem. Or if there are the same problems in them as your are trying to fix here?

Thanks a lot!

[github-actions]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀