Skip to content

docs(native): remove mention of enable_logs/metrics #19041

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

Draft
JoshuaMoelans wants to merge 2 commits into
base: master
Choose a base branch
from
+0 −34
Draft

docs(native): remove mention of enable_logs/metrics #19041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
822cbdc
docs(native): remove mention of enable_logs/metrics
JoshuaMoelans Aug 13, 2026
6f15bc6
Merge branch 'master' into joshua/native/enable_logs_metrics_removal
JoshuaMoelans Aug 13, 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
14 changes: 0 additions & 14 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 @@ -140,12 +140,6 @@ A function responsible for determining the percentage chance a given transaction

## Logs options

<SdkOption name="enable_logs" type="bool" defaultValue="true">

This option enables the [logging integration](/platforms/native/logs), which allows the SDK to capture logs and send them to Sentry.

</SdkOption>

Comment on lines -143 to -148

@JoshuaMoelans JoshuaMoelans Aug 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBD: do we want to just remove them in their entirety, OR keep them around with a "removed in 0.x.x" warning?

<SdkOption name="before_send_log" type="function">

This function is called with an SDK-specific log object, and can return a modified log object, or `sentry_value_new_null()` to drop the log. In that case, you **must** call `sentry_value_decref(log)` before returning.
Expand All @@ -160,14 +154,6 @@ Whether calls to `sentry_log_X()` expect an attributes object as the second argu

## Metrics Options

<SdkOption name="enable_metrics" type="bool" defaultValue="true" availableSince="0.12.6">

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).
Expand Down
3 changes: 0 additions & 3 deletions docs/platforms/native/logs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ With Sentry Structured Logs, you can send text-based log information from your a

<PlatformContent includePath="logs/requirements" />

## Setup

<PlatformContent includePath="logs/setup" />

## Usage

Comment on lines 15 to 17

@sentry sentry Bot Aug 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The removal of the logging setup documentation for the Native SDK creates a risk. If merged before the corresponding SDK update, logging may silently fail for new users.
Severity: MEDIUM

Suggested Fix

To mitigate the risk of a documentation-SDK mismatch, either restore the setup instructions until the dependent SDK PR is released, or add a note explicitly stating that logs are zero-config and which SDK version is required for this behavior. This would provide clarity similar to how the Go SDK documentation handles it.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/native/logs/index.mdx#L15-L17

Potential issue: The pull request removes the "Setup" section from the Native logs
documentation, including the `enable_logs` option, assuming that logs will become
zero-config after an upcoming SDK release (`sentry-native#1980`). However, if this
documentation change is merged before the corresponding SDK is released, new users will
lack the necessary setup instructions. This will likely cause logging to fail silently,
as the SDK would still require the now-undocumented configuration. The documentation for
other zero-config SDKs, like Go, explicitly states this behavior, whereas these changes
simply remove the section, creating ambiguity.

Did we get this right? 👍 / 👎 to inform future reviews.

@JoshuaMoelans JoshuaMoelans Aug 13, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah so that's why I added the big ⚠️ ⚠️ ⚠️ to the PR description 🙃

Expand Down
8 changes: 0 additions & 8 deletions platform-includes/logs/setup/native.mdx
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions platform-includes/metrics/usage/native.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
Metrics are enabled by default. To disable metrics, set the `enable_metrics` option to `false` during SDK initialization:

```c
sentry_options_t *options = sentry_options_new();
sentry_options_set_enable_metrics(options, false);
// set other options
sentry_init(options);
```

You can send metrics using the `sentry_metrics_*()` APIs.

### Metric Types
Expand Down
Loading