API Docs¶

class sentry_sdk.Hub(client_or_hub=None, scope=None)[source]¶

Deprecated since version 2.0.0: The Hub is deprecated. Its functionality will be merged into sentry_sdk.scope.Scope.

The hub wraps the concurrency management of the SDK. Each thread has its own hub but the hub might transfer with the flow of execution if context vars are available.

If the hub is used with a with statement it’s temporarily activated.

add_breadcrumb(crumb=None, hint=None, **kwargs)[source]¶

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.add_breadcrumb() instead.

Adds a breadcrumb.

Parameters:

crumb (Optional[Dict[str, Any]]) – Dictionary with the data as the sentry v7/v8 protocol expects.
hint (Optional[Dict[str, Any]]) – An optional value that can be used by before_breadcrumb to customize the breadcrumbs that are emitted.

Return type:

None

bind_client(new)[source]¶

Return type:: None

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.set_client() instead.

Binds a new client to the hub.

capture_event(event, hint=None, scope=None, **scope_kwargs)[source]¶

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.capture_event() instead.

Captures an event.

Alias of sentry_sdk.Scope.capture_event().

Parameters:

event (Event) – A ready-made event that can be directly sent to Sentry.
hint (Optional[Dict[str, Any]]) – Contains metadata about the event that can be read from before_send, such as the original exception object or a HTTP request object.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events. The scope and scope_kwargs parameters are mutually exclusive.
scope_kwargs (Any) – Optional data to apply to event. For supported **scope_kwargs see sentry_sdk.Scope.update_from_kwargs(). The scope and scope_kwargs parameters are mutually exclusive.

Return type:

Optional[str]

capture_exception(error=None, scope=None, **scope_kwargs)[source]¶

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.capture_exception() instead.

Captures an exception.

Alias of sentry_sdk.Scope.capture_exception().

Parameters:

error (Union[BaseException, tuple[Type[BaseException], BaseException, Optional[TracebackType]], tuple[None, None, None], None]) – An exception to capture. If None, sys.exc_info() will be used.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events. The scope and scope_kwargs parameters are mutually exclusive.
scope_kwargs (Any) – Optional data to apply to event. For supported **scope_kwargs see sentry_sdk.Scope.update_from_kwargs(). The scope and scope_kwargs parameters are mutually exclusive.

Return type:

Optional[str]

Returns:

An event_id if the SDK decided to send the event (see sentry_sdk.client._Client.capture_event()).

capture_message(message, level=None, scope=None, **scope_kwargs)[source]¶

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.capture_message() instead.

Captures a message.

Alias of sentry_sdk.Scope.capture_message().

Parameters:

message (str) – The string to send as the message to Sentry.
level (Optional[Literal['fatal', 'critical', 'error', 'warning', 'info', 'debug']]) – If no level is provided, the default level is info.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events. The scope and scope_kwargs parameters are mutually exclusive.
scope_kwargs (Any) – Optional data to apply to event. For supported **scope_kwargs see sentry_sdk.Scope.update_from_kwargs(). The scope and scope_kwargs parameters are mutually exclusive.

Return type:

Optional[str]

Returns:

An event_id if the SDK decided to send the event (see sentry_sdk.client._Client.capture_event()).

property client: BaseClient | None¶: Deprecated since version 2.0.0: This property is deprecated and will be removed in a future release. Please use sentry_sdk.api.get_client() instead.

Returns the current client on the hub.

configure_scope(callback=None, continue_trace=True)[source]¶

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release.

Reconfigures the scope.

Parameters:: callback (Optional[Callable[[Scope], None]]) – If provided, call the callback with the current scope.
Return type:: Optional[ContextManager[Scope]]
Returns:: If no callback is provided, returns a context manager that returns the scope.

continue_trace(environ_or_headers, op=None, name=None, source=None)[source]¶

Return type:: Transaction

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.continue_trace() instead.

Sets the propagation context from environment or headers and returns a transaction.

end_session()[source]¶

Return type:: None

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.end_session() instead.

Ends the current session if there is one.

flush(timeout=None, callback=None)[source]¶

Return type:: None

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.client._Client.flush() instead.

Alias for sentry_sdk.client._Client.flush()

get_baggage()[source]¶

Return type:: Optional[str]

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.get_baggage() instead.

Returns Baggage either from the active span or from the scope.

get_integration(name_or_class)[source]¶

Return type:: Any

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.client._Client.get_integration() instead.

