Skip to content

docs(unreal): Update default feature flag values for logs and metrics #17611

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
tustanivsky merged 1 commit into from
May 5, 2026
Merged

docs(unreal): Update default feature flag values for logs and metrics #17611

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions platform-includes/logs/options/unreal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ The following configuration options are available for Sentry Logs in Unreal Engi

| Option | Description | Default |
|--------|-------------|------------|
| **Enable Structured Logging** | Master toggle for the structured logging feature | `false` |
| **Enable Structured Logging** | Master toggle for the structured logging feature | `true` |
| **Enable Debug Logs** | Forward Debug level UE_LOG calls to Sentry | `false` |
| **Enable Info Logs** | Forward Info level UE_LOG calls to Sentry | `false` |
| **Enable Warning Logs** | Forward Warning level UE_LOG calls to Sentry | `true` |
| **Enable Error Logs** | Forward Error level UE_LOG calls to Sentry | `true` |
| **Enable Fatal Logs** | Forward Fatal level UE_LOG calls to Sentry | `true` |
| **Enable Warning Logs** | Forward Warning level UE_LOG calls to Sentry | `false` |
| **Enable Error Logs** | Forward Error level UE_LOG calls to Sentry | `false` |
| **Enable Fatal Logs** | Forward Fatal level UE_LOG calls to Sentry | `false` |
| **Send Logs As Breadcrumbs** | Send UE_LOG calls BOTH as Logs and as Breadcrumbs, instead of just Logs | `false` |
| **Log Category Filter** | Array of log categories to include (empty = all categories) | Empty |
| **Before Log Callback** | Handler to modify or filter log events before sending | None |
4 changes: 0 additions & 4 deletions platform-includes/logs/usage/unreal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,6 @@ SentrySubsystem->LogInfo(TEXT("Game started")); // Includes game_version and pla
SentrySubsystem->RemoveAttribute(TEXT("platform"));
```

<Alert level="warning">
Global log attributes are not currently supported on Android. The `SetAttribute` and `RemoveAttribute` methods will be no-ops on that platform.
</Alert>

### Log Levels

Sentry Logs supports the following log levels:
Expand Down
2 changes: 1 addition & 1 deletion platform-includes/metrics/options/unreal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The following configuration options are available for Sentry's [Application Metr

| Option | Description | Default |
|--------|-------------|---------|
| **Enable Metrics** | Master toggle for the metrics feature | `false` |
| **Enable Metrics** | Master toggle for the metrics feature | `true` |
| **Collect frame time metrics** | Automatically emit frame time and per-thread performance metrics. | `false` |
| **Frame time sample interval (frames)** | Emit performance metrics every Nth frame. | `30` |
| **Collect GC pause metrics** | Emit a metric for each garbage collection pause duration. | `false` |
Expand Down
Loading