Skip to content

feat(native): docs on extending performance API with explicit timings #12041

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
merged 2 commits into from
Dec 4, 2024
Merged

feat(native): docs on extending performance API with explicit timings #12041

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf780b2
add docs on explicit timed API
JoshuaMoelans Dec 4, 2024
02649df
rephrasing
JoshuaMoelans Dec 4, 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
15 changes: 15 additions & 0 deletions docs/platforms/native/common/tracing/instrumentation/custom-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ To capture transactions and spans customized to your organization's needs, you m

<PlatformContent includePath="performance/add-spans-example" />

## Custom Timestamps
Sometimes you want to measure timings in code that cannot call Native SDK functions directly (like GPU shaders). For these cases, the following explicitly timed functions can be used.
- `sentry_transaction_start_ts`
- `sentry_transaction_finish_ts`
- `sentry_transaction_start_child_ts`
- `sentry_transaction_start_child_ts_n`
- `sentry_span_start_child_ts`
- `sentry_span_start_child_ts_n`
- `sentry_span_finish_ts`

They only differ from their non-timestamped counterparts by taking an additional timestamp parameter, which is the unix epoch offset in microseconds.

When using these functions, you should ensure that the provided timestamps are consistent. It is recommended to use the normal interface with automatic timestamping, and to only use the explicitly timed interface when absolutely necessary.


<PlatformContent includePath="performance/concurrency" />

<PlatformContent includePath="performance/connect-errors-spans" />
Expand Down
Loading