Returns the integration for this hub by name or class. If there is no client bound or the client does not have that integration then None is returned.

If the return value is not None the hub is guaranteed to have a client attached.

get_traceparent()[source]¶

Return type:: Optional[str]

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.get_traceparent() instead.

Returns the traceparent either from the active span or from the scope.

iter_trace_propagation_headers(span=None)[source]¶

Return type:: Generator[Tuple[str, str], None, None]

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.iter_trace_propagation_headers() instead.

Return HTTP headers which allow propagation of trace data. Data taken from the span representing the request, if available, or the current span on the scope if not.

last_event_id()[source]¶: Returns the last event ID. :rtype: Optional[str]

Deprecated since version 1.40.5: This function is deprecated and will be removed in a future release. The functions capture_event, capture_message, and capture_exception return the event ID directly.

pop_scope_unsafe()[source]¶

Return type:: Tuple[Optional[Client], Scope]

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release.

Pops a scope layer from the stack.

Try to use the context manager push_scope() instead.

push_scope(callback=None, continue_trace=True)[source]¶

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release.

Pushes a new layer on the scope stack.

Parameters:: callback (Optional[Callable[[Scope], None]]) – If provided, this method pushes a scope, calls callback, and pops the scope again.
Return type:: Optional[ContextManager[Scope]]
Returns:: If no callback is provided, a context manager that should be used to pop the scope again.

resume_auto_session_tracking()[source]¶

Return type:: None

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.resume_auto_session_tracking() instead.

Resumes automatic session tracking for the current scope if disabled earlier. This requires that generally automatic session tracking is enabled.

run(callback)[source]¶

Return type:: TypeVar(T)

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release.

Runs a callback in the context of the hub. Alternatively the with statement can be used on the hub directly.

property scope: Scope¶: Deprecated since version 2.0.0: This property is deprecated and will be removed in a future release. Returns the current scope on the hub.

start_session(session_mode='application')[source]¶

Return type:: None

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.start_session() instead.

Starts a new session.

start_span(instrumenter='sentry', **kwargs)[source]¶

Return type:: Span

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.start_span() instead.

Start a span whose parent is the currently active span or transaction, if any.

The return value is a sentry_sdk.tracing.Span instance, typically used as a context manager to start and stop timing in a with block.

Only spans contained in a transaction are sent to Sentry. Most integrations start a transaction at the appropriate time, for example for every incoming HTTP request. Use sentry_sdk.start_transaction() to start a new transaction when one is not already in progress.

For supported **kwargs see sentry_sdk.tracing.Span.

start_transaction(transaction=None, instrumenter='sentry', custom_sampling_context=None, **kwargs)[source]¶

Return type:: Union[Transaction, NoOpSpan]

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.start_transaction() instead.

Start and return a transaction.

Start an existing transaction if given, otherwise create and start a new transaction with kwargs.

This is the entry point to manual tracing instrumentation.

A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a new child span within the transaction or any span, call the respective .start_child() method.

Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.

When used as context managers, spans and transactions are automatically finished at the end of the with block. If not using context managers, call the .finish() method.

When the transaction is finished, it will be sent to Sentry with all its finished child spans.

For supported **kwargs see sentry_sdk.tracing.Transaction.

stop_auto_session_tracking()[source]¶

Return type:: None

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.stop_auto_session_tracking() instead.

Stops automatic session tracking.

This temporarily session tracking for the current scope when called. To resume session tracking call resume_auto_session_tracking.

trace_propagation_meta(span=None)[source]¶

Return type:: str

Deprecated since version 2.0.0: This function is deprecated and will be removed in a future release. Please use sentry_sdk.Scope.trace_propagation_meta() instead.

Return meta tags which should be injected into HTML templates to allow propagation of trace information.

class sentry_sdk.Scope(ty=None, client=None)[source]¶

The scope holds extra information that should be sent with all events that belong to it.

add_attachment(bytes=None, filename=None, path=None, content_type=None, add_to_transactions=False)[source]¶

Adds an attachment to future events sent from this scope.

The parameters are the same as for the sentry_sdk.attachments.Attachment constructor.

Return type:: None

add_breadcrumb(crumb=None, hint=None, **kwargs)[source]¶

Adds a breadcrumb.

Parameters:

crumb (Optional[Dict[str, Any]]) – Dictionary with the data as the sentry v7/v8 protocol expects.
hint (Optional[Dict[str, Any]]) – An optional value that can be used by before_breadcrumb to customize the breadcrumbs that are emitted.

