Skip to content

fix: Change Python span first span ending to finish() #16122

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

Closed
sentrivana wants to merge 1 commit into from
Closed

fix: Change Python span first span ending to finish() #16122

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: 5 additions & 4 deletions develop-docs/sdk/telemetry/spans/span-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,13 @@ interface Span {
class Span:
span_id: str

def finish(self, end_timestamp: Optional[Union[float, datetime.datetime]]) -> None: ...
def set_attribute(self, key: str, value: SpanAttributeValue) -> None: ...
def remove_attribute(self, key: str) -> None: ...
def get_attributes(self) -> SpanAttributes: ...
def set_status(self, status: Literal["ok", "error"]) -> None: ...
def get_name(self) -> str: ...
def set_name(self, name: str) -> None: ...
def get_attributes(self) -> SpanAttributes: ...
```

When implementing the span interface, consider the following guidelines:
Expand Down Expand Up @@ -107,7 +108,7 @@ with start_span(
# flexibility when to end the span:

span = start_span(name, attributes, parent_span, active)
span.end()
span.finish()
```

SDKs MUST allow specifying the following options to be passed to `startSpan`:
Expand Down Expand Up @@ -195,7 +196,7 @@ with sentry_sdk.start_span(name="checkout", attributes={"user.id": "123"}) as ch

span = sentry_sdk.start_span(name="log-order", parent_span=None)
log_order()
span.end()
span.finish()
```

```Dart {tabTitle:Dart}
Expand Down Expand Up @@ -239,4 +240,4 @@ unrelatedSpan.end();
on('checkout-finished', (timestamp) {
checkoutSpan.end(endTimestamp: timestamp);
});
```
```