Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoNatan committed Nov 14, 2018
1 parent f5ebe92 commit 2fa54a5
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,24 @@ <h3>
<p>The <strong>Sampling frequency</strong> option configures how many samples should be collected every second. The more samples collected, the more accurate the profiling, at some expense of performance.</p>
<p>It is recommended to start with the default value and only increase sampling frequency if necessary.</p>
<h3>
<a name="user-content-threads" class="anchor" href="#threads"><span class="octicon octicon-link"></span></a>Threads</h3>
<p>The <strong>Record thread information</strong> option controls whether any thread information is recorded during profiling. Recording thread information can provide additional performance metrics per thread. Normally, recording thread information is not an expensive operation and should be enabled unless absolutely not needed.</p>
<p>The <strong>Collect stack traces</strong> option enables the recording of the stack trace of the heaviest thread. This provides code symbol information for additional debugging purposes. This is a relatively inexpensive operation, but depending on the sampling frequency, may have a slight performance cost.</p>
<p>The <strong>Symbolicate stack traces</strong> option enables the runtime symbolication of symbols collected in stack traces. This further assists development by creating human-readable symbols. This is a relatively inexpensive operation, but depending on the sampling frequency, may have a slight performance cost.</p>
<h3>
<a name="user-content-disk-usage" class="anchor" href="#disk-usage"><span class="octicon octicon-link"></span></a>Disk Usage</h3>
<p>The <strong>Collect open file names</strong> option enables the collection of names of files open in the app at the time of sampling. This is a relatively inexpensive operation, but depending on the sampling frequency, may have a slight performance cost.</p>
<h3>
<a name="user-content-network" class="anchor" href="#network"><span class="octicon octicon-link"></span></a>Network</h3>
<p>The <strong>Record network</strong> option controls whether any network traffic is recorded, including headers and data. Depending on your app's activity, this can take a small-to-moderate toll on performance. If network recording is not necessary, you can turn this option off to save performance.</p>
<p>The <strong>Record localhost network</strong> option extends the network recording to localhost connections as well. Depending on your app's activity, this may introduce a lot of unwanted noise. Enable if you need to profile or debug localhost connections.</p>
<h3>
<a name="user-content-threads" class="anchor" href="#threads"><span class="octicon octicon-link"></span></a>Threads</h3>
<p>The <strong>Record thread information</strong> option controls whether any thread information is recorded during profiling. Recording thread information can provide additional performance metrics per thread. Normally, recording thread information is not an expensive operation and should be enabled unless absolutely not needed.</p>
<p>The <strong>Collect stack traces</strong> option enables the recording of the stack trace of the heaviest thread. This provides code symbol information for additional debugging purposes. This is a relatively inexpensive operation, but depending on the sampling frequency, may have a slight performance cost.</p>
<p>The <strong>Symbolicate stack traces</strong> option enables the runtime symbolication of symbols collected in stack traces. This further assists development by creating human-readable symbols. This is a relatively inexpensive operation, but depending on the sampling frequency, may have a slight performance cost.</p>
<p>The <strong>Disable network cache</strong> option controls whether network cache should be disabled for requests the app makes while recording.</p>
<h3>
<a name="user-content-log" class="anchor" href="#log"><span class="octicon octicon-link"></span></a>Log</h3>
<p>The <strong>Collect log output</strong> options enables the recording of your app's log output. This can be very useful for cross-referencing your debug log output with profiling samples of your app. This is an inexpensive operation, but depending on the log output amount, may have a slight performance cost.</p>
<h3>
<a name="user-content-react-native" class="anchor" href="#react-native"><span class="octicon octicon-link"></span></a>React Native</h3>
<p>The <strong>Profile React Native (if available)</strong> options controls the React Native profiling systems in Detox Instruments and its Profiler framework. These systems provide information such as JavaScript thread performance, bridge calls and bridge data, which can be very helpful when debugging apps with React Native usage.</p>
<p>The <strong>Record bridge data</strong> option controls whether React Native bridge data is recorded during profiling. Depending on your app's activity, this can take a small-to-moderate toll on performance. If bridge data recording is not necessary, you can turn this option off to save performance.</p>
<p>The <strong>Record timers as events</strong> options controls whether React Native timers, created in JavaScript using <code>setTimeout()</code>, should be recorded as events and displayed in the Events instrument.</p>
</body></html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
4 changes: 2 additions & 2 deletions DetoxInstruments/DetoxInstruments/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@
<key>CFBundleShortVersionString</key>
<string>1.4</string>
<key>CFBundleVersion</key>
<string>7537</string>
<string>7538</string>
<key>DTXBuildDate</key>
<date>2018-11-14T13:34:11Z</date>
<date>2018-11-14T13:45:12Z</date>
<key>DTXSourceRoot</key>
<string>$(DTXSRCROOT)</string>
<key>LSMinimumSystemVersion</key>
Expand Down
2 changes: 1 addition & 1 deletion Distribution/homebrew-brew
Binary file modified Documentation/Resources/ProfilingOptions_ProfilingOptions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions Profiler/DTXProfiler/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
<key>CFBundleShortVersionString</key>
<string>1.4</string>
<key>CFBundleVersion</key>
<string>7537</string>
<string>7538</string>
<key>DTXBuildDate</key>
<date>2018-11-14T13:34:11Z</date>
<date>2018-11-14T13:45:12Z</date>
<key>NSPrincipalClass</key>
<string></string>
</dict>
Expand Down

0 comments on commit 2fa54a5

Please sign in to comment.