Skip to content
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.

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

Unreal Engine plugin documentation update #11625

Merged
merged 38 commits into from
Nov 5, 2024

Conversation

tustanivsky
Copy link
Collaborator

This PR introduces the following changes to Unreal Engine plugin docs:

  • Add tracing and trace propagation features description #470, #631
  • Add notice that symbol upload can be enabled via env variable #636
  • Add notice about Android Gradle plugin fallback #633
  • Add notice that session tracking requires UE 5.2 or newer #496
  • Add options for automatic breadcrumbs #522
  • Add notice about screenshot attachment #582

Copy link

vercel bot commented Oct 21, 2024

@tustanivsky is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@bitsandfoxes bitsandfoxes left a comment

Choose a reason for hiding this comment

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

Thanks for updating those!

There seem to be 2 links that lead to non-existing pages

❌ Found 2 404s across 1 page

🌐 http://localhost:3000/platforms/unreal/tracing
    - [TracesSampler](/platforms/unreal/configuration/sampling/#setting-a-sampling-function)
    - [sample transactions](/platforms/unreal/configuration/sampling/#sampling-transaction-events)

@tustanivsky
Copy link
Collaborator Author

There seem to be 2 links that lead to non-existing pages

Good catch - we were entirely missing the Configuration/Sampling section in docs which I've added with the latest commit.

Copy link

@PlasmaDev5 PlasmaDev5 left a comment

Choose a reason for hiding this comment

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

From my side everything looks good content wise and is clear to understand how features are used.

Copy link

vercel bot commented Oct 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2024 2:45pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2024 2:45pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 29, 2024 2:45pm

Copy link
Contributor

@bitsandfoxes bitsandfoxes left a comment

Choose a reason for hiding this comment

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

This looks great technically!

docs/platforms/unreal/configuration/options.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

I do wish we could "gamify" the sample.

@bitsandfoxes bitsandfoxes requested a review from a team October 23, 2024 14:29
@bruno-garcia
Copy link
Member

I've approved the vercel build, lets see

docs/platforms/unreal/configuration/options.mdx Outdated Show resolved Hide resolved
docs/platforms/unreal/configuration/options.mdx Outdated Show resolved Hide resolved
docs/platforms/unreal/configuration/sampling.mdx Outdated Show resolved Hide resolved
docs/platforms/unreal/configuration/sampling.mdx Outdated Show resolved Hide resolved
- `sentry-trace`
- `baggage`

If you run any JavaScript applications in your distributed system, make sure that those two headers are added to your CORS allowlist and won't be blocked or stripped by your proxy servers, gateways, or firewalls.
Copy link
Member

Choose a reason for hiding this comment

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

We should prob fix this docs-wide, right? A Flutter/.NET/Kotlin/Rust app running on the browser (e.g: wasm) also has this concern. While a JS app on NodeJS doesn't.

@chargome does my statement check out?

Suggested change
If you run any JavaScript applications in your distributed system, make sure that those two headers are added to your CORS allowlist and won't be blocked or stripped by your proxy servers, gateways, or firewalls.
If you run any browser applications in your distributed system, make sure that those two headers are added to your CORS allowlist and won't be blocked or stripped by your proxy servers, gateways, or firewalls.

Copy link
Member

Choose a reason for hiding this comment

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

virtual bool Sample_Implementation(USentrySamplingContext* samplingContext, float& samplingValue) override
{
const FString& path =
*samplingContext->GetCustomSamplingContext().Find("__HttpPath");
Copy link
Member

Choose a reason for hiding this comment

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

Can we translate this to something that resonates more with an Unreal Game?

__HttpPath is IIRC what we have on ASP.NET Core.

Do we create transactions with any additional context in the SDK that we can use here in the example?

Suggested change
*samplingContext->GetCustomSamplingContext().Find("__HttpPath");
*samplingContext->GetCustomSamplingContext().Find("StartGame");

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've made an attempt to "gamify" this example by determining the sample rate based on a match's game mode. Please let me know if that makes sense

@geoffg-sentry
Copy link
Contributor

geoffg-sentry commented Oct 29, 2024

Troubleshooting some vercel issues with @bitsandfoxes, I've authorized the vercel changes

@bruno-garcia bruno-garcia merged commit ac9a141 into getsentry:master Nov 5, 2024
11 checks passed
@tustanivsky tustanivsky deleted the unreal-engine branch November 5, 2024 06:52
martinhaintz pushed a commit that referenced this pull request Nov 5, 2024
* master: (213 commits)
  Remove feature flag documentation from issue details page (#11734)
  docs(insights): Remove EA note from Queries re: MongoDB (#11735)
  docs(nuxt): `piniaIntegration` in Nuxt (#11684)
  feat(flags): Add OpenFeature and LaunchDarkly integration documentation (#11675)
  Cleaning up mermaid code and made it a bit more readable in dark mode (#11726)
  docs(scopes): Add graphics for scope forking (#11702)
  Unreal Engine plugin documentation update (#11625)
  Bump API schema to 25e528ff (#11728)
  Bump API schema to 12bd311c (#11725)
  fix dark theme resolution (#11718)
  Update sign in to go to sentry (#11723)
  getsentry/relay@4bdad17
  API examples syntax highlighting (#11715)
  feat: Convert mermaid code blocks to SVGs client side (#11690)
  Trace context is required for transactions (#11456)
  deps: Bump SDK to 8.36.0 (#11696)
  getsentry/relay@2e2587c
  MAUI screenshot `SetBeforeScreenshotCapture`(#11672)
  Add CSS rule to fix color of bold links (#11707)
  Fix small typo on web-vitals-concepts (#11706)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators Nov 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants