docs (Unreal/logs): Add Logs documentation for Unreal SDK #15064
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 1.01kB (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
mujacica
force-pushed
the
feat/unreal_logs
branch
from
e377a38 to
c6070a3
Compare
mujacica
force-pushed
the
feat/unreal_logs
branch
from
633ad77 to
2c3fac0
Compare
mujacica
force-pushed
the
feat/unreal_logs
branch
3 times, most recently
from
95ac53c to
77c40fb
Compare
| Settings->EnableErrorLogs = true; | ||
| Settings->EnableFatalLogs = true; | ||
|
|
||
| Settings->bSendBreadcrumbsWithStructuredLogging = false; // Send as structured logs instead of breadcrumbs |
There was a problem hiding this comment.
This trips me up. To me this reads like I can send logs as breadcrumbs. Like I have a choice between structured logs and breadcrumbs.
There was a problem hiding this comment.
That's exactly correct, up until now all UE_LOGs were being sent as Breadcrumbs. With the new feature implemented we still allow users to chose either/or both.
Co-authored-by: Ivan Tustanivskyi <tustanivsky@gmail.com>
Co-authored-by: Ivan Tustanivskyi <tustanivsky@gmail.com>
Co-authored-by: Ivan Tustanivskyi <tustanivsky@gmail.com>
Co-authored-by: Ivan Tustanivskyi <tustanivsky@gmail.com>
mujacica
force-pushed
the
feat/unreal_logs
branch
from
77c40fb to
125134e
Compare
| TArray<FString> AllowedCategories; | ||
| AllowedCategories.Add(TEXT("LogGameFlow")); | ||
| AllowedCategories.Add(TEXT("LogPlayerSystem")); | ||
| AllowedCategories.Add(TEXT("LogSentrySdk")); |
There was a problem hiding this comment.
Maybe we don't add this to the snippet and end up with users copy-pasting this into their game. 😁
| UE_LOG(LogTemp, Log, TEXT("Debug information")); // Only sent if EnableInfoLogs = true | ||
| ``` | ||
|
|
||
| You can configure whether these logs are sent as: |
There was a problem hiding this comment.
I think it's the "sent" that reads confusing to me. "Sent as strucutured logs" vs "captured and added to an event"?
There was a problem hiding this comment.
Actually this is correct, we can send these logs either as Structured logs or as Breadcrumbs (was behavior until now). So from now on UE_LOGs should come as Logs, and users can still opt-back for the Breadcrumbs option too.
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
Note
Adds Unreal Engine Logs documentation (setup, usage, options, default attributes) and links it from Getting Started under a new Gaming section, removing Unreal from Upcoming SDKs.
docs/platforms/unreal/logs/index.mdxwith requirements, setup, usage, options, default attributes, and performance considerations.platform-includes/logs/requirements/unreal.mdxplatform-includes/logs/setup/unreal.mdx(project settings, programmatic config, UE_LOG forwarding, category filtering, before-log handler)platform-includes/logs/usage/unreal.mdx(AddLog API, levels mapping, UE_LOG integration, Blueprint support)platform-includes/logs/options/unreal.mdx(config table)platform-includes/logs/default-attributes/unreal.mdx(core + user-mobile attributes)docs/product/explore/logs/getting-started/index.mdx):platform="unreal"to/platforms/unreal/logs/.Written by Cursor Bugbot for commit 125134e. This will update automatically on new commits. Configure here.