Return type:

None

add_error_processor(func, cls=None)[source]¶

Parameters:

func (Callable[[Event, Union[tuple[Type[BaseException], BaseException, Optional[TracebackType]], tuple[None, None, None]]], Optional[Event]]) – A callback that works similar to an event processor but is invoked with the original exception info triple as second argument.
cls (Optional[Type[BaseException]]) – Optionally, only process exceptions of this type.

Return type:

None

add_event_processor(func)[source]¶

Parameters:: func (Callable[[Event, Dict[str, Any]], Optional[Event]]) – This function behaves like before_send.
Return type:: None

apply_to_event(event, hint, options=None)[source]¶

Applies the information contained on the scope to the given event.

Return type:: Optional[Event]

capture_event(event, hint=None, scope=None, **scope_kwargs)[source]¶

Captures an event.

Merges given scope data and calls sentry_sdk.client._Client.capture_event().

Parameters:

event (Event) – A ready-made event that can be directly sent to Sentry.
hint (Optional[Dict[str, Any]]) – Contains metadata about the event that can be read from before_send, such as the original exception object or a HTTP request object.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events. The scope and scope_kwargs parameters are mutually exclusive.
scope_kwargs (Any) – Optional data to apply to event. For supported **scope_kwargs see sentry_sdk.Scope.update_from_kwargs(). The scope and scope_kwargs parameters are mutually exclusive.

Return type:

Optional[str]

Returns:

An event_id if the SDK decided to send the event (see sentry_sdk.client._Client.capture_event()).

capture_exception(error=None, scope=None, **scope_kwargs)[source]¶

Captures an exception.

Parameters:

error (Union[BaseException, tuple[Type[BaseException], BaseException, Optional[TracebackType]], tuple[None, None, None], None]) – An exception to capture. If None, sys.exc_info() will be used.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events. The scope and scope_kwargs parameters are mutually exclusive.
scope_kwargs (Any) – Optional data to apply to event. For supported **scope_kwargs see sentry_sdk.Scope.update_from_kwargs(). The scope and scope_kwargs parameters are mutually exclusive.

Return type:

Optional[str]

Returns:

An event_id if the SDK decided to send the event (see sentry_sdk.client._Client.capture_event()).

capture_message(message, level=None, scope=None, **scope_kwargs)[source]¶

Captures a message.

Parameters:

message (str) – The string to send as the message.
level (Optional[Literal['fatal', 'critical', 'error', 'warning', 'info', 'debug']]) – If no level is provided, the default level is info.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events. The scope and scope_kwargs parameters are mutually exclusive.
scope_kwargs (Any) – Optional data to apply to event. For supported **scope_kwargs see sentry_sdk.Scope.update_from_kwargs(). The scope and scope_kwargs parameters are mutually exclusive.

Return type:

Optional[str]

Returns:

An event_id if the SDK decided to send the event (see sentry_sdk.client._Client.capture_event()).

clear()[source]¶

Clears the entire scope.

Return type:: None

clear_breadcrumbs()[source]¶

Clears breadcrumb buffer.

Return type:: None

continue_trace(environ_or_headers, op=None, name=None, source=None, origin='manual')[source]¶

Sets the propagation context from environment or headers and returns a transaction.

Return type:: Transaction

end_session(*args, **kwargs)[source]¶

Ends the current session if there is one.

Return type:: None

property fingerprint¶: When set this overrides the default fingerprint.

fork()[source]¶

Return type:: Scope

Added in version 2.0.0.

Returns a fork of this scope.

generate_propagation_context(incoming_data=None)[source]¶

Makes sure the propagation context is set on the scope. If there is incoming_data overwrite existing propagation context. If there is no incoming_data create new propagation context, but do NOT overwrite if already existing.

Return type:: None

get_baggage(*args, **kwargs)[source]¶

Returns the Sentry “baggage” header containing trace information from the currently active span or the scopes Propagation Context.

Return type:: Optional[Baggage]

classmethod get_client()[source]¶

Return type:: BaseClient

Added in version 2.0.0.

Returns the currently used sentry_sdk.Client. This checks the current scope, the isolation scope and the global scope for a client. If no client is available a sentry_sdk.client.NonRecordingClient is returned.

classmethod get_current_scope()[source]¶

Return type:: Scope

Added in version 2.0.0.

Returns the current scope.

get_dynamic_sampling_context()[source]¶

Returns the Dynamic Sampling Context from the Propagation Context. If not existing, creates a new one.

