Skip to content

Commit 874d604

Browse files
author
David Kline (ANALOG)
committed
first draft diags getting started, placeholder docs
1 parent 6094a31 commit 874d604

File tree

8 files changed

+89
-0
lines changed

8 files changed

+89
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Configuring the Diagnostics System
2+
3+
The diagnostics system profile provides options for configuring:
4+
- [General Settings](#general-settings)
5+
- [Profiler Settings](#profiler-settings)
6+
7+
## General Settings
8+
9+
<< >>
10+
11+
## Profiler Settings
12+
13+
<< >>
14+
15+
## See Also
16+
17+
- [Diagnostics System](DiagnosticsSystemGettingStarted.md)
18+
- [Using the Visual Profiler](UsingVisualProfiler.md)
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Diagnostic System
2+
3+
The Mixed Reality Toolkit Diagnostics System provides diagnostic tools that run within the
4+
application to enable analysis of application issues.
5+
6+
The first release of the diagnostics system contains the Visual Profiler to allow for analyzing
7+
performance issues while using the application.
8+
9+
## Getting Started
10+
11+
> It is **_highly_** recommended that the diagnostics system be enabled throughout the entire product
12+
development cycle and disabled as the last change prior to building and releasing the final version.
13+
14+
1. [Enable](#enable-diagnostics) the diagnostic system
15+
2. [Configure](#configure-diagnostic-options) diagnostic options
16+
3. [Build and deploy](#build-and-deploy)
17+
18+
### Enable Diagnostics
19+
20+
The diagnostics system is managed by the MixedRealityToolkit object (or another
21+
[service registrar](xref:Microsoft.MixedReality.Toolkit.IMixedRealityServiceRegistrar) component).
22+
23+
> The following steps presume use of the MixedRealityToolkit object. Steps required for other service registrars may be different.
24+
25+
1. Select the MixedRealityToolkit object in the scene hierarchy.
26+
27+
![MRTK Configured Scene Hierarchy](../../External/ReadMeImages/MRTK_ConfiguredHierarchy.png)
28+
29+
2. Navigate the Inspector panel to the Diagnostics System section and check Enable
30+
31+
![Enable the Diagnostics System](../../External/ReadMeImages/Diagnostics/MRTKConfig_Diagnostics.png)
32+
33+
3. Select the Diagnostics System implementation
34+
35+
![Select the Diagnostics System Implementation](../../External/ReadMeImages/Diagnostics/DiagnosticsSelectSystemType.png)
36+
37+
> Users of the default profile (DefaultMixedRealityToolkitConfigurationProfile) will have the
38+
diagnostics system pre-configured to use the MixedRealityDiagnosticsSystem object.
39+
40+
### Configure Diagnostic Options
41+
42+
The diagnostics system uses a configuration profile to specify which components are to be displayed
43+
and to configure their settings. Please see [Configuring the Diagnostics System](ConfiguringDiagnostics.md)
44+
for more information pertaining to the available component settings.
45+
46+
![Diagnostics Options](../../External/ReadMeImages/Diagnostics/DiagnosticsProfile.png)
47+
48+
### Build and Deploy
49+
50+
Once the diagnostic system is configured with the desired options, the project can be built
51+
and deployed to the target platform.
52+
53+
> While it is possible to use Unity's Play Mode while developing applications without requiring the build
54+
and deploy steps, it is important to evaluate the diagnostics system results using a compiled application
55+
running on the target hardware and platform. Performance diagnostics, such as the Visual Profiler, may not
56+
accurately reflect actual application performance when run from within the editor.
57+
58+
## See Also
59+
60+
- [Diagnostics API documentation](xref:Microsoft.MixedReality.Toolkit.Diagnostics)
61+
- [Configuring the Diagnostics System](ConfiguringDiagnostics.md)
62+
- [Using the Visual Profiler](UsingVisualProfiler.md)
63+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Using the Visual Profiler
2+
3+
<< >>
4+
5+
## See Also
6+
7+
- [Diagnostics System](DiagnosticsSystemGettingStarted.md)
8+
- [Configuring the Diagnostics System](ConfiguringDiagnostics.md)
2.82 KB
Loading
4.61 KB
Loading
9.62 KB
Loading
16.3 KB
Loading
505 Bytes
Loading

0 commit comments

Comments
 (0)