sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

unclear what args can/should be provided to `start_transaction` or what they mean

Open admackin opened this issue 3 years ago • 2 comments

Core or SDK?

Platform/SDK

Which part? Which one?

Python SDK

Description

I want to manually instrument using start_transaction function as documented here. The docs mention the function but I can't find info anywhere on that docs page or in the pydocs in the source code what kwargs I can or should pass, and what their effect is. what does op mean? what about name. Similar issues apply to start_span

Suggested Solution

document kwargs we might want to pass to start_transaction and start_span and what they actually do.

admackin avatar May 27 '22 05:05 admackin

Routing to @getsentry/team-web-sdk-backend for triage. ⏲️

getsentry-release avatar May 27 '22 13:05 getsentry-release

Version 2.0 of the Sentry SDK will contain better documentation for start_transaction in the form of type hints and documentation of all parameters in the API docs. The last step to resolving this issue will be to add a link to the API docs to direct users to discover the available parameters there. We can only do this once 2.0 is released

szokeasaurusrex avatar Mar 28 '24 15:03 szokeasaurusrex