Return type:: Optional[Dict[str, str]]

classmethod get_global_scope()[source]¶

Return type:: Scope

Added in version 2.0.0.

Returns the global scope.

classmethod get_isolation_scope()[source]¶

Return type:: Scope

Added in version 2.0.0.

Returns the isolation scope.

get_trace_context()[source]¶

Returns the Sentry “trace” context from the Propagation Context.

Return type:: Any

get_traceparent(*args, **kwargs)[source]¶

Returns the Sentry “sentry-trace” header (aka the traceparent) from the currently active span or the scopes Propagation Context.

Return type:: Optional[str]

iter_headers()[source]¶

Creates a generator which returns the sentry-trace and baggage headers from the Propagation Context.

Return type:: Iterator[Tuple[str, str]]

iter_trace_propagation_headers(*args, **kwargs)[source]¶

Return HTTP headers which allow propagation of trace data.

If a span is given, the trace data will taken from the span. If no span is given, the trace data is taken from the scope.

Return type:: Generator[Tuple[str, str], None, None]

classmethod last_event_id()[source]¶

Return type:: Optional[str]

Added in version 2.2.0.

Returns event ID of the event most recently captured by the isolation scope, or None if no event has been captured. We do not consider events that are dropped, e.g. by a before_send hook. Transactions also are not considered events in this context.

The event corresponding to the returned event ID is NOT guaranteed to actually be sent to Sentry; whether the event is sent depends on the transport. The event could be sent later or not at all. Even a sent event could fail to arrive in Sentry due to network issues, exhausted quotas, or various other reasons.

property level¶

When set this overrides the level.

Deprecated since version 1.0.0: Use set_level() instead.

Parameters:: value – The level to set.

remove_context(key)[source]¶

Removes a context.

Return type:: None

remove_extra(key)[source]¶

Removes a specific extra key.

Return type:: None

remove_tag(key)[source]¶

Removes a specific tag.

Parameters:: key (str) – Key of the tag to remove.
Return type:: None

resume_auto_session_tracking()[source]¶

Resumes automatic session tracking for the current scope if disabled earlier. This requires that generally automatic session tracking is enabled.

Return type:: None

run_error_processors(event, hint)[source]¶

Runs the error processors on the event and returns the modified event.

Return type:: Optional[Event]

run_event_processors(event, hint)[source]¶

Runs the event processors on the event and returns the modified event.

Return type:: Optional[Event]

set_client(client=None)[source]¶

Added in version 2.0.0.

Sets the client for this scope.

Parameters:: client (Optional[BaseClient]) – The client to use in this scope. If None the client of the scope will be replaced by a sentry_sdk.NonRecordingClient.
Return type:: None

set_context(key, value)[source]¶

Binds a context at a certain key to a specific value.

Return type:: None

classmethod set_current_scope(new_current_scope)[source]¶

Return type:: None

Added in version 2.0.0.

Sets the given scope as the new current scope overwriting the existing current scope. :type new_current_scope: Scope :param new_current_scope: The scope to set as the new current scope.

set_extra(key, value)[source]¶

Sets an extra key to a specific value.

Return type:: None

classmethod set_isolation_scope(new_isolation_scope)[source]¶

Return type:: None

Added in version 2.0.0.

Sets the given scope as the new isolation scope overwriting the existing isolation scope. :type new_isolation_scope: Scope :param new_isolation_scope: The scope to set as the new isolation scope.

set_level(value)[source]¶

Sets the level for the scope.

Parameters:: value (Literal['fatal', 'critical', 'error', 'warning', 'info', 'debug']) – The level to set.
Return type:: None

set_new_propagation_context()[source]¶

Creates a new propagation context and sets it as _propagation_context. Overwriting existing one.

Return type:: None

set_tag(key, value)[source]¶

Sets a tag for a key to a specific value.

Parameters:

key (str) – Key of the tag to set.
value (Any) – Value of the tag to set.

Return type:

None

set_tags(tags)[source]¶

Sets multiple tags at once.

This method updates multiple tags at once. The tags are passed as a dictionary or other mapping type.

Calling this method is equivalent to calling set_tag on each key-value pair in the mapping. If a tag key already exists in the scope, its value will be updated. If the tag key does not exist in the scope, the key-value pair will be added to the scope.

This method only modifies tag keys in the tags mapping passed to the method. scope.set_tags({}) is, therefore, a no-op.

Parameters:: tags (Mapping[str, object]) – A mapping of tag keys to tag values to set.
Return type:: None

