import os
import random
import socket
import uuid
from collections.abc import Mapping
from contextvars import ContextVar
from datetime import datetime, timezone
from importlib import import_module
from typing import TYPE_CHECKING, Dict, cast, overload
from sentry_sdk._compat import check_uwsgi_thread_support
from sentry_sdk._log_batcher import LogBatcher
from sentry_sdk._metrics_batcher import MetricsBatcher
from sentry_sdk._span_batcher import SpanBatcher
from sentry_sdk.consts import (
DEFAULT_MAX_VALUE_LENGTH,
DEFAULT_OPTIONS,
VERSION,
ClientConstructor,
)
from sentry_sdk.data_collection import (
_resolve_data_collection,
)
from sentry_sdk.envelope import Envelope, Item
from sentry_sdk.integrations import setup_integrations
from sentry_sdk.monitor import Monitor
from sentry_sdk.profiler.continuous_profiler import setup_continuous_profiler
from sentry_sdk.serializer import serialize
from sentry_sdk.sessions import SessionFlusher
from sentry_sdk.traces import Span, trace
from sentry_sdk.transport import (
AsyncHttpTransport,
HttpTransportCore,
make_transport,
)
from sentry_sdk.utils import (
AnnotatedValue,
capture_internal_exceptions,
current_stacktrace,
env_to_bool,
format_timestamp,
get_before_send_log,
get_before_send_metric,
get_before_send_span,
get_default_release,
get_sdk_name,
get_type_name,
handle_in_app,
logger,
)
if TYPE_CHECKING:
from typing import Any, Callable, Optional, Sequence, Type, TypeVar, Union
from sentry_sdk._log_batcher import LogBatcher
from sentry_sdk._metrics_batcher import MetricsBatcher
from sentry_sdk._types import (
Event,
EventDataCategory,
Hint,
Log,
Metric,
SDKInfo,
)
from sentry_sdk.integrations import Integration
from sentry_sdk.scope import Scope
from sentry_sdk.session import Session
from sentry_sdk.spotlight import SpotlightClient
from sentry_sdk.traces import Span
from sentry_sdk.transport import Item, Transport
from sentry_sdk.utils import Dsn
I = TypeVar("I", bound=Integration) # noqa: E741
_client_init_debug: "ContextVar[bool]" = ContextVar("client_init_debug")
SDK_INFO: "SDKInfo" = {
"name": "sentry.python", # SDK name will be overridden after integrations have been loaded with sentry_sdk.integrations.setup_integrations()
"version": VERSION,
"packages": [{"name": "pypi:sentry-sdk", "version": VERSION}],
}
def _get_options(*args: "Optional[str]", **kwargs: "Any") -> "Dict[str, Any]":
if args and (isinstance(args[0], (bytes, str)) or args[0] is None):
dsn: "Optional[str]" = args[0]
args = args[1:]
else:
dsn = None
if len(args) > 1:
raise TypeError("Only single positional argument is expected")
rv = dict(DEFAULT_OPTIONS)
options = dict(*args, **kwargs)
if dsn is not None and options.get("dsn") is None:
options["dsn"] = dsn
for key, value in options.items():
if key not in rv:
raise TypeError("Unknown option %r" % (key,))
rv[key] = value
if rv["dsn"] is None:
rv["dsn"] = os.environ.get("SENTRY_DSN")
if rv["release"] is None:
rv["release"] = get_default_release()
if rv["environment"] is None:
rv["environment"] = os.environ.get("SENTRY_ENVIRONMENT") or "production"
if rv["debug"] is None:
rv["debug"] = env_to_bool(os.environ.get("SENTRY_DEBUG"), strict=True) or False
if rv["server_name"] is None and hasattr(socket, "gethostname"):
rv["server_name"] = socket.gethostname()
if rv["project_root"] is None:
try:
project_root = os.getcwd()
except Exception:
project_root = None
rv["project_root"] = project_root
rv["data_collection"] = _resolve_data_collection(rv)
if rv["socket_options"] and not isinstance(rv["socket_options"], list):
logger.warning(
"Ignoring socket_options because of unexpected format. See urllib3.HTTPConnection.socket_options for the expected format."
)
rv["socket_options"] = None
if rv["keep_alive"] is None:
rv["keep_alive"] = (
env_to_bool(os.environ.get("SENTRY_KEEP_ALIVE"), strict=True) or False
)
return rv
[docs]
class BaseClient:
"""
.. versionadded:: 2.0.0
The basic definition of a client that is used for sending data to Sentry.
"""
spotlight: "Optional[SpotlightClient]" = None
def __init__(self, options: "Optional[Dict[str, Any]]" = None) -> None:
if options is None:
options = dict(DEFAULT_OPTIONS)
options["data_collection"] = _resolve_data_collection(options)
self.options: "Dict[str, Any]" = options
self.transport: "Optional[Transport]" = None
self.monitor: "Optional[Monitor]" = None
self.log_batcher: "Optional[LogBatcher]" = None
self.metrics_batcher: "Optional[MetricsBatcher]" = None
self.span_batcher: "Optional[SpanBatcher]" = None
self.integrations: "dict[str, Integration]" = {}
def __getstate__(self, *args: "Any", **kwargs: "Any") -> "Any":
return {"options": {}}
def __setstate__(self, *args: "Any", **kwargs: "Any") -> None:
pass
@property
def dsn(self) -> "Optional[str]":
return None
@property
def parsed_dsn(self) -> "Optional[Dsn]":
return None
[docs]
def is_active(self) -> bool:
"""
.. versionadded:: 2.0.0
Returns whether the client is active (able to send data to Sentry)
"""
return False
def capture_event(self, *args: "Any", **kwargs: "Any") -> "Optional[str]":
return None
def _capture_log(self, log: "Log", scope: "Scope") -> None:
pass
def _capture_metric(self, metric: "Metric", scope: "Scope") -> None:
pass
def _capture_span(self, span: "Span", scope: "Scope") -> None:
pass
def capture_session(self, *args: "Any", **kwargs: "Any") -> None:
return None
if TYPE_CHECKING:
@overload
def get_integration(self, name_or_class: str) -> "Optional[Integration]": ...
@overload
def get_integration(self, name_or_class: "type[I]") -> "Optional[I]": ...
def get_integration(
self, name_or_class: "Union[str, type[Integration]]"
) -> "Optional[Integration]":
return None
def close(self, *args: "Any", **kwargs: "Any") -> None:
return None
def flush(self, *args: "Any", **kwargs: "Any") -> None:
return None
async def close_async(self, *args: "Any", **kwargs: "Any") -> None:
return None
async def flush_async(self, *args: "Any", **kwargs: "Any") -> None:
return None
def __enter__(self) -> "BaseClient":
return self
def __exit__(self, exc_type: "Any", exc_value: "Any", tb: "Any") -> None:
return None
[docs]
class NonRecordingClient(BaseClient):
"""
.. versionadded:: 2.0.0
A client that does not send any events to Sentry. This is used as a fallback when the Sentry SDK is not yet initialized.
"""
pass
[docs]
class _Client(BaseClient):
"""
The client is internally responsible for capturing the events and
forwarding them to sentry through the configured transport. It takes
the client options as keyword arguments and optionally the DSN as first
argument.
Alias of :py:class:`sentry_sdk.Client`. (Was created for better intelisense support)
"""
def __init__(self, *args: "Any", **kwargs: "Any") -> None:
super(_Client, self).__init__(options=get_options(*args, **kwargs))
self._init_impl()
def __getstate__(self) -> "Any":
return {"options": self.options}
def __setstate__(self, state: "Any") -> None:
self.options = state["options"]
self._init_impl()
def _setup_instrumentation(
self, functions_to_trace: "Sequence[Dict[str, str]]"
) -> None:
"""
Instruments the functions given in the list `functions_to_trace` with a trace decorator.
"""
for function in functions_to_trace:
class_name = None
function_qualname = function["qualified_name"]
if "." not in function_qualname:
logger.warning(
"Can not enable tracing for '%s'. Please provide the fully qualified name including the module (e.g. 'mymodule.my_function').",
function_qualname,
)
continue
module_name, function_name = function_qualname.rsplit(".", 1)
try:
# Try to import module and function
# ex: "mymodule.submodule.funcname"
module_obj = import_module(module_name)
function_obj = getattr(module_obj, function_name)
setattr(module_obj, function_name, trace(function_obj))
logger.debug("Enabled tracing for %s", function_qualname)
except ModuleNotFoundError:
try:
# Try to import a class
# ex: "mymodule.submodule.MyClassName.member_function"
module_name, class_name = module_name.rsplit(".", 1)
module_obj = import_module(module_name)
class_obj = getattr(module_obj, class_name)
function_obj = getattr(class_obj, function_name)
function_type = type(class_obj.__dict__[function_name])
traced_function = trace(function_obj)
if function_type in (staticmethod, classmethod):
traced_function = staticmethod(traced_function)
setattr(class_obj, function_name, traced_function)
setattr(module_obj, class_name, class_obj)
logger.debug("Enabled tracing for %s", function_qualname)
except Exception as e:
logger.warning(
"Can not enable tracing for '%s'. (%s) Please check your `functions_to_trace` parameter.",
function_qualname,
e,
)
except Exception as e:
logger.warning(
"Can not enable tracing for '%s'. (%s) Please check your `functions_to_trace` parameter.",
function_qualname,
e,
)
def _init_impl(self) -> None:
old_debug = _client_init_debug.get(False)
def _capture_envelope(envelope: "Envelope") -> None:
if self.spotlight is not None:
self.spotlight.capture_envelope(envelope)
if self.transport is not None:
self.transport.capture_envelope(envelope)
def _record_lost_event(
reason: str,
data_category: "EventDataCategory",
item: "Optional[Item]" = None,
quantity: int = 1,
) -> None:
if self.transport is not None:
self.transport.record_lost_event(
reason=reason,
data_category=data_category,
item=item,
quantity=quantity,
)
try:
_client_init_debug.set(self.options["debug"])
if self.options["trace_lifecycle"] not in (None, "stream"):
logger.warning(
"Span streaming is the only tracing mode. Ignoring unknown trace_lifecycle value."
)
self.transport = make_transport(self.options)
self.monitor = None
if self.transport:
if self.options["enable_backpressure_handling"]:
self.monitor = Monitor(self.transport)
# Setup Spotlight before creating batchers so _capture_envelope can use it.
# setup_spotlight handles all config/env var resolution per the SDK spec.
from sentry_sdk.spotlight import setup_spotlight
self.spotlight = setup_spotlight(self.options)
if self.spotlight is not None and not self.options["dsn"]:
sample_all = lambda *_args, **_kwargs: 1.0
self.options["error_sampler"] = sample_all
self.options["traces_sampler"] = sample_all
self.session_flusher = SessionFlusher(capture_func=_capture_envelope)
self.log_batcher = LogBatcher(
capture_func=_capture_envelope,
record_lost_func=_record_lost_event,
)
self.metrics_batcher = MetricsBatcher(
capture_func=_capture_envelope,
record_lost_func=_record_lost_event,
)
self.span_batcher = SpanBatcher(
capture_func=_capture_envelope,
record_lost_func=_record_lost_event,
)
max_request_body_size = ("always", "never", "small", "medium")
if self.options["max_request_body_size"] not in max_request_body_size:
raise ValueError(
"Invalid value for max_request_body_size. Must be one of {}".format(
max_request_body_size
)
)
self.integrations = setup_integrations(
self.options["integrations"],
with_defaults=self.options["default_integrations"],
with_auto_enabling_integrations=self.options[
"auto_enabling_integrations"
],
disabled_integrations=self.options["disabled_integrations"],
options=self.options,
)
sdk_name = get_sdk_name(list(self.integrations.keys()))
SDK_INFO["name"] = sdk_name
logger.debug("Setting SDK name to '%s'", sdk_name)
try:
setup_continuous_profiler(
self.options,
sdk_info=SDK_INFO,
capture_func=_capture_envelope,
)
except Exception as e:
logger.debug("Can not set up continuous profiler. (%s)", e)
finally:
_client_init_debug.set(old_debug)
self._setup_instrumentation(self.options.get("functions_to_trace", []))
if (
self.monitor
or self.log_batcher
or self.metrics_batcher
or self.span_batcher
or isinstance(self.transport, HttpTransportCore)
):
# If we have anything on that could spawn a background thread, we
# need to check if it's safe to use them.
check_uwsgi_thread_support()
[docs]
def is_active(self) -> bool:
"""
.. versionadded:: 2.0.0
Returns whether the client is active (able to send data to Sentry)
"""
return True
@property
def dsn(self) -> "Optional[str]":
"""Returns the configured DSN as string."""
return self.options["dsn"]
@property
def parsed_dsn(self) -> "Optional[Dsn]":
"""Returns the configured parsed DSN object."""
return self.transport.parsed_dsn if self.transport else None
def _prepare_event(
self,
event: "Event",
hint: "Hint",
scope: "Optional[Scope]",
) -> "Optional[Event]":
previous_total_breadcrumbs: "Optional[int]" = None
if event.get("timestamp") is None:
event["timestamp"] = datetime.now(timezone.utc)
is_checkin = event.get("type") == "check_in"
if scope is not None:
event_ = scope.apply_to_event(event, hint, self.options)
# one of the event/error processors returned None or raised;
# the client report is recorded in Scope._drop
if event_ is None:
return None
event = event_
if scope._n_breadcrumbs_truncated > 0:
breadcrumbs = event.get("breadcrumbs", {})
values = (
breadcrumbs.get("values", [])
if not isinstance(breadcrumbs, AnnotatedValue)
else []
)
previous_total_breadcrumbs = (
len(values) + scope._n_breadcrumbs_truncated
)
if (
not is_checkin
and self.options["attach_stacktrace"]
and "exception" not in event
and "stacktrace" not in event
and "threads" not in event
):
with capture_internal_exceptions():
event["threads"] = {
"values": [
{
"stacktrace": current_stacktrace(
max_value_length=self.options.get(
"max_value_length", DEFAULT_MAX_VALUE_LENGTH
),
),
"crashed": False,
"current": True,
}
]
}
for key in "release", "environment", "server_name", "dist":
if event.get(key) is None and self.options[key] is not None:
event[key] = str(self.options[key]).strip()
if event.get("sdk") is None:
sdk_info = dict(SDK_INFO)
sdk_info["integrations"] = sorted(self.integrations.keys())
event["sdk"] = sdk_info
if event.get("platform") is None:
event["platform"] = "python"
event = handle_in_app(
event,
self.options["in_app_exclude"],
self.options["in_app_include"],
self.options["project_root"],
)
if previous_total_breadcrumbs is not None:
event["breadcrumbs"] = AnnotatedValue(
event.get("breadcrumbs", {"values": []}),
{"len": previous_total_breadcrumbs},
)
# Postprocess the event here so that annotated types do
# generally not surface in before_send
if event is not None:
event = cast(
"Event",
serialize(
cast("Dict[str, Any]", event),
max_request_body_size=self.options.get("max_request_body_size"),
max_value_length=self.options.get("max_value_length"),
custom_repr=self.options.get("custom_repr"),
),
)
before_send = self.options["before_send"]
if before_send is not None and event is not None:
new_event = None
exception_raised_in_before_send = False
with capture_internal_exceptions():
try:
new_event = before_send(event, hint or {})
except Exception:
exception_raised_in_before_send = True
raise
if new_event is None:
logger.info("before send dropped event")
if self.transport:
reason = (
"callback_error"
if exception_raised_in_before_send
else "before_send"
)
self.transport.record_lost_event(reason, data_category="error")
event = new_event
return event
def _is_ignored_error(self, event: "Event", hint: "Hint") -> bool:
exc_info = hint.get("exc_info")
if exc_info is None:
return False
error = exc_info[0]
error_type_name = get_type_name(exc_info[0])
error_full_name = "%s.%s" % (exc_info[0].__module__, error_type_name)
for ignored_error in self.options["ignore_errors"]:
# String types are matched against the type name in the
# exception only
if isinstance(ignored_error, str):
if ignored_error == error_full_name or ignored_error == error_type_name:
return True
else:
if issubclass(error, ignored_error):
return True
return False
def _should_capture(
self,
event: "Event",
hint: "Hint",
scope: "Optional[Scope]" = None,
) -> bool:
ignoring_prevents_recursion = scope is not None and not scope._should_capture
if ignoring_prevents_recursion:
return False
ignored_by_config_option = self._is_ignored_error(event, hint)
if ignored_by_config_option:
return False
return True
def _should_sample_error(
self,
event: "Event",
hint: "Hint",
) -> bool:
error_sampler = self.options.get("error_sampler", None)
if callable(error_sampler):
with capture_internal_exceptions():
sample_rate = error_sampler(event, hint)
else:
sample_rate = self.options["sample_rate"]
try:
not_in_sample_rate = sample_rate < 1.0 and random.random() >= sample_rate
except NameError:
logger.warning(
"The provided error_sampler raised an error. Defaulting to sampling the event."
)
# If the error_sampler raised an error, we should sample the event, since the default behavior
# (when no sample_rate or error_sampler is provided) is to sample all events.
not_in_sample_rate = False
except TypeError:
parameter, verb = (
("error_sampler", "returned")
if callable(error_sampler)
else ("sample_rate", "contains")
)
logger.warning(
"The provided %s %s an invalid value of %s. The value should be a float or a bool. Defaulting to sampling the event."
% (parameter, verb, repr(sample_rate))
)
# If the sample_rate has an invalid value, we should sample the event, since the default behavior
# (when no sample_rate or error_sampler is provided) is to sample all events.
not_in_sample_rate = False
if not_in_sample_rate:
# because we will not sample this event, record a "lost event".
if self.transport:
self.transport.record_lost_event("sample_rate", data_category="error")
return False
return True
def _update_session_from_event(
self,
session: "Session",
event: "Event",
) -> None:
crashed = False
errored = False
user_agent = None
exceptions = (event.get("exception") or {}).get("values")
if exceptions:
errored = True
for error in exceptions:
if isinstance(error, AnnotatedValue):
error = error.value or {}
mechanism = error.get("mechanism")
if isinstance(mechanism, Mapping) and mechanism.get("handled") is False:
crashed = True
break
user = event.get("user")
if session.user_agent is None:
headers = (event.get("request") or {}).get("headers")
headers_dict = headers if isinstance(headers, dict) else {}
for k, v in headers_dict.items():
if k.lower() == "user-agent":
user_agent = v
break
session.update(
status="crashed" if crashed else None,
user=user,
user_agent=user_agent,
errors=session.errors + (errored or crashed),
)
[docs]
def capture_event(
self,
event: "Event",
hint: "Optional[Hint]" = None,
scope: "Optional[Scope]" = None,
) -> "Optional[str]":
"""Captures an event.
:param event: A ready-made event that can be directly sent to Sentry.
:param hint: Contains metadata about the event that can be read from `before_send`, such as the original exception object or a HTTP request object.
:param scope: An optional :py:class:`sentry_sdk.Scope` to apply to events.
:returns: An event ID. May be `None` if there is no DSN set or of if the SDK decided to discard the event for other reasons. In such situations setting `debug=True` on `init()` may help.
"""
hint = dict(hint or ())
if not self._should_capture(event, hint, scope):
return None
event_id = event.get("event_id")
if event_id is None:
event["event_id"] = event_id = uuid.uuid4().hex
event_opt = self._prepare_event(event, hint, scope)
if event_opt is None:
return None
# whenever we capture an event we also check if the session needs
# to be updated based on that information.
session = scope._session if scope else None
if session:
self._update_session_from_event(session, event)
is_checkin = event_opt.get("type") == "check_in"
if not is_checkin and not self._should_sample_error(event, hint):
return None
attachments = hint.get("attachments")
trace_context = event_opt.get("contexts", {}).get("trace") or {}
dynamic_sampling_context = trace_context.pop("dynamic_sampling_context", {})
headers: "dict[str, object]" = {
"event_id": event_opt["event_id"],
"sent_at": format_timestamp(datetime.now(timezone.utc)),
}
if dynamic_sampling_context:
headers["trace"] = dynamic_sampling_context
envelope = Envelope(headers=headers)
if is_checkin:
envelope.add_checkin(event_opt)
else:
envelope.add_event(event_opt)
for attachment in attachments or ():
envelope.add_item(attachment.to_envelope_item())
return_value = None
if self.spotlight:
self.spotlight.capture_envelope(envelope)
return_value = event_id
if self.transport is not None:
self.transport.capture_envelope(envelope)
return_value = event_id
return return_value
def _record_lost_telemetry(
self, reason: str, ty: str, telemetry: "Union[Log, Metric]"
) -> None:
if self.transport is None:
return
batcher_cls: "Union[type[LogBatcher], type[MetricsBatcher]]"
if ty == "log":
data_category: "EventDataCategory" = "log_item"
batcher_cls = LogBatcher
else:
data_category = "trace_metric"
batcher_cls = MetricsBatcher
# Construct envelope item without sending it to report lost bytes
item = None
with capture_internal_exceptions():
item = batcher_cls._to_envelope_item([telemetry]) # type: ignore[list-item]
self.transport.record_lost_event(reason, data_category=data_category, item=item)
def _capture_telemetry(
self,
telemetry: "Optional[Union[Log, Metric, Span]]",
ty: str,
scope: "Scope",
) -> None:
"""
Capture attributes-based telemetry (logs, metrics, streamed spans).
Apply any attributes set on the scope to it, and run the user's
before_send_{telemetry} on it, if applicable.
"""
if telemetry is None:
return
scope.apply_to_telemetry(telemetry)
before_send = None
if ty == "log":
before_send = get_before_send_log(self.options)
serialized = telemetry
elif ty == "metric":
before_send = get_before_send_metric(self.options)
serialized = telemetry
elif ty == "span":
before_send = get_before_send_span(self.options)
serialized = telemetry._to_json() # type: ignore[union-attr]
if before_send is not None:
exception_raised_in_before_send_func = False
with capture_internal_exceptions():
try:
serialized = before_send(serialized, {}) # type: ignore[arg-type]
except Exception:
exception_raised_in_before_send_func = True
raise
if ty in ("log", "metric"):
if exception_raised_in_before_send_func:
self._record_lost_telemetry("callback_error", ty, telemetry) # type: ignore[arg-type]
return
if serialized is None:
self._record_lost_telemetry("before_send", ty, telemetry) # type: ignore[arg-type]
return
elif ty == "span" and isinstance(telemetry, Span):
# Reset the span to its original value before we attempted
# to call the `before_send_span` callback
if exception_raised_in_before_send_func:
serialized = telemetry._to_json()
# Spans can't be dropped in before_send_span by design. They can
# be altered though (e.g. to sanitize). Only allow changes to
# name and attributes.
if isinstance(serialized, dict) and "name" in serialized:
telemetry.name = serialized["name"] # type: ignore[typeddict-item]
telemetry._attributes = {}
for k, v in (serialized.get("attributes") or {}).items():
telemetry.set_attribute(k, v)
else:
logger.debug(
"[Tracing] Invalid return value from before_send_span. Keeping original span."
)
serialized = telemetry._to_json()
batcher = None
if ty == "log":
batcher = self.log_batcher
elif ty == "metric":
batcher = self.metrics_batcher
elif ty == "span":
# We need a reference to the segment span in the batcher to populate
# the dynamic sampling context (DSC)
serialized["_segment_span"] = telemetry._segment # type: ignore
batcher = self.span_batcher
if batcher is not None:
batcher.add(serialized) # type: ignore
def _capture_log(self, log: "Optional[Log]", scope: "Scope") -> None:
self._capture_telemetry(log, "log", scope)
def _capture_metric(self, metric: "Optional[Metric]", scope: "Scope") -> None:
self._capture_telemetry(metric, "metric", scope)
def _capture_span(self, span: "Optional[Span]", scope: "Scope") -> None:
self._capture_telemetry(span, "span", scope)
def capture_session(
self,
session: "Session",
) -> None:
if not session.release:
logger.info("Discarded session update because of missing release")
else:
self.session_flusher.add_session(session)
if TYPE_CHECKING:
@overload
def get_integration(self, name_or_class: str) -> "Optional[Integration]": ...
@overload
def get_integration(self, name_or_class: "type[I]") -> "Optional[I]": ...
[docs]
def get_integration(
self,
name_or_class: "Union[str, Type[Integration]]",
) -> "Optional[Integration]":
"""Returns the integration for this client by name or class.
If the client does not have that integration then `None` is returned.
"""
if isinstance(name_or_class, str):
integration_name = name_or_class
elif name_or_class.identifier is not None:
integration_name = name_or_class.identifier
else:
raise ValueError("Integration has no name")
return self.integrations.get(integration_name)
def _has_async_transport(self) -> bool:
"""Check if the current transport is async."""
return isinstance(self.transport, AsyncHttpTransport)
@property
def _batchers(self) -> "tuple[Any, ...]":
return tuple(
b
for b in (self.log_batcher, self.metrics_batcher, self.span_batcher)
if b is not None
)
def _close_components(self) -> None:
"""Kill all client components in the correct order."""
self.session_flusher.kill()
for b in self._batchers:
b.kill()
if self.monitor:
self.monitor.kill()
def _flush_components(self) -> None:
"""Flush all client components."""
self.session_flusher.flush()
for b in self._batchers:
b.flush()
[docs]
def close(
self,
timeout: "Optional[float]" = None,
callback: "Optional[Callable[[int, float], None]]" = None,
) -> None:
"""
Close the client and shut down the transport. Arguments have the same
semantics as :py:meth:`Client.flush`.
"""
if self.transport is not None:
if self._has_async_transport():
logger.warning(
"close() used with AsyncHttpTransport. Use close_async() instead.",
)
self._flush_components()
else:
self.flush(timeout=timeout, callback=callback)
self._close_components()
self.transport.kill()
self.transport = None
[docs]
async def close_async(
self,
timeout: "Optional[float]" = None,
callback: "Optional[Callable[[int, float], None]]" = None,
) -> None:
"""
Asynchronously close the client and shut down the transport. Arguments have the same
semantics as :py:meth:`Client.flush_async`.
"""
if self.transport is not None:
if not self._has_async_transport():
logger.debug(
"close_async() used with non-async transport, aborting. Please use close() instead."
)
return
await self.flush_async(timeout=timeout, callback=callback)
self._close_components()
kill_task = self.transport.kill() # type: ignore
if kill_task is not None:
await kill_task
self.transport = None
[docs]
def flush(
self,
timeout: "Optional[float]" = None,
callback: "Optional[Callable[[int, float], None]]" = None,
) -> None:
"""
Wait for the current events to be sent.
:param timeout: Wait for at most `timeout` seconds. If no `timeout` is provided, the `shutdown_timeout` option value is used.
:param callback: Is invoked with the number of pending events and the configured timeout.
"""
if self.transport is not None:
if self._has_async_transport():
logger.warning(
"flush() used with AsyncHttpTransport. Use flush_async() instead.",
)
return
if timeout is None:
timeout = self.options["shutdown_timeout"]
self._flush_components()
self.transport.flush(timeout=timeout, callback=callback)
[docs]
async def flush_async(
self,
timeout: "Optional[float]" = None,
callback: "Optional[Callable[[int, float], None]]" = None,
) -> None:
"""
Asynchronously wait for the current events to be sent.
:param timeout: Wait for at most `timeout` seconds. If no `timeout` is provided, the `shutdown_timeout` option value is used.
:param callback: Is invoked with the number of pending events and the configured timeout.
"""
if self.transport is not None:
if not self._has_async_transport():
logger.debug(
"flush_async() used with non-async transport, aborting. Please use flush() instead."
)
return
if timeout is None:
timeout = self.options["shutdown_timeout"]
self._flush_components()
flush_task = self.transport.flush(timeout=timeout, callback=callback) # type: ignore
if flush_task is not None:
await flush_task
def __enter__(self) -> "_Client":
return self
def __exit__(self, exc_type: "Any", exc_value: "Any", tb: "Any") -> None:
self.close()
async def __aenter__(self) -> "_Client":
return self
async def __aexit__(self, exc_type: "Any", exc_value: "Any", tb: "Any") -> None:
await self.close_async()
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# Make mypy, PyCharm and other static analyzers think `get_options` is a
# type to have nicer autocompletion for params.
#
# Use `ClientConstructor` to define the argument types of `init` and
# `Dict[str, Any]` to tell static analyzers about the return type.
class get_options(ClientConstructor, Dict[str, Any]): # noqa: N801
pass
[docs]
class Client(ClientConstructor, _Client):
pass
else:
# Alias `get_options` for actual usage. Go through the lambda indirection
# to throw PyCharm off of the weakly typed signature (it would otherwise
# discover both the weakly typed signature of `_init` and our faked `init`
# type).
get_options = (lambda: _get_options)()
Client = (lambda: _Client)()
sentry-python