Skip to content

Commit b7b0d9b

Browse files
Apply suggestions from code review
Co-authored-by: Alex Krawiec <[email protected]>
1 parent f2876d3 commit b7b0d9b

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/platforms/android/configuration/options.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ UI Profiling requires SDK versions `8.7.0` or higher. Lower versions can use the
311311

312312
<ConfigKey name="profile-session-sample-rate">
313313

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).
315315

316316
</ConfigKey>
317317

@@ -320,35 +320,35 @@ A number between `0` and `1`, controlling the percentage chance the session will
320320
Whether the UI profiling lifecycle is controlled manually or based on the trace lifecycle. Possible values are:
321321

322322
- `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
324324

325325
</ConfigKey>
326326

327327
<ConfigKey name="start-profiler-on-app-start">
328328

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 <PlatformIdentifier name="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 <PlatformIdentifier name="profile-session-sample-rate" /> must be defined.
330330

331331
- 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
332332
- 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
333333

334334
</ConfigKey>
335335

336-
## Transaction Based Profiling Options
336+
## Transaction-Based Profiling Options
337337

338338
<ConfigKey name="profiles-sample-rate">
339339

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.
341341

342342
</ConfigKey>
343343

344344
<ConfigKey name="profiles-sampler">
345345

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 <PlatformIdentifier name="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 <PlatformIdentifier name="profiles-sample-rate" /> must be defined to enable transaction profiling. Setting this option will enable the legacy profiler.
347347

348348
</ConfigKey>
349349

350350
<ConfigKey name="enable-app-start-profiling">
351351

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.
353353

354354
</ConfigKey>

docs/platforms/android/profiling/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ class MyApplication : Application() {
172172
}
173173
```
174174

175-
### Enabling Transaction based Profiling
175+
### Enabling Transaction-Based Profiling
176176

177177
<Alert>
178178

0 commit comments

Comments
 (0)