Skip to content

fix: Include logging docs in new API docs #494

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
Sep 3, 2019
Merged

fix: Include logging docs in new API docs #494

Show file tree
Hide file tree
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
9 changes: 9 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
========
Main API
========

.. inherited-members necessary because of hack for Client and init methods

.. automodule:: sentry_sdk
:members:
:inherited-members:
8 changes: 3 additions & 5 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ This is the API documentation for `Sentry's Python SDK
<https://sentry.io/for/python/>`_. For full documentation and other resources
visit the `GitHub repository <https://github.com/getsentry/sentry-python>`_.

.. inherited-members necessary because of hack for Client and init methods

.. automodule:: sentry_sdk
:members:
:inherited-members:
.. toctree::
api
integrations
14 changes: 14 additions & 0 deletions docs/integrations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
============
Integrations
============

Logging
=======

.. module:: sentry_sdk.integrations.logging

.. autofunction:: ignore_logger

.. autoclass:: EventHandler

.. autoclass:: BreadcrumbHandler
20 changes: 18 additions & 2 deletions sentry_sdk/integrations/logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,16 @@
_IGNORED_LOGGERS = set(["sentry_sdk.errors"])


def ignore_logger(name):
# type: (str) -> None
def ignore_logger(
name # type: str
):
# type: (...) -> None
"""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
to users as a way to quiet spammy loggers.

:param name: The name of the logger to ignore (same string you would pass to ``logging.getLogger``).
"""
_IGNORED_LOGGERS.add(name)

Expand Down Expand Up @@ -146,6 +150,12 @@ def _extra_from_record(record):


class EventHandler(logging.Handler, object):
"""
A logging handler that emits Sentry events for each log record

Note that you do not have to use this class if the logging integration is enabled, which it is by default.
"""

def emit(self, record):
# type: (LogRecord) -> Any
with capture_internal_exceptions():
Expand Down Expand Up @@ -204,6 +214,12 @@ def _emit(self, record):


class BreadcrumbHandler(logging.Handler, object):
"""
A logging handler that records breadcrumbs for each log record.

Note that you do not have to use this class if the logging integration is enabled, which it is by default.
"""

def emit(self, record):
# type: (LogRecord) -> Any
with capture_internal_exceptions():
Expand Down