Skip to content

fix(docs): Fix docstring in ignore_logger #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
untitaker merged 1 commit into from
Jun 24, 2019
Merged

fix(docs): Fix docstring in ignore_logger #400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions sentry_sdk/integrations/logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@

def ignore_logger(name):
# type: (str) -> None
"""This disables the breadcrumb integration for a logger of a specific
name. This primary use is for some integrations to disable breadcrumbs
of this integration.
"""This disables recording (both in breadcrumbs and as events) calls to
a logger of a specific name. Among other uses, many of our integrations
use this to prevent their actions being recorded as breadcrumbs. Exposed
Copy link
Copy Markdown
Member

@untitaker untitaker Jun 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to prevent their actions being recorded as breadcrumbs

More precisely, the integrations use this to suppress spam breadcrumbs/events from the framework that would be sent if the integration was disabled. A classic is sending a stringified traceback as log message, or more generally a log error by the framework for every exception we already recorded via other means

Copy link
Copy Markdown
Member

@untitaker untitaker Jun 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I now understand what their means in this context, nvm my comment.

to users as a way to quiet spammy loggers.
"""
_IGNORED_LOGGERS.add(name)

Expand Down