set_transaction_name(name, source=None)[source]¶

Set the transaction name and optionally the transaction source.

Return type:: None

set_user(value)[source]¶

Sets a user for the scope.

Return type:: None

property span: Span | None¶: Get/set current tracing span or transaction.

start_session(*args, **kwargs)[source]¶

Starts a new session.

Return type:: None

start_span(instrumenter='sentry', **kwargs)[source]¶

Start a span whose parent is the currently active span or transaction, if any.

The return value is a sentry_sdk.tracing.Span instance, typically used as a context manager to start and stop timing in a with block.

For supported **kwargs see sentry_sdk.tracing.Span.

The instrumenter parameter is deprecated for user code, and it will be removed in the next major version. Going forward, it should only be used by the SDK itself.

Return type:: Span

start_transaction(transaction=None, instrumenter='sentry', custom_sampling_context=None, **kwargs)[source]¶

Start and return a transaction.

Start an existing transaction if given, otherwise create and start a new transaction with kwargs.

This is the entry point to manual tracing instrumentation.

Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.

When used as context managers, spans and transactions are automatically finished at the end of the with block. If not using context managers, call the .finish() method.

When the transaction is finished, it will be sent to Sentry with all its finished child spans.

Parameters:

transaction (Optional[Transaction]) – The transaction to start. If omitted, we create and start a new transaction.
instrumenter (str) – This parameter is meant for internal use only. It will be removed in the next major version.
custom_sampling_context (Optional[Dict[str, Any]]) – The transaction’s custom sampling context.
kwargs (Unpack[TransactionKwargs]) – Optional keyword arguments to be passed to the Transaction constructor. See sentry_sdk.tracing.Transaction for available arguments.

Return type:

Union[Transaction, NoOpSpan]

stop_auto_session_tracking(*args, **kwargs)[source]¶

Stops automatic session tracking.

This temporarily session tracking for the current scope when called. To resume session tracking call resume_auto_session_tracking.

Return type:: None

trace_propagation_meta(*args, **kwargs)[source]¶

Return meta tags which should be injected into HTML templates to allow propagation of trace information.

Return type:: str

property transaction: Any¶: Return the transaction (root span) in the scope, if any.

update_from_kwargs(user=None, level=None, extras=None, contexts=None, tags=None, fingerprint=None)[source]¶

Update the scope’s attributes.

Return type:: None

update_from_scope(scope)[source]¶

Update the scope with another scope’s data.

Return type:: None

property user¶: When set a specific user is bound to the scope. Deprecated in favor of set_user.

class sentry_sdk.Client(dsn=None, *, max_breadcrumbs=100, release=None, environment=None, server_name=None, shutdown_timeout=2, integrations=[], in_app_include=[], in_app_exclude=[], default_integrations=True, dist=None, transport=None, transport_queue_size=100, sample_rate=1.0, send_default_pii=None, http_proxy=None, https_proxy=None, ignore_errors=[], max_request_body_size='medium', socket_options=None, keep_alive=None, before_send=None, before_breadcrumb=None, debug=None, attach_stacktrace=False, ca_certs=None, propagate_traces=True, traces_sample_rate=None, traces_sampler=None, profiles_sample_rate=None, profiles_sampler=None, profiler_mode=None, profile_lifecycle='manual', profile_session_sample_rate=None, auto_enabling_integrations=True, disabled_integrations=None, auto_session_tracking=True, send_client_reports=True, _experiments={}, proxy_headers=None, instrumenter='sentry', before_send_transaction=None, project_root=None, enable_tracing=None, include_local_variables=True, include_source_context=True, trace_propagation_targets=['.*'], functions_to_trace=[], event_scrubber=None, max_value_length=1024, enable_backpressure_handling=True, error_sampler=None, enable_db_query_source=True, db_query_source_threshold_ms=100, spotlight=None, cert_file=None, key_file=None, custom_repr=None, add_full_stack=False, max_stack_frames=100)[source]¶

class sentry_sdk.client.BaseClient(options=None)[source]¶

Added in version 2.0.0.

The basic definition of a client that is used for sending data to Sentry.

is_active()[source]¶

Return type:: bool

Added in version 2.0.0.

Returns whether the client is active (able to send data to Sentry)

class sentry_sdk.client.NonRecordingClient(options=None)[source]¶: Added in version 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.

class sentry_sdk.client._Client(*args, **kwargs)[source]¶

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 sentry_sdk.Client. (Was created for better intelisense support)

