You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/platforms/android/configuration/options.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -311,7 +311,7 @@ UI Profiling requires SDK versions `8.7.0` or higher. Lower versions can use the
311
311
312
312
<ConfigKeyname="profile-session-sample-rate">
313
313
314
-
A number between `0` and `1`, controlling the percentage chance the session will be profiled. `0` represents 0% while `1` represents 100%. The default is null (disabled).
314
+
A number between `0` and `1`, controlling the percentage chance that the session will be profiled. `0` represents 0% while `1` represents 100%. The default is null (disabled).
315
315
316
316
</ConfigKey>
317
317
@@ -320,35 +320,35 @@ A number between `0` and `1`, controlling the percentage chance the session will
320
320
Whether the UI profiling lifecycle is controlled manually or based on the trace lifecycle. Possible values are:
321
321
322
322
-`manual`: **default** Profiler must be started and stopped through `Sentry.startProfiler()` and `Sentry.stopProfiler()` APIs
323
-
-`trace`: Profiler is started and stopped automatically whenever a sampled trace starts and finishes
323
+
-`trace`: Profiler is started and stopped automatically whenever a sampled trace starts or finishes
324
324
325
325
</ConfigKey>
326
326
327
327
<ConfigKeyname="start-profiler-on-app-start">
328
328
329
-
A boolean value that determines whether the app start process will be profiled. When true, the startup process, including ContentProviders, Application and first Activity creation, will be profiled. Note that <PlatformIdentifiername="profile-session-sample-rate" /> must be defined.
329
+
A boolean value that determines whether the app start process will be profiled. When true, the startup process, including ContentProviders, Application, and first Activity creation, will be profiled. Note that <PlatformIdentifiername="profile-session-sample-rate" /> must be defined.
330
330
331
331
- If profileLifecycle is set to `manual`: profiling is started automatically on startup and stopProfiler must be called manually whenever the app startup is deemed to be completed
332
332
- If profileLifecycle is set to `trace`: profiling is started automatically on startup, and will automatically be stopped when the root span that is associated with app startup ends
333
333
334
334
</ConfigKey>
335
335
336
-
## TransactionBased Profiling Options
336
+
## Transaction-Based Profiling Options
337
337
338
338
<ConfigKeyname="profiles-sample-rate">
339
339
340
-
A number between `0` and `1`, controlling the percentage chance a given profile will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies only to sampled transactions created in the app. Setting this option will enable the legacy profiler.
340
+
A number between `0` and `1`, controlling the percentage chance that a given profile will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies only to sampled transactions created in the app. Setting this option will enable the legacy profiler.
341
341
342
342
</ConfigKey>
343
343
344
344
<ConfigKeyname="profiles-sampler">
345
345
346
-
A function responsible for determining the percentage chance a given profile 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 profiles, by returning 0 for those that are unwanted. Either this or <PlatformIdentifiername="profiles-sample-rate" /> must be defined to enable transaction profiling. Setting this option will enable the legacy profiler.
346
+
A function responsible for determining the percentage chance that a given profile 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 profiles, by returning 0 for those that are unwanted. Either this or <PlatformIdentifiername="profiles-sample-rate" /> must be defined to enable transaction profiling. Setting this option will enable the legacy profiler.
347
347
348
348
</ConfigKey>
349
349
350
350
<ConfigKeyname="enable-app-start-profiling">
351
351
352
-
A boolean value that determines whether the app start process will be profiled. When true, the startup process, including ContentProviders, Application and first Activity creation, will be profiled.
352
+
A boolean value that determines whether the app start process will be profiled. When true, the startup process, including ContentProviders, Application, and first Activity creation, will be profiled.
0 commit comments