Skip to content

docs(native): Document metrics options #18975

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
limbonaut merged 6 commits into from
Aug 10, 2026
+16 −0
Merged

docs(native): Document metrics options #18975

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
313d9b8
docs(native): Document metrics options
limbonaut Aug 7, 2026
88ef6d9
docs(native): Note the decref required to drop from before_send hooks
limbonaut Aug 7, 2026
b096dd4
Merge branch 'master' into limbonaut/docs/native-metrics-options
limbonaut Aug 10, 2026
963740c
Apply suggestion
limbonaut Aug 10, 2026
5b434e7
Drop changes to other options unrelated to metrics
limbonaut Aug 10, 2026
cd28740
Merge branch 'master' into limbonaut/docs/native-metrics-options
limbonaut Aug 10, 2026
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
16 changes: 16 additions & 0 deletions docs/platforms/native/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,22 @@ Whether calls to `sentry_log_X()` expect an attributes object as the second argu

</SdkOption>

## Metrics Options

<SdkOption name="enable_metrics" type="bool" defaultValue="true" availableSince="0.12.6">
Comment thread
limbonaut marked this conversation as resolved.

This option enables [Application Metrics](/platforms/native/metrics). When disabled, all calls to `sentry_metrics_*()` are no-ops.

Metrics have been enabled by default since `0.13.5`. In earlier versions they were experimental and had to be turned on explicitly.

</SdkOption>

<SdkOption name="before_send_metric" type="function" availableSince="0.12.6">

This function is called with an SDK-specific metric object, and can return a modified metric object, or `sentry_value_new_null()` to drop the metric. In that case, you **must** call `sentry_value_decref(metric)` before returning. An example can be found on the [Metrics page](/platforms/native/metrics/#before_send_metric).

</SdkOption>

## App Hang Options

These options control in-process app-hang detection. See the [App Hangs page](/platforms/native/app-hangs/) for a full explanation and usage example.
Expand Down
Loading