capture_event(event, hint=None, scope=None)[source]¶

Captures an event.

Parameters:

event (Event) – A ready-made event that can be directly sent to Sentry.
hint (Optional[Dict[str, Any]]) – Contains metadata about the event that can be read from before_send, such as the original exception object or a HTTP request object.
scope (Optional[Scope]) – An optional sentry_sdk.Scope to apply to events.

Return type:

Optional[str]

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.

close(timeout=None, callback=None)[source]¶

Close the client and shut down the transport. Arguments have the same semantics as Client.flush().

Return type:: None

property dsn: str | None¶: Returns the configured DSN as string.

flush(timeout=None, callback=None)[source]¶

Wait for the current events to be sent.

Parameters:

timeout (Optional[float]) – Wait for at most timeout seconds. If no timeout is provided, the shutdown_timeout option value is used.
callback (Optional[Callable[[int, float], None]]) – Is invoked with the number of pending events and the configured timeout.

Return type:

None

get_integration(name_or_class)[source]¶

Returns the integration for this client by name or class. If the client does not have that integration then None is returned.

Return type:: Optional[Integration]

is_active()[source]¶

Return type:: bool

Added in version 2.0.0.

Returns whether the client is active (able to send data to Sentry)

should_send_default_pii()[source]¶

Return type:: bool

Added in version 2.0.0.

Returns whether the client should send default PII (Personally Identifiable Information) data to Sentry.

class sentry_sdk.Transport(options=None)[source]¶

Baseclass for all transports.

A transport is used to send an event to sentry.

abstract capture_envelope(envelope)[source]¶

Send an envelope to Sentry.

Envelopes are a data container format that can hold any type of data submitted to Sentry. We use it to send all event data (including errors, transactions, crons check-ins, etc.) to Sentry.

Return type:: None

capture_event(event)[source]¶

DEPRECATED: Please use capture_envelope instead.

This gets invoked with the event dictionary when an event should be sent to sentry.

Return type:: None

flush(timeout, callback=None)[source]¶

Wait timeout seconds for the current events to be sent out.

The default implementation is a no-op, since this method may only be relevant to some transports. Subclasses should override this method if necessary.

Return type:: None

kill()[source]¶

Forcefully kills the transport.

The default implementation is a no-op, since this method may only be relevant to some transports. Subclasses should override this method if necessary.

Return type:: None

record_lost_event(reason, data_category=None, item=None, *, quantity=1)[source]¶

This increments a counter for event loss by reason and data category by the given positive-int quantity (default 1).

If an item is provided, the data category and quantity are extracted from the item, and the values passed for data_category and quantity are ignored.

When recording a lost transaction via data_category=”transaction”, the calling code should also record the lost spans via this method. When recording lost spans, quantity should be set to the number of contained spans, plus one for the transaction itself. When passing an Item containing a transaction via the item parameter, this method automatically records the lost spans.

Return type:: None

class sentry_sdk.HttpTransport(options)[source]¶

class sentry_sdk.tracing.Transaction(name='', parent_sampled=None, baggage=None, source=TransactionSource.CUSTOM, **kwargs)[source]¶

The Transaction is the root element that holds all the spans for Sentry performance instrumentation.

Parameters:

name (str) – Identifier of the transaction. Will show up in the Sentry UI.
parent_sampled (Optional[bool]) – Whether the parent transaction was sampled. If True this transaction will be kept, if False it will be discarded.
baggage (Optional[Baggage]) – The W3C baggage header value. (see https://www.w3.org/TR/baggage/)
source (str) – A string describing the source of the transaction name. This will be used to determine the transaction’s type. See https://develop.sentry.dev/sdk/event-payloads/transaction/#transaction-annotations for more information. Default “custom”.
kwargs (Unpack[SpanKwargs]) – Additional arguments to be passed to the Span constructor. See sentry_sdk.tracing.Span for available arguments.

property containing_transaction: Transaction¶: The root element of the span tree. In the case of a transaction it is the transaction itself.

finish(scope=None, end_timestamp=None, *, hub=None)[source]¶

Finishes the transaction and sends it to Sentry. All finished spans in the transaction will also be sent to Sentry.

Parameters:

scope (Optional[Scope]) – The Scope to use for this transaction. If not provided, the current Scope will be used.
end_timestamp (Union[datetime, float, None]) – Optional timestamp that should be used as timestamp instead of the current time.
hub (Optional[Hub]) – The hub to use for this transaction. This argument is DEPRECATED. Please use the scope parameter, instead.

Return type:

Optional[str]

Returns:

The event ID if the transaction was sent to Sentry, otherwise None.

get_baggage()[source]¶

Returns the Baggage associated with the Transaction.

The first time a new baggage with Sentry items is made, it will be frozen.

Return type:: Baggage

set_context(key, value)[source]¶

Sets a context. Transactions can have multiple contexts and they should follow the format described in the “Contexts Interface” documentation.

Parameters:

key (str) – The name of the context.
value (dict[str, Any]) – The information about the context.

Return type:

None

set_http_status(http_status)[source]¶

Sets the status of the Transaction according to the given HTTP status.

Parameters:: http_status (int) – The HTTP status code.
Return type:: None

set_measurement(name, value, unit='')[source]¶

Return type:: None

Deprecated since version 2.28.0: This function is deprecated and will be removed in the next major release.

to_json()[source]¶

Returns a JSON-compatible representation of the transaction.

Return type:: Dict[str, Any]

class sentry_sdk.tracing.Span(trace_id=None, span_id=None, parent_span_id=None, same_process_as_parent=True, sampled=None, op=None, description=None, hub=None, status=None, containing_transaction=None, start_timestamp=None, scope=None, origin='manual', name=None)[source]¶

A span holds timing information of a block of code. Spans can have multiple child spans thus forming a span tree.

Parameters:

trace_id (Optional[str]) – The trace ID of the root span. If this new span is to be the root span, omit this parameter, and a new trace ID will be generated.
span_id (Optional[str]) – The span ID of this span. If omitted, a new span ID will be generated.
parent_span_id (Optional[str]) – The span ID of the parent span, if applicable.
same_process_as_parent (bool) – Whether this span is in the same process as the parent span.
sampled (Optional[bool]) – Whether the span should be sampled. Overrides the default sampling decision for this span when provided.
op (Optional[str]) – The span’s operation. A list of recommended values is available here: https://develop.sentry.dev/sdk/performance/span-operations/
description (Optional[str]) –
A description of what operation is being performed within the span.

Deprecated since version 2.15.0: Please use the name parameter, instead.
name (Optional[str]) – A string describing what operation is being performed within the span.
hub (Optional[Hub]) –
The hub to use for this span.

Deprecated since version 2.0.0: Please use the scope parameter, instead.
status (Optional[str]) – The span’s status. Possible values are listed at https://develop.sentry.dev/sdk/event-payloads/span/
containing_transaction (Optional[Transaction]) – The transaction that this span belongs to.
start_timestamp (Union[datetime, float, None]) – The timestamp when the span started. If omitted, the current time will be used.
scope (Optional[Scope]) – The scope to use for this span. If not provided, we use the current scope.

property containing_transaction: Transaction | None¶: The Transaction that this span belongs to. The Transaction is the root of the span tree, so one could also think of this Transaction as the “root span”.

classmethod continue_from_environ(environ, **kwargs)[source]¶

Create a Transaction with the given params, then add in data pulled from the sentry-trace and baggage headers from the environ (if any) before returning the Transaction.

This is different from continue_from_headers() in that it assumes header names in the form HTTP_HEADER_NAME - such as you would get from a WSGI/ASGI environ - rather than the form header-name.

Parameters:: environ (Mapping[str, str]) – The ASGI/WSGI environ to pull information from.
Return type:: Transaction

classmethod continue_from_headers(headers, *, _sample_rand=None, **kwargs)[source]¶

Create a transaction with the given params (including any data pulled from the sentry-trace and baggage headers).

Parameters:

headers (Mapping[str, str]) – The dictionary with the HTTP headers to pull information from.
_sample_rand (Optional[str]) – If provided, we override the sample_rand value from the incoming headers with this value. (internal use only)

Return type:

Transaction

finish(scope=None, end_timestamp=None)[source]¶

Sets the end timestamp of the span.

Additionally it also creates a breadcrumb from the span, if the span represents a database or HTTP request.

Parameters:

scope (Optional[Scope]) – The scope to use for this transaction. If not provided, the current scope will be used.
end_timestamp (Union[datetime, float, None]) – Optional timestamp that should be used as timestamp instead of the current time.

Return type:

Optional[str]

Returns:

Always None. The type is Optional[str] to match the return value of sentry_sdk.tracing.Transaction.finish().

classmethod from_traceparent(traceparent, **kwargs)[source]¶

DEPRECATED: Use sentry_sdk.tracing.Span.continue_from_headers().

Create a Transaction with the given params, then add in data pulled from the given sentry-trace header value before returning the Transaction.

Return type:: Optional[Transaction]

iter_headers()[source]¶

Creates a generator which returns the span’s sentry-trace and baggage headers. If the span’s containing transaction doesn’t yet have a baggage value, this will cause one to be generated and stored.

Return type:: Iterator[Tuple[str, str]]

set_measurement(name, value, unit='')[source]¶

Return type:: None

Deprecated since version 2.28.0: This function is deprecated and will be removed in the next major release.

start_child(instrumenter='sentry', **kwargs)[source]¶

Start a sub-span from the current span or transaction.

Takes the same arguments as the initializer of Span. The trace id, sampling decision, transaction pointer, and span recorder are inherited from the current span/transaction.

The instrumenter parameter is deprecated for user code, and it will be removed in the next major version. Going forward, it should only be used by the SDK itself.

Return type:: Span

timestamp: Optional[datetime]¶: End timestamp of span

to_baggage()[source]¶

Returns the Baggage associated with this Span, if any. (Taken from the root of the span tree.)

Return type:: Optional[Baggage]

to_json()[source]¶

Returns a JSON-compatible representation of the span.

Return type:: Dict[str, Any]

class sentry_sdk.profiler.transaction_profiler.Profile(sampled, start_ns, hub=None, scheduler=None)[source]¶

class sentry_sdk.session.Session(sid=None, did=None, timestamp=None, started=None, duration=None, status=None, release=None, environment=None, user_agent=None, ip_address=None, errors=None, user=None, session_mode='application')[source]¶

class sentry_sdk.attachments.Attachment(bytes=None, filename=None, path=None, content_type=None, add_to_transactions=False)[source]¶

Additional files/data to send along with an event.

This class stores attachments that can be sent along with an event. Attachments are files or other data, e.g. config or log files, that are relevant to an event. Attachments are set on the Scope, and are sent along with all non-transaction events (or all events including transactions if add_to_transactions is True) that are captured within the Scope.

To add an attachment to a Scope, use sentry_sdk.Scope.add_attachment(). The parameters for add_attachment are the same as the parameters for this class’s constructor.

Parameters:

bytes (Union[None, bytes, Callable[[], bytes]]) – Raw bytes of the attachment, or a function that returns the raw bytes. Must be provided unless path is provided.
filename (Optional[str]) – The filename of the attachment. Must be provided unless path is provided.
path (Optional[str]) – Path to a file to attach. Must be provided unless bytes is provided.
content_type (Optional[str]) – The content type of the attachment. If not provided, it will be guessed from the filename parameter, if available, or the path parameter if filename is None.
add_to_transactions (bool) – Whether to add this attachment to transactions. Defaults to False.

to_envelope_item()[source]¶

Returns an envelope item for this attachment.

Return type:: Item

class sentry_sdk.scrubber.EventScrubber(denylist=None, recursive=False, send_default_pii=False, pii_denylist=None)[source]¶

scrub_dict(d)[source]¶

If a dictionary is passed to this method, the method scrubs the dictionary of any sensitive data. The method calls itself recursively on any nested dictionaries ( including dictionaries nested in lists) if self.recursive is True. This method does nothing if the parameter passed to it is not a dictionary.

Return type:: None

scrub_list(lst)[source]¶

If a list is passed to this method, the method recursively searches the list and any nested lists for any dictionaries. The method calls scrub_dict on all dictionaries it finds. If the parameter passed to this method is not a list, the method does nothing.

Return type:: None

class sentry_sdk.monitor.Monitor(transport, interval=10)[source]¶

Performs health checks in a separate thread once every interval seconds and updates the internal state. Other parts of the SDK only read this state and act accordingly.

check_health()[source]¶

Perform the actual health checks, currently only checks if the transport is rate-limited. TODO: augment in the future with more checks.

Return type:: None

class sentry_sdk.envelope.Envelope(headers=None, items=None)[source]¶: Represents a Sentry Envelope. The calling code is responsible for adhering to the constraints documented in the Sentry docs: https://develop.sentry.dev/sdk/envelopes/#data-model. In particular, each envelope may have at most one Item with type “event” or “transaction” (but not both).

class sentry_sdk.envelope.Item(payload, headers=None, type=None, content_type=None, filename=None)[source]¶

get_event()[source]¶

Returns an error event if there is one.

Return type:: Optional[Event]