Skip to content

docs: Document arguments for Span #2919

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
szokeasaurusrex merged 2 commits into from
Mar 28, 2024
Merged

docs: Document arguments for Span #2919

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c94e3ce
docs: Document arguments for Span
szokeasaurusrex Mar 28, 2024
cb9112d
Fix deprecation notice
szokeasaurusrex Mar 28, 2024
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
24 changes: 23 additions & 1 deletion sentry_sdk/tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,29 @@ def add(self, span):

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

:param trace_id: 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.
:param span_id: The span ID of this span. If omitted, a new span ID will be generated.
:param parent_span_id: The span ID of the parent span, if applicable.
:param same_process_as_parent: Whether this span is in the same process as the parent span.
:param sampled: Whether the span should be sampled. Overrides the default sampling decision
for this span when provided.
:param op: The span's operation. A list of recommended values is available here:
https://develop.sentry.dev/sdk/performance/span-operations/
:param description: A description of what operation is being performed within the span.
:param hub: The hub to use for this span.

.. deprecated:: 2.0.0
Please use the `scope` parameter, instead.
:param status: The span's status. Possible values are listed at
https://develop.sentry.dev/sdk/event-payloads/span/
:param containing_transaction: The transaction that this span belongs to.
:param start_timestamp: The timestamp when the span started. If omitted, the current time
will be used.
:param scope: The scope to use for this span. If not provided, we use the current scope.
"""

__slots__ = (
"trace_id",
Expand Down