Skip to content

Commit 76391f3

Browse files
committed
Add tracing options
1 parent e7643bd commit 76391f3

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/platforms/unreal/configuration/options.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,29 @@ This function is called with an SDK-specific message or error event object, and
8585
By the time <PlatformIdentifier name="before-send" /> is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.
8686

8787
</ConfigKey>
88+
89+
## Tracing Options
90+
91+
<ConfigKey name="enable-tracing">
92+
93+
A boolean value, if true, transactions and trace data will be generated and captured. This will set the `traces-sample-rate` to the recommended default of 1.0 if `traces-sample-rate` is not defined. Note that `traces-sample-rate` and `traces-sampler` take precedence over this option.
94+
95+
</ConfigKey>
96+
97+
<ConfigKey name="traces-sample-rate">
98+
99+
A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
100+
101+
</ConfigKey>
102+
103+
<ConfigKey name="traces-sampler">
104+
105+
A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between `0` (0% chance of being sent) and `1` (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or <PlatformIdentifier name="traces-sample-rate" /> must be defined to enable tracing.
106+
107+
<Alert level="info">
108+
109+
The Unreal Engine SDK doesn't currently support sampling functions on Windows/Linux (<PlatformIdentifier name="traces-sampler" />).
110+
111+
</Alert>
112+
113+
</ConfigKey>

0 commit comments

Comments
 (0)