From 5c557184dd299025fea6b3a826a0b6d74240a0bd Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Tue, 17 Mar 2020 12:45:26 -0700 Subject: [PATCH 01/13] New file --- devices/hololens/hololens-diagnostic-logs.md | 286 +++++++++++++++++++ 1 file changed, 286 insertions(+) create mode 100644 devices/hololens/hololens-diagnostic-logs.md diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md new file mode 100644 index 0000000000..f1a5491e7c --- /dev/null +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -0,0 +1,286 @@ +--- +title: Collect diagnostic information from HoloLens devices +description: +author: Teresa-Motiv +ms.author: v-tea +ms.date: 03/23/2020 +ms.prod: hololens +ms.mktglfcycl: manage +ms.sitesec: library +ms.topic: article +ms.custom: +- CI 115131 +- CSSTroubleshooting +audience: ITPro +ms.localizationpriority: medium +keywords: +manager: jarrettr +appliesto: +- HoloLens (1st gen) +- HoloLens 2 +--- + +# Collect diagnostic information from HoloLens devices + +Fallback diagnostic logs collect diagnostic data and store it on the HoloLens device. You can access that information from a desktop computer by using the Media Transfer Protocol (MTP). This diagnostic feature has been developed in collaboration with the Mobile Device Management (MDM) team. + +While device telemetry usually provides an initial understanding of a customer report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. + +> [!IMPORTANT] +> Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). + +***Q***: Clarify "customer" vs "user" + +## How to retrieve diagnostic log information + +There are four ways that diagnostic information can be collected from HoloLens: + +- [Feedback hub](hololens-feedback.md). +- Diagnostic Logs CSP. +- Troubleshoot in Settings app. +- Fallback Diagnostics. + +### Feedback hub + +[Feedback hub](hololens-feedback.md) + +#### What is needed to use this entry point? + +- Device is connected to network. +- Feedback hub app is accessible to customer. +- Diagnostic logs can be collected and uploaded to Microsoft cloud. + +> [!NOTE] +> **Commercial customers:** For issues related to MDM, provisioning, or any other device management aspect, etc., please file a bug under **Enterprise Management** > **Device category** + +#### When and how to trigger? + +**When** + +- Customer wants to share diagnostic logs for reporting an issue. + +**How** + +- Launch feedback hub application and submit a report using the app. + +#### User consent + +Explicit because user has agreed to terms of use of Feedback hub and is launching feedback hub to collect / share diagnostic information. + +#### Where is the data kept? + +Diagnostic information is uploaded to Microsoft cloud where it is retained for certain amount of days adhering with Next Generation Privacy (NGP). + +It is also kept on HoloLens, if the person filing the bug via feedback hub has checked following check-box, i.e. "save a local copy of diagnostics and attachments created when giving feedback". + +To delete locally retained diagnostic information, go to Feedback Hub, settings and click on the link "View diagnostics logs", so folder opens. User must be "device owner" or "admin" on the system. + +#### Who can access the data? + +Microsoft employees access diagnostic information using a NGP complaint viewer. + +This is applicable to all Feedback Hub categories. + +### Diagnostic Logs CSP + +#### What is needed to use this entry point? + +- Device is connected to network. +- Device is enrolled into MDM environment that supports Diagnostic Logs CSP. + +#### When and how to trigger? + +**When** + +- IT admin wants to remotely collect logs for investigating an issue. + +**How** + +- IT admin invokes Diagnostic Logs CSP remotely from MDM administrative portal. + +#### User consent + +Implicit because IT admin has access to device to collect / share diagnostic information. + +#### Where is the data kept? + +Data is uploaded to cloud infrastructure specified by IT admin of the environment in which HoloLens is being used. It is retained based on the policies specified by IT Admin. + +#### Who can access the data? + +IT admin and users in tenant roles that are granted access to logs. + +### Troubleshoot in Settings app + +#### What is needed to use this entry point? + +Settings app is accessible to the customer. + +#### When and how to trigger? + +**When** + +- Customer can reproduce an issue and detailed diagnostic logs are required for investigation + +**How** + +1. Go to Settings App and navigate to **Update & Security** > **Troubleshoot** page. +1. Select appropriate area, click on Start button so it can begin collecting logs. +1. Reproduce the issue, when done, come back to Settings app and click on Stop button. + +#### User consent + +Implicit because user is triggering diagnostic log collection. + +#### Where is the data kept? + +Assuming HoloLens is connected to your PC and you want to access the file using Windows Explorer, a file named Trace\.etl will exist at `This PC\\Internal Storage\Documents`. + +This file is retained locally on device unless Customer explicitly deletes it from the folder where file is accessible. + +#### Who can access the data? + +Only Customer who has access to the device unless the customer shares the information with someone else. + +### Fallback Diagnostics + +#### What is needed to use this entry point? + +> [!IMPORTANT] +> - Fallback Diagnostics on HoloLens 2 is only enabled when user is either going through OOBE and selecting Send Full Diagnostics Data or System\AllowTelemetry policy value is set to Full. +> - Available with on HoloLens (1st gen) builds on or after 17763.316. This is the same default build used by the Windows Device Recovery Tool. + +- HoloLens is connected to a PC via USB cable and powered on. +- Power and Volume buttons are functionally working together on HoloLens. + +#### When and how to trigger? + +**When** + +There are certain legitimate scenarios where user does not have access to either feedback hub, network, MDM server, UTC or stuck at UX, e.g. kiosk mode, OOBE, lock screen, autopilot, black screen, etc. This mechanism acts a "fallback" when there is no other solution to get diagnostic logs. + +**How** + +- Press and release POWER + VOLUME DOWN button on HoloLens and wait for few seconds for data collection to complete. + +#### User consent +Implicit because user is triggering specific button combination to collect diagnostic information. + +#### Where is the data kept? + +Assuming HoloLens is connected to your PC and you want to access the file using Windows Explorer, certain zip files (containing diagnostic logs) will exist at This PC\\Internal Storage\Documents. + +This file is retained locally on device unless Customer explicitly deletes it from the folder where file is accessible. + +#### Who can access the data? + +Only Customer who has access to the device unless the customer shares the information with someone else. + +## Frequently asked questions about fallback diagnostics on HoloLens + +### Does it require device to be enrolled with a MDM server? + +No. + +### How can I use Fallback Diagnostics on HoloLens? + +If a user presses and releases Power + Volume down buttons on HoloLens, data will be collected (it takes few seconds) and zip file(s) will be created (See below). + +Assuming HoloLens is connected to your PC and you want to access the files using Windows Explorer, the zip file(s) will exist at `This PC\\Internal Storage\Documents`. + +### How would I know that log collection has completed? + +Starting with HoloLens 2 there will be a file created named HololensDiagnostics.temp when log collection begins and it will be removed when it completes. There is no UX, so this is the minimum signal provided to indicate something is in progress. + +### What diagnostics files are collected as part of Fallback Diagnostics? + +The fallback diagnostics process collects one or more .zip files, depending on the version of HoloLens. The following table lists each of the possible .zip files, and the applicable versions of HoloLens. + +|File |Description |HoloLens (1st gen) |HoloLens 2 10.0.18362+ |HoloLens 2 10.0.19041+ | +| --- | --- | --- | --- | --- | +|HololensDiagnostics.zip |Contains ETL files for tracing sessions running on Hololens and diagnostic information specific to Hololens. |Yes |Yes | | +|DeviceEnrollmentDiagnostics.zip |Contains MDM, device enrollment, CSPs / policies related information. |No |Yes |Yes | +|AutoPilotDiagnostics.zip |Contains autopilot related and licensing related information.|No |No |Yes | +|TPMDiagnostics.zip | |No |No |Yes | + +> [!NOTE] +> Starting 5/2/2019 EventLog* ETL files are only collected when signed in user is "device owner". Since these ETLs may contain PII data, they are only accessible to device owners. This matches the behavior on desktop where administrators have access to event logs whiles other users do not. + +#### Sample diagnostic content for HoloLens (1st gen) + +HololensDiagnostics.zip + +- AuthLogon.etl +- EventLog-HupRe.etl.001 +- FirstExperience.etl.001 +- HetLog.etl +- HoloInput.etl.001 +- HoloShell.etl.001 +- WiFi.etl.001 + +#### Sample diagnostic content for HoloLens 2 10.0.18362+ + +HololensDiagnostics.zip + +- EventLog-Application.etl.001* +- EventLog-System.etl.001* +- AuthLogon.etl +- EventLog-HupRe.etl.001 +- FirstExperience.etl.001 +- HetLog.etl +- HoloInput.etl.001 +- HoloShell.etl.001 +- WiFi.etl.001 +- CSPsAndPolicies.etl.001 +- RadioMgr.etl +- WiFiDriverIHVSession.etl + +DeviceEnrollmentDiagnostics.zip + +- MDMDiagHtmlReport.html +- MdmDiagLogMetadata.json +- MDMDiagReport.xml +- MdmDiagReport_RegistryDump.reg +- MdmLogCollectorFootPrint.txt + +#### Sample diagnostic content for HoloLens 2 10.0.19041+ + +HololensDiagnostics.zip + +- EventLog-Application.etl.001* +- EventLog-System.etl.001* +- AuthLogon.etl +- EventLog-HupRe.etl.001 +- FirstExperience.etl.001 +- HetLog.etl +- HoloInput.etl.001 +- HoloShell.etl.001 +- WiFi.etl.001 +- CSPsAndPolicies.etl.001 +- RadioMgr.etl +- WiFiDriverIHVSession.etl +- DisplayDiagnosticData.json +- HUP Dumps + +DeviceEnrollmentDiagnostics.zip + +- MDMDiagHtmlReport.html +- MdmDiagLogMetadata.json +- MDMDiagReport.xml +- MdmDiagReport_RegistryDump.reg +- MdmLogCollectorFootPrint.txt + +AutoPilotDiagnostics.zip + +- DeviceHash_HoloLens-U5603.csv +- LicensingDiag.cab +- LicensingDiag_Output.txt +- TpmHliInfo_Output.txt +- DiagnosticLogCSP_Collector_DeviceEnrollment_\*.etl +- DiagnosticLogCSP_Collector_Autopilot_*.etl + +TPMDiagnostics.zip + +- CertReq_enrollaik_Output.txt +- CertUtil_tpminfo_Output.txt +- TPM\*.etl From f0723164dd7b0853c095469be1f13ecf0f4e62fd Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Tue, 17 Mar 2020 13:09:22 -0700 Subject: [PATCH 02/13] TOC update --- devices/hololens/TOC.md | 1 + devices/hololens/hololens-diagnostic-logs.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/devices/hololens/TOC.md b/devices/hololens/TOC.md index 8547f7cf59..b9c83bc0b2 100644 --- a/devices/hololens/TOC.md +++ b/devices/hololens/TOC.md @@ -58,6 +58,7 @@ ## [Update HoloLens](hololens-update-hololens.md) ## [Restart, reset, or recover HoloLens](hololens-recovery.md) ## [Troubleshoot HoloLens issues](hololens-troubleshooting.md) +## [Collect diagnostic information from HoloLens devices](hololens-diagnostics-logs.md) ## [Known issues for HoloLens](hololens-known-issues.md) ## [Frequently asked questions](hololens-faq.md) ## [Frequently asked security questions](hololens-faq-security.md) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index f1a5491e7c..d75d837c48 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -31,7 +31,7 @@ While device telemetry usually provides an initial understanding of a customer r ***Q***: Clarify "customer" vs "user" -## How to retrieve diagnostic log information +## How to retrieve diagnostic information There are four ways that diagnostic information can be collected from HoloLens: From c38798150b4adb9b3f6e25a186dd1d3e91b32f49 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Tue, 17 Mar 2020 16:21:27 -0700 Subject: [PATCH 03/13] revisions --- devices/hololens/TOC.md | 2 +- devices/hololens/hololens-diagnostic-logs.md | 59 ++++++++------------ 2 files changed, 23 insertions(+), 38 deletions(-) diff --git a/devices/hololens/TOC.md b/devices/hololens/TOC.md index b9c83bc0b2..8314daf903 100644 --- a/devices/hololens/TOC.md +++ b/devices/hololens/TOC.md @@ -58,7 +58,7 @@ ## [Update HoloLens](hololens-update-hololens.md) ## [Restart, reset, or recover HoloLens](hololens-recovery.md) ## [Troubleshoot HoloLens issues](hololens-troubleshooting.md) -## [Collect diagnostic information from HoloLens devices](hololens-diagnostics-logs.md) +## [Collect diagnostic information from HoloLens devices](hololens-diagnostic-logs.md) ## [Known issues for HoloLens](hololens-known-issues.md) ## [Frequently asked questions](hololens-faq.md) ## [Frequently asked security questions](hololens-faq-security.md) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index d75d837c48..8df9d2a11b 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -24,66 +24,51 @@ appliesto: Fallback diagnostic logs collect diagnostic data and store it on the HoloLens device. You can access that information from a desktop computer by using the Media Transfer Protocol (MTP). This diagnostic feature has been developed in collaboration with the Mobile Device Management (MDM) team. -While device telemetry usually provides an initial understanding of a customer report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. +While device telemetry usually provides an initial understanding of a customer report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. > [!IMPORTANT] > Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). ***Q***: Clarify "customer" vs "user" -## How to retrieve diagnostic information +## Comparing fallback diagnostic logs to other sources of diagnostic information There are four ways that diagnostic information can be collected from HoloLens: -- [Feedback hub](hololens-feedback.md). -- Diagnostic Logs CSP. -- Troubleshoot in Settings app. -- Fallback Diagnostics. +- [Feedback hub app](hololens-feedback.md). (user-driven) +- Diagnostic Logs CSP (IT Admin/enterprise-driven) +- Troubleshoot in Settings app. (user-driven) +- Fallback Diagnostics. (user-driven) ### Feedback hub -[Feedback hub](hololens-feedback.md) - -#### What is needed to use this entry point? - -- Device is connected to network. -- Feedback hub app is accessible to customer. -- Diagnostic logs can be collected and uploaded to Microsoft cloud. +A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). > [!NOTE] -> **Commercial customers:** For issues related to MDM, provisioning, or any other device management aspect, etc., please file a bug under **Enterprise Management** > **Device category** +> **Commercial customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. -#### When and how to trigger? +#### Prerequisites -**When** +- The device is connected to a network. +- The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. -- Customer wants to share diagnostic logs for reporting an issue. +Explicit. The user agrees to the terms-of-use of Feedback Hub. -**How** +#### Data storage and use -- Launch feedback hub application and submit a report using the app. +By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). -#### User consent +The Feedback Hub provides two places for the user to store diagnostic information: -Explicit because user has agreed to terms of use of Feedback hub and is launching feedback hub to collect / share diagnostic information. +- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for a number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access this information during this period. + > [!NOTE] + > These requirements apply to data in all Feedback Hub categories. -#### Where is the data kept? - -Diagnostic information is uploaded to Microsoft cloud where it is retained for certain amount of days adhering with Next Generation Privacy (NGP). - -It is also kept on HoloLens, if the person filing the bug via feedback hub has checked following check-box, i.e. "save a local copy of diagnostics and attachments created when giving feedback". - -To delete locally retained diagnostic information, go to Feedback Hub, settings and click on the link "View diagnostics logs", so folder opens. User must be "device owner" or "admin" on the system. - -#### Who can access the data? - -Microsoft employees access diagnostic information using a NGP complaint viewer. - -This is applicable to all Feedback Hub categories. +- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. ### Diagnostic Logs CSP -#### What is needed to use this entry point? +#### Prerequisites - Device is connected to network. - Device is enrolled into MDM environment that supports Diagnostic Logs CSP. @@ -112,7 +97,7 @@ IT admin and users in tenant roles that are granted access to logs. ### Troubleshoot in Settings app -#### What is needed to use this entry point? +#### Prerequisites Settings app is accessible to the customer. @@ -144,7 +129,7 @@ Only Customer who has access to the device unless the customer shares the inform ### Fallback Diagnostics -#### What is needed to use this entry point? +#### Prerequisites > [!IMPORTANT] > - Fallback Diagnostics on HoloLens 2 is only enabled when user is either going through OOBE and selecting Send Full Diagnostics Data or System\AllowTelemetry policy value is set to Full. From 35da2a5456dec7f92da5d978570b518d1f61b952 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Tue, 17 Mar 2020 18:20:49 -0700 Subject: [PATCH 04/13] Revisions --- devices/hololens/hololens-diagnostic-logs.md | 92 ++++++++------------ 1 file changed, 36 insertions(+), 56 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 8df9d2a11b..69a2a8aa3a 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -29,31 +29,27 @@ While device telemetry usually provides an initial understanding of a customer r > [!IMPORTANT] > Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). -***Q***: Clarify "customer" vs "user" - ## Comparing fallback diagnostic logs to other sources of diagnostic information -There are four ways that diagnostic information can be collected from HoloLens: +There are four ways in which users or administrators can collect diagnostic information from HoloLens: -- [Feedback hub app](hololens-feedback.md). (user-driven) +- Feedback hub app. (user-driven) - Diagnostic Logs CSP (IT Admin/enterprise-driven) - Troubleshoot in Settings app. (user-driven) - Fallback Diagnostics. (user-driven) -### Feedback hub +### Feedback Hub A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). > [!NOTE] -> **Commercial customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. +> **Commercial or enterprise customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. #### Prerequisites - The device is connected to a network. - The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. -Explicit. The user agrees to the terms-of-use of Feedback Hub. - #### Data storage and use By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). @@ -66,68 +62,52 @@ The Feedback Hub provides two places for the user to store diagnostic informatio - **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. -### Diagnostic Logs CSP +### DiagnosticLog CSP + +In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. #### Prerequisites -- Device is connected to network. -- Device is enrolled into MDM environment that supports Diagnostic Logs CSP. +- The device is connected to a network. +- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. -#### When and how to trigger? +#### Data storage and use -**When** +Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. -- IT admin wants to remotely collect logs for investigating an issue. +The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: -**How** +- The cloud infrastructure that stores the diagnostic information. +- The retention period for the diagnostic information. +- Permissions that control access to the diagnostic information. -- IT admin invokes Diagnostic Logs CSP remotely from MDM administrative portal. +### Troubleshoot by using the Settings app -#### User consent +A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: -Implicit because IT admin has access to device to collect / share diagnostic information. - -#### Where is the data kept? - -Data is uploaded to cloud infrastructure specified by IT admin of the environment in which HoloLens is being used. It is retained based on the policies specified by IT Admin. - -#### Who can access the data? - -IT admin and users in tenant roles that are granted access to logs. - -### Troubleshoot in Settings app +1. Open the Settings app and select **Update & Security** > **Troubleshoot** page. +1. Select the appropriate area, and then select **Start**. +1. Reproduce the issue. +1. After you reproduce the issue, return to Settings and select **Stop**. #### Prerequisites -Settings app is accessible to the customer. +- The Settings app is installed on the device and is available to the user. -#### When and how to trigger? +#### Data storage and use -**When** +Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. -- Customer can reproduce an issue and detailed diagnostic logs are required for investigation +The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer, in the following file: -**How** +> This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents\\Trace\<*ddmmyyhhmmss*>.etl -1. Go to Settings App and navigate to **Update & Security** > **Troubleshoot** page. -1. Select appropriate area, click on Start button so it can begin collecting logs. -1. Reproduce the issue, when done, come back to Settings app and click on Stop button. +> [!NOTE] +> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. -#### User consent +The diagnostic information remains in these locations until the user deletes it. -Implicit because user is triggering diagnostic log collection. - -#### Where is the data kept? - -Assuming HoloLens is connected to your PC and you want to access the file using Windows Explorer, a file named Trace\.etl will exist at `This PC\\Internal Storage\Documents`. - -This file is retained locally on device unless Customer explicitly deletes it from the folder where file is accessible. - -#### Who can access the data? - -Only Customer who has access to the device unless the customer shares the information with someone else. - -### Fallback Diagnostics +### Fallback diagnostics #### Prerequisites @@ -163,7 +143,7 @@ Only Customer who has access to the device unless the customer shares the inform ## Frequently asked questions about fallback diagnostics on HoloLens -### Does it require device to be enrolled with a MDM server? +### Does the device have to be enrolled with a MDM server? No. @@ -183,13 +163,13 @@ The fallback diagnostics process collects one or more .zip files, depending on t |File |Description |HoloLens (1st gen) |HoloLens 2 10.0.18362+ |HoloLens 2 10.0.19041+ | | --- | --- | --- | --- | --- | -|HololensDiagnostics.zip |Contains ETL files for tracing sessions running on Hololens and diagnostic information specific to Hololens. |Yes |Yes | | -|DeviceEnrollmentDiagnostics.zip |Contains MDM, device enrollment, CSPs / policies related information. |No |Yes |Yes | -|AutoPilotDiagnostics.zip |Contains autopilot related and licensing related information.|No |No |Yes | -|TPMDiagnostics.zip | |No |No |Yes | +|HololensDiagnostics.zip |Contains ETL files for tracing sessions running on Hololens and diagnostic information specific to Hololens. |✔️ |✔️ |✔️ | +|DeviceEnrollmentDiagnostics.zip |Contains MDM, device enrollment, CSPs / policies related information. | |✔️ |✔️ | +|AutoPilotDiagnostics.zip |Contains autopilot related and licensing related information.| | |✔️ | +|TPMDiagnostics.zip | | | |✔️ | > [!NOTE] -> Starting 5/2/2019 EventLog* ETL files are only collected when signed in user is "device owner". Since these ETLs may contain PII data, they are only accessible to device owners. This matches the behavior on desktop where administrators have access to event logs whiles other users do not. +> Starting May 2, 2019, the fallback diagnostics process collects EventLog* .etl files only when the signed-in user is the Device owner. This is because these files may contain PII data. Such data is accessible to only device owners. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log file but other users do not. #### Sample diagnostic content for HoloLens (1st gen) From da9e1d836b1bce81e6099af5411fa18553e8fcb8 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Tue, 17 Mar 2020 18:35:29 -0700 Subject: [PATCH 05/13] revisions --- devices/hololens/hololens-diagnostic-logs.md | 27 ++++++++++---------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 69a2a8aa3a..7e84e0c8ba 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -109,27 +109,28 @@ The diagnostic information remains in these locations until the user deletes it. ### Fallback diagnostics +The fallback diagnostics process provides a way for the user to gather diagnostic information when no other methods are available. Such scenarios include the following: + +- The network or network-based resources (such as Feedback Hub, MDM, and so forth) are not available. +- The device is "stuck" or locked in a state where normal troubleshooting capabilities (such as the Settings app) are not available. Such scenarios include the Out-of-Box-Experience (OOBE), kiosk mode, or a locked or "hung" user interface. + +On the device, press the Power and Volume Down buttons at the same time and then release them. Wait for few seconds for the data collection to complete. + #### Prerequisites +- The device is connected to a computer by using a USB cable. +- The device is powered on. +- The Power and Volume buttons on the device are functioning correctly. + + > [!IMPORTANT] > - Fallback Diagnostics on HoloLens 2 is only enabled when user is either going through OOBE and selecting Send Full Diagnostics Data or System\AllowTelemetry policy value is set to Full. > - Available with on HoloLens (1st gen) builds on or after 17763.316. This is the same default build used by the Windows Device Recovery Tool. -- HoloLens is connected to a PC via USB cable and powered on. -- Power and Volume buttons are functionally working together on HoloLens. +#### Data storage and use -#### When and how to trigger? +Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. -**When** - -There are certain legitimate scenarios where user does not have access to either feedback hub, network, MDM server, UTC or stuck at UX, e.g. kiosk mode, OOBE, lock screen, autopilot, black screen, etc. This mechanism acts a "fallback" when there is no other solution to get diagnostic logs. - -**How** - -- Press and release POWER + VOLUME DOWN button on HoloLens and wait for few seconds for data collection to complete. - -#### User consent -Implicit because user is triggering specific button combination to collect diagnostic information. #### Where is the data kept? From 854e7e35c8ed180bf6203e991ae5c34f2133caf6 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Wed, 18 Mar 2020 10:03:04 -0700 Subject: [PATCH 06/13] Revisions --- devices/hololens/hololens-diagnostic-logs.md | 176 ++++++++++--------- 1 file changed, 91 insertions(+), 85 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 7e84e0c8ba..28c4ed58e8 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -1,5 +1,5 @@ --- -title: Collect diagnostic information from HoloLens devices +title: Collect and use fallback diagnostic information from HoloLens devices description: author: Teresa-Motiv ms.author: v-tea @@ -20,7 +20,7 @@ appliesto: - HoloLens 2 --- -# Collect diagnostic information from HoloLens devices +# Collect and use fallback diagnostic information from HoloLens devices Fallback diagnostic logs collect diagnostic data and store it on the HoloLens device. You can access that information from a desktop computer by using the Media Transfer Protocol (MTP). This diagnostic feature has been developed in collaboration with the Mobile Device Management (MDM) team. @@ -29,84 +29,6 @@ While device telemetry usually provides an initial understanding of a customer r > [!IMPORTANT] > Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). -## Comparing fallback diagnostic logs to other sources of diagnostic information - -There are four ways in which users or administrators can collect diagnostic information from HoloLens: - -- Feedback hub app. (user-driven) -- Diagnostic Logs CSP (IT Admin/enterprise-driven) -- Troubleshoot in Settings app. (user-driven) -- Fallback Diagnostics. (user-driven) - -### Feedback Hub - -A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). - -> [!NOTE] -> **Commercial or enterprise customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. - -#### Prerequisites - -- The device is connected to a network. -- The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. - -#### Data storage and use - -By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). - -The Feedback Hub provides two places for the user to store diagnostic information: - -- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for a number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access this information during this period. - > [!NOTE] - > These requirements apply to data in all Feedback Hub categories. - -- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. - -### DiagnosticLog CSP - -In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. - -#### Prerequisites - -- The device is connected to a network. -- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. - -#### Data storage and use - -Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. - -The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: - -- The cloud infrastructure that stores the diagnostic information. -- The retention period for the diagnostic information. -- Permissions that control access to the diagnostic information. - -### Troubleshoot by using the Settings app - -A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: - -1. Open the Settings app and select **Update & Security** > **Troubleshoot** page. -1. Select the appropriate area, and then select **Start**. -1. Reproduce the issue. -1. After you reproduce the issue, return to Settings and select **Stop**. - -#### Prerequisites - -- The Settings app is installed on the device and is available to the user. - -#### Data storage and use - -Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. - -The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer, in the following file: - -> This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents\\Trace\<*ddmmyyhhmmss*>.etl - -> [!NOTE] -> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. - -The diagnostic information remains in these locations until the user deletes it. - ### Fallback diagnostics The fallback diagnostics process provides a way for the user to gather diagnostic information when no other methods are available. Such scenarios include the following: @@ -162,12 +84,12 @@ Starting with HoloLens 2 there will be a file created named HololensDiagnostics. The fallback diagnostics process collects one or more .zip files, depending on the version of HoloLens. The following table lists each of the possible .zip files, and the applicable versions of HoloLens. -|File |Description |HoloLens (1st gen) |HoloLens 2 10.0.18362+ |HoloLens 2 10.0.19041+ | +|File |Contents |HoloLens (1st gen) |HoloLens 2 10.0.18362+ |HoloLens 2 10.0.19041+ | | --- | --- | --- | --- | --- | -|HololensDiagnostics.zip |Contains ETL files for tracing sessions running on Hololens and diagnostic information specific to Hololens. |✔️ |✔️ |✔️ | -|DeviceEnrollmentDiagnostics.zip |Contains MDM, device enrollment, CSPs / policies related information. | |✔️ |✔️ | -|AutoPilotDiagnostics.zip |Contains autopilot related and licensing related information.| | |✔️ | -|TPMDiagnostics.zip | | | |✔️ | +|HololensDiagnostics.zip |Files for tracing sessions that ran on the device.

Diagnostic information that's specific to Hololens. |✔️ |✔️ |✔️ | +|DeviceEnrollmentDiagnostics.zip |Information that's related to MDM, device enrollment, CSPs, and policies. | |✔️ |✔️ | +|AutoPilotDiagnostics.zip |Information that's related to autopilot and licensing.| | |✔️ | +|TPMDiagnostics.zip |Information that's related to the trusted platform module (TPM) on the device | | |✔️ | > [!NOTE] > Starting May 2, 2019, the fallback diagnostics process collects EventLog* .etl files only when the signed-in user is the Device owner. This is because these files may contain PII data. Such data is accessible to only device owners. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log file but other users do not. @@ -250,3 +172,87 @@ TPMDiagnostics.zip - CertReq_enrollaik_Output.txt - CertUtil_tpminfo_Output.txt - TPM\*.etl + +## How do fallback diagnostic logs compare to other sources of diagnostic information? + +There are four ways in which users or administrators can collect diagnostic information from HoloLens: + +- Feedback hub app. (user-driven) +- Diagnostic Logs CSP (IT Admin/enterprise-driven) +- Troubleshoot in Settings app. (user-driven) +- Fallback Diagnostics. (user-driven) + +|Method |Prerequisites |Data locations |Data access and use |Data retention | +| --- | --- | --- | --- | --- | +|[Feedback Hub](#feedback-hub) |
  • Network and internet connection
  • Feedback Hub app
  • Permission to upload files to the Microsoft cloud
    • |
      • Microsoft cloud
      • HoloLens device (optional)
      |
      • User requests assistance, agrees to the terms of use, and uploads the data
      • Microsoft employees view the data, as consistent with the terms of use
      |
      • Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically
      • Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | + +### Feedback Hub + +A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). + +> [!NOTE] +> **Commercial or enterprise customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. + +#### Prerequisites + +- The device is connected to a network. +- The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. + +#### Data storage and use + +By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). + +The Feedback Hub provides two places for the user to store diagnostic information: + +- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for a number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access this information during this period. + > [!NOTE] + > These requirements apply to data in all Feedback Hub categories. + +- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. + +### DiagnosticLog CSP + +In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. + +#### Prerequisites + +- The device is connected to a network. +- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. + +#### Data storage and use + +Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. + +The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: + +- The cloud infrastructure that stores the diagnostic information. +- The retention period for the diagnostic information. +- Permissions that control access to the diagnostic information. + +### Troubleshoot by using the Settings app + +A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: + +1. Open the Settings app and select **Update & Security** > **Troubleshoot** page. +1. Select the appropriate area, and then select **Start**. +1. Reproduce the issue. +1. After you reproduce the issue, return to Settings and select **Stop**. + +#### Prerequisites + +- The Settings app is installed on the device and is available to the user. + +#### Data storage and use + +Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. + +The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer, in the following file: + +> This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents\\Trace\<*ddmmyyhhmmss*>.etl + +> [!NOTE] +> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. + +The diagnostic information remains in these locations until the user deletes it. + + From f2e549d71dda9c6eed038df9bf31ed3c1cdc8d0b Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Wed, 18 Mar 2020 12:03:16 -0700 Subject: [PATCH 07/13] Revisions --- devices/hololens/hololens-diagnostic-logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 28c4ed58e8..bf5a2b2d8b 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -184,7 +184,7 @@ There are four ways in which users or administrators can collect diagnostic info |Method |Prerequisites |Data locations |Data access and use |Data retention | | --- | --- | --- | --- | --- | -|[Feedback Hub](#feedback-hub) |
        • Network and internet connection
        • Feedback Hub app
        • Permission to upload files to the Microsoft cloud
          • |
            • Microsoft cloud
            • HoloLens device (optional)
            |
            • User requests assistance, agrees to the terms of use, and uploads the data
            • Microsoft employees view the data, as consistent with the terms of use
            |
            • Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically
            • Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | +|[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | ### Feedback Hub From 294d4a1b4d28b68b406bdff9a09c696d624a6737 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Wed, 18 Mar 2020 12:48:16 -0700 Subject: [PATCH 08/13] Revisions --- devices/hololens/hololens-diagnostic-logs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index bf5a2b2d8b..895f41ebb3 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -53,7 +53,6 @@ On the device, press the Power and Volume Down buttons at the same time and then Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. - #### Where is the data kept? Assuming HoloLens is connected to your PC and you want to access the file using Windows Explorer, certain zip files (containing diagnostic logs) will exist at This PC\\Internal Storage\Documents. @@ -184,7 +183,10 @@ There are four ways in which users or administrators can collect diagnostic info |Method |Prerequisites |Data locations |Data access and use |Data retention | | --- | --- | --- | --- | --- | +|Fallback diagnostics |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | |[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | +|[DiagnosticLog CSP](#diagnosticlog-csp) |Network connection

              MDM environment that supports the DiagnosticLog CSP |Administrator configures storage locations |In the managed environment, the user implicitly consents to administrator access to the data.

              Administrator configures access roles and permissions. | Administrator configures retention policy. | +|[Settings app](#troubleshoot-by-using-the-settings-app) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | ### Feedback Hub @@ -254,5 +256,3 @@ The diagnostic information is stored on the device. If the device is connected t > In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. The diagnostic information remains in these locations until the user deletes it. - - From 1e971b6f5f7c29e54d809c145e65ebfa0e4388af Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Wed, 18 Mar 2020 14:53:17 -0700 Subject: [PATCH 09/13] Revisions --- devices/hololens/hololens-diagnostic-logs.md | 94 +++++++++++--------- 1 file changed, 53 insertions(+), 41 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 895f41ebb3..6ad5838f37 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -22,64 +22,75 @@ appliesto: # Collect and use fallback diagnostic information from HoloLens devices -Fallback diagnostic logs collect diagnostic data and store it on the HoloLens device. You can access that information from a desktop computer by using the Media Transfer Protocol (MTP). This diagnostic feature has been developed in collaboration with the Mobile Device Management (MDM) team. - While device telemetry usually provides an initial understanding of a customer report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. -> [!IMPORTANT] -> Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). - -### Fallback diagnostics - -The fallback diagnostics process provides a way for the user to gather diagnostic information when no other methods are available. Such scenarios include the following: +The fallback diagnostics process provides a way for you to gather diagnostic information when no other methods are available. Such scenarios include the following: - The network or network-based resources (such as Feedback Hub, MDM, and so forth) are not available. - The device is "stuck" or locked in a state where normal troubleshooting capabilities (such as the Settings app) are not available. Such scenarios include the Out-of-Box-Experience (OOBE), kiosk mode, or a locked or "hung" user interface. -On the device, press the Power and Volume Down buttons at the same time and then release them. Wait for few seconds for the data collection to complete. +> [!IMPORTANT] +> - On HoloLens 2 devices, you can use fallback diagnostics only under the following conditions: +> - During the Out-of-the-Box-Experience (OOBE) and when you select **Send Full Diagnostics Data**. +> - When the environment's Group Policy enforces the **System\AllowTelemetry** policy value of **Full**. +> - On HoloLens (1st gen) devices, you can use fallback diagnostics on HoloLens version 17763.316 or a later version. This version is the version that the Windows Device Recovery Tool restores when it resets the device. -#### Prerequisites +> [!IMPORTANT] +> Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). + +## How to use fallback diagnostics + +Before you start the fallback diagnostics process, make sure of the following: - The device is connected to a computer by using a USB cable. - The device is powered on. - The Power and Volume buttons on the device are functioning correctly. +To collect fallback diagnostic information, follow these steps: -> [!IMPORTANT] -> - Fallback Diagnostics on HoloLens 2 is only enabled when user is either going through OOBE and selecting Send Full Diagnostics Data or System\AllowTelemetry policy value is set to Full. -> - Available with on HoloLens (1st gen) builds on or after 17763.316. This is the same default build used by the Windows Device Recovery Tool. +1. On the device, press the Power and Volume Down buttons at the same time and then release them. +1. Wait for few seconds while the device collects the data. -#### Data storage and use +## Data locations -Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. +The device stores the data locally, and you can access that information from the connected desktop computer at the following location: -#### Where is the data kept? +> This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents -Assuming HoloLens is connected to your PC and you want to access the file using Windows Explorer, certain zip files (containing diagnostic logs) will exist at This PC\\Internal Storage\Documents. +For more information about the files that the fallback diagnostics process collects, see [What diagnostics files does the fallback diagnostics process collect?](#what-diagnostics-files-does-the-fallback-diagnostics-process-collect). -This file is retained locally on device unless Customer explicitly deletes it from the folder where file is accessible. + |Data access and use |Data retention -#### Who can access the data? +## Data access, use, and retention -Only Customer who has access to the device unless the customer shares the information with someone else. +Because you store the data yourself, only you have access to the data. If you choose to share the data with another user, you implicitly grant permission for that user to access or store the data. + +The data remains until you delete it. ## Frequently asked questions about fallback diagnostics on HoloLens -### Does the device have to be enrolled with a MDM server? +### Does the device have to be enrolled with an MDM server? No. -### How can I use Fallback Diagnostics on HoloLens? +### How can I use fallback diagnostics on HoloLens? -If a user presses and releases Power + Volume down buttons on HoloLens, data will be collected (it takes few seconds) and zip file(s) will be created (See below). +Before you start the fallback diagnostics process, make sure of the following: -Assuming HoloLens is connected to your PC and you want to access the files using Windows Explorer, the zip file(s) will exist at `This PC\\Internal Storage\Documents`. +- The device is connected to a computer by using a USB cable. +- The device is powered on. +- The Power and Volume buttons on the device are functioning correctly. -### How would I know that log collection has completed? +To collect fallback diagnostic information, follow these steps: -Starting with HoloLens 2 there will be a file created named HololensDiagnostics.temp when log collection begins and it will be removed when it completes. There is no UX, so this is the minimum signal provided to indicate something is in progress. +1. On the device, press the Power and Volume Down buttons at the same time and then release them. +1. Wait for few seconds while the device collects the data. -### What diagnostics files are collected as part of Fallback Diagnostics? +### How would I know that data collection has completed? + +The fallback diagnostics process does not have a user interface. On HoloLens 2, the process creates a file that is named HololensDiagnostics.temp when it begins collecting data. When the process finishes, it removes the file. + +### What diagnostics files does the fallback diagnostics process collect? The fallback diagnostics process collects one or more .zip files, depending on the version of HoloLens. The following table lists each of the possible .zip files, and the applicable versions of HoloLens. @@ -172,14 +183,15 @@ TPMDiagnostics.zip - CertUtil_tpminfo_Output.txt - TPM\*.etl -## How do fallback diagnostic logs compare to other sources of diagnostic information? +### How does the fallback diagnostic process compare to other sources of diagnostic information? -There are four ways in which users or administrators can collect diagnostic information from HoloLens: +In addition to fallback diagnostics, HoloLens users and administrators have three other methods to choose from to collect diagnostic information from HoloLens: -- Feedback hub app. (user-driven) -- Diagnostic Logs CSP (IT Admin/enterprise-driven) -- Troubleshoot in Settings app. (user-driven) -- Fallback Diagnostics. (user-driven) +- Feedback Hub app +- DiagnosticLog CSP +- Settings app + +The following table compares each of these methods to fallback diagnostics. The table includes links to more detailed information that follows the table. |Method |Prerequisites |Data locations |Data access and use |Data retention | | --- | --- | --- | --- | --- | @@ -188,19 +200,19 @@ There are four ways in which users or administrators can collect diagnostic info |[DiagnosticLog CSP](#diagnosticlog-csp) |Network connection

              MDM environment that supports the DiagnosticLog CSP |Administrator configures storage locations |In the managed environment, the user implicitly consents to administrator access to the data.

              Administrator configures access roles and permissions. | Administrator configures retention policy. | |[Settings app](#troubleshoot-by-using-the-settings-app) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | -### Feedback Hub +#### Feedback Hub A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). > [!NOTE] > **Commercial or enterprise customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. -#### Prerequisites +**Prerequisites** - The device is connected to a network. - The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. -#### Data storage and use +**Data locations, access, and retention** By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). @@ -216,12 +228,12 @@ The Feedback Hub provides two places for the user to store diagnostic informatio In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. -#### Prerequisites +**Prerequisites** - The device is connected to a network. - The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. -#### Data storage and use +**Data locations, access, and retention** Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. @@ -231,7 +243,7 @@ The IT administrator uses the DiagnosticLog CSP to configure the data storage, r - The retention period for the diagnostic information. - Permissions that control access to the diagnostic information. -### Troubleshoot by using the Settings app +#### Troubleshoot by using the Settings app A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: @@ -240,11 +252,11 @@ A HoloLens user can use the Settings app on the device to troubleshoot problems 1. Reproduce the issue. 1. After you reproduce the issue, return to Settings and select **Stop**. -#### Prerequisites +**Prerequisites** - The Settings app is installed on the device and is available to the user. -#### Data storage and use +**Data locations, access, and retention** Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. From b44b2bd81ad6256213c11556dd5f7885956cb5ea Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Wed, 18 Mar 2020 16:14:30 -0700 Subject: [PATCH 10/13] Tweaks --- devices/hololens/hololens-diagnostic-logs.md | 24 +++++++++----------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 6ad5838f37..5086bba988 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -22,7 +22,7 @@ appliesto: # Collect and use fallback diagnostic information from HoloLens devices -While device telemetry usually provides an initial understanding of a customer report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. +While device telemetry usually provides an initial understanding of a problem report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. The fallback diagnostics process provides a way for you to gather diagnostic information when no other methods are available. Such scenarios include the following: @@ -59,8 +59,6 @@ The device stores the data locally, and you can access that information from the For more information about the files that the fallback diagnostics process collects, see [What diagnostics files does the fallback diagnostics process collect?](#what-diagnostics-files-does-the-fallback-diagnostics-process-collect). - |Data access and use |Data retention - ## Data access, use, and retention Because you store the data yourself, only you have access to the data. If you choose to share the data with another user, you implicitly grant permission for that user to access or store the data. @@ -96,17 +94,17 @@ The fallback diagnostics process collects one or more .zip files, depending on t |File |Contents |HoloLens (1st gen) |HoloLens 2 10.0.18362+ |HoloLens 2 10.0.19041+ | | --- | --- | --- | --- | --- | -|HololensDiagnostics.zip |Files for tracing sessions that ran on the device.

              Diagnostic information that's specific to Hololens. |✔️ |✔️ |✔️ | +|HololensDiagnostics.zip |Files for tracing sessions that ran on the device.

              Diagnostic information that's specific to Hololens. |✔️ |✔️ |✔️ | |DeviceEnrollmentDiagnostics.zip |Information that's related to MDM, device enrollment, CSPs, and policies. | |✔️ |✔️ | |AutoPilotDiagnostics.zip |Information that's related to autopilot and licensing.| | |✔️ | |TPMDiagnostics.zip |Information that's related to the trusted platform module (TPM) on the device | | |✔️ | > [!NOTE] -> Starting May 2, 2019, the fallback diagnostics process collects EventLog* .etl files only when the signed-in user is the Device owner. This is because these files may contain PII data. Such data is accessible to only device owners. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log file but other users do not. +> Starting May 2, 2019, the fallback diagnostics process collects EventLog*.etl files only when the signed-in user is the Device owner. This is because these files may contain PII data. Such data is accessible to only device owners. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log file but other users do not. #### Sample diagnostic content for HoloLens (1st gen) -HololensDiagnostics.zip +HololensDiagnostics.zip contains files such as the following: - AuthLogon.etl - EventLog-HupRe.etl.001 @@ -118,7 +116,7 @@ HololensDiagnostics.zip #### Sample diagnostic content for HoloLens 2 10.0.18362+ -HololensDiagnostics.zip +HololensDiagnostics.zip contains files such as the following: - EventLog-Application.etl.001* - EventLog-System.etl.001* @@ -133,7 +131,7 @@ HololensDiagnostics.zip - RadioMgr.etl - WiFiDriverIHVSession.etl -DeviceEnrollmentDiagnostics.zip +DeviceEnrollmentDiagnostics.zip contains files such as the following: - MDMDiagHtmlReport.html - MdmDiagLogMetadata.json @@ -143,7 +141,7 @@ DeviceEnrollmentDiagnostics.zip #### Sample diagnostic content for HoloLens 2 10.0.19041+ -HololensDiagnostics.zip +HololensDiagnostics.zip contains files such as the following: - EventLog-Application.etl.001* - EventLog-System.etl.001* @@ -158,9 +156,9 @@ HololensDiagnostics.zip - RadioMgr.etl - WiFiDriverIHVSession.etl - DisplayDiagnosticData.json -- HUP Dumps +- HUP dumps -DeviceEnrollmentDiagnostics.zip +DeviceEnrollmentDiagnostics.zip contains files such as the following: - MDMDiagHtmlReport.html - MdmDiagLogMetadata.json @@ -168,7 +166,7 @@ DeviceEnrollmentDiagnostics.zip - MdmDiagReport_RegistryDump.reg - MdmLogCollectorFootPrint.txt -AutoPilotDiagnostics.zip +AutoPilotDiagnostics.zip contains files such as the following: - DeviceHash_HoloLens-U5603.csv - LicensingDiag.cab @@ -177,7 +175,7 @@ AutoPilotDiagnostics.zip - DiagnosticLogCSP_Collector_DeviceEnrollment_\*.etl - DiagnosticLogCSP_Collector_Autopilot_*.etl -TPMDiagnostics.zip +TPMDiagnostics.zip contains files such as the following: - CertReq_enrollaik_Output.txt - CertUtil_tpminfo_Output.txt From 2fe110120e2a67be9b365bb3b379fc8259628647 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Thu, 19 Mar 2020 12:45:39 -0700 Subject: [PATCH 11/13] Tech review feedback --- devices/hololens/hololens-diagnostic-logs.md | 207 ++++++++++--------- 1 file changed, 104 insertions(+), 103 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 5086bba988..46a33ea8e9 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -1,5 +1,5 @@ --- -title: Collect and use fallback diagnostic information from HoloLens devices +title: Collect and use diagnostic information from HoloLens devices description: author: Teresa-Motiv ms.author: v-tea @@ -20,9 +20,99 @@ appliesto: - HoloLens 2 --- -# Collect and use fallback diagnostic information from HoloLens devices +# Collect and use diagnostic information from HoloLens devices -While device telemetry usually provides an initial understanding of a problem report, some issues require a broader and deeper understanding of the device state. When you investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. +HoloLens users and administrators have four methods to choose from to collect diagnostic information from HoloLens: + +- Feedback Hub app +- DiagnosticLog CSP +- Settings app +- Fallback diagnostics + +> [!IMPORTANT] +> Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). + +The following table compares the four methods. The table includes links to more detailed information that follows the table. + +|Method |Prerequisites |Data locations |Data access and use |Data retention | +| --- | --- | --- | --- | --- | +|[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | +|[DiagnosticLog CSP](#diagnosticlog-csp) |Network connection

              MDM environment that supports the DiagnosticLog CSP |Administrator configures storage locations |In the managed environment, the user implicitly consents to administrator access to the data.

              Administrator configures access roles and permissions. | Administrator configures retention policy. | +|[Settings app](#troubleshoot-by-using-the-settings-app) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | +|Fallback diagnostics |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | + +## Feedback Hub + +A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). + +> [!NOTE] +> **Commercial or enterprise users:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. + +### Prerequisites + +- The device is connected to a network. +- The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. + +### Data locations, access, and retention + +By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). + +The Feedback Hub provides two places for the user to store diagnostic information: + +- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for a number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access this information during this period. + > [!NOTE] + > These requirements apply to data in all Feedback Hub categories. + +- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. + +## DiagnosticLog CSP + +In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. + +### Prerequisites + +- The device is connected to a network. +- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. + +### Data locations, access, and retention + +Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. + +The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: + +- The cloud infrastructure that stores the diagnostic information. +- The retention period for the diagnostic information. +- Permissions that control access to the diagnostic information. + +## Troubleshoot by using the Settings app + +A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: + +1. Open the Settings app and select **Update & Security** > **Troubleshoot** page. +1. Select the appropriate area, and then select **Start**. +1. Reproduce the issue. +1. After you reproduce the issue, return to Settings and select **Stop**. + +### Prerequisites + +- The Settings app is installed on the device and is available to the user. + +### Data locations, access, and retention + +Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. + +The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer, in the following file: + +> This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents\\Trace\<*ddmmyyhhmmss*>.etl + +> [!NOTE] +> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. + +The diagnostic information remains in these locations until the user deletes it. + +## Fallback diagnostics + +While device telemetry usually provides an initial understanding of a problem report, some issues require a broader and deeper understanding of the device state. When you (as a user or as an administrator) investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. The fallback diagnostics process provides a way for you to gather diagnostic information when no other methods are available. Such scenarios include the following: @@ -35,10 +125,7 @@ The fallback diagnostics process provides a way for you to gather diagnostic inf > - When the environment's Group Policy enforces the **System\AllowTelemetry** policy value of **Full**. > - On HoloLens (1st gen) devices, you can use fallback diagnostics on HoloLens version 17763.316 or a later version. This version is the version that the Windows Device Recovery Tool restores when it resets the device. -> [!IMPORTANT] -> Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). - -## How to use fallback diagnostics +### How to use fallback diagnostics Before you start the fallback diagnostics process, make sure of the following: @@ -51,7 +138,7 @@ To collect fallback diagnostic information, follow these steps: 1. On the device, press the Power and Volume Down buttons at the same time and then release them. 1. Wait for few seconds while the device collects the data. -## Data locations +### Data locations The device stores the data locally, and you can access that information from the connected desktop computer at the following location: @@ -59,19 +146,19 @@ The device stores the data locally, and you can access that information from the For more information about the files that the fallback diagnostics process collects, see [What diagnostics files does the fallback diagnostics process collect?](#what-diagnostics-files-does-the-fallback-diagnostics-process-collect). -## Data access, use, and retention +### Data access, use, and retention Because you store the data yourself, only you have access to the data. If you choose to share the data with another user, you implicitly grant permission for that user to access or store the data. The data remains until you delete it. -## Frequently asked questions about fallback diagnostics on HoloLens +### Frequently asked questions about fallback diagnostics on HoloLens -### Does the device have to be enrolled with an MDM server? +#### Does the device have to be enrolled with an MDM server? No. -### How can I use fallback diagnostics on HoloLens? +#### How can I use fallback diagnostics on HoloLens? Before you start the fallback diagnostics process, make sure of the following: @@ -84,11 +171,11 @@ To collect fallback diagnostic information, follow these steps: 1. On the device, press the Power and Volume Down buttons at the same time and then release them. 1. Wait for few seconds while the device collects the data. -### How would I know that data collection has completed? +#### How would I know that data collection has completed? The fallback diagnostics process does not have a user interface. On HoloLens 2, the process creates a file that is named HololensDiagnostics.temp when it begins collecting data. When the process finishes, it removes the file. -### What diagnostics files does the fallback diagnostics process collect? +#### What diagnostics files does the fallback diagnostics process collect? The fallback diagnostics process collects one or more .zip files, depending on the version of HoloLens. The following table lists each of the possible .zip files, and the applicable versions of HoloLens. @@ -102,7 +189,7 @@ The fallback diagnostics process collects one or more .zip files, depending on t > [!NOTE] > Starting May 2, 2019, the fallback diagnostics process collects EventLog*.etl files only when the signed-in user is the Device owner. This is because these files may contain PII data. Such data is accessible to only device owners. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log file but other users do not. -#### Sample diagnostic content for HoloLens (1st gen) +**Sample diagnostic content for HoloLens (1st gen)** HololensDiagnostics.zip contains files such as the following: @@ -114,7 +201,7 @@ HololensDiagnostics.zip contains files such as the following: - HoloShell.etl.001 - WiFi.etl.001 -#### Sample diagnostic content for HoloLens 2 10.0.18362+ +**Sample diagnostic content for HoloLens 2 10.0.18362+** HololensDiagnostics.zip contains files such as the following: @@ -139,7 +226,7 @@ DeviceEnrollmentDiagnostics.zip contains files such as the following: - MdmDiagReport_RegistryDump.reg - MdmLogCollectorFootPrint.txt -#### Sample diagnostic content for HoloLens 2 10.0.19041+ +**Sample diagnostic content for HoloLens 2 10.0.19041+** HololensDiagnostics.zip contains files such as the following: @@ -180,89 +267,3 @@ TPMDiagnostics.zip contains files such as the following: - CertReq_enrollaik_Output.txt - CertUtil_tpminfo_Output.txt - TPM\*.etl - -### How does the fallback diagnostic process compare to other sources of diagnostic information? - -In addition to fallback diagnostics, HoloLens users and administrators have three other methods to choose from to collect diagnostic information from HoloLens: - -- Feedback Hub app -- DiagnosticLog CSP -- Settings app - -The following table compares each of these methods to fallback diagnostics. The table includes links to more detailed information that follows the table. - -|Method |Prerequisites |Data locations |Data access and use |Data retention | -| --- | --- | --- | --- | --- | -|Fallback diagnostics |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | -|[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | -|[DiagnosticLog CSP](#diagnosticlog-csp) |Network connection

              MDM environment that supports the DiagnosticLog CSP |Administrator configures storage locations |In the managed environment, the user implicitly consents to administrator access to the data.

              Administrator configures access roles and permissions. | Administrator configures retention policy. | -|[Settings app](#troubleshoot-by-using-the-settings-app) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | - -#### Feedback Hub - -A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). - -> [!NOTE] -> **Commercial or enterprise customers:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. - -**Prerequisites** - -- The device is connected to a network. -- The Feedback Hub app is available on the user's desktop computer, and the user can upload files to the Microsoft cloud. - -**Data locations, access, and retention** - -By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). - -The Feedback Hub provides two places for the user to store diagnostic information: - -- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for a number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access this information during this period. - > [!NOTE] - > These requirements apply to data in all Feedback Hub categories. - -- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. - -### DiagnosticLog CSP - -In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. - -**Prerequisites** - -- The device is connected to a network. -- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. - -**Data locations, access, and retention** - -Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. - -The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: - -- The cloud infrastructure that stores the diagnostic information. -- The retention period for the diagnostic information. -- Permissions that control access to the diagnostic information. - -#### Troubleshoot by using the Settings app - -A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: - -1. Open the Settings app and select **Update & Security** > **Troubleshoot** page. -1. Select the appropriate area, and then select **Start**. -1. Reproduce the issue. -1. After you reproduce the issue, return to Settings and select **Stop**. - -**Prerequisites** - -- The Settings app is installed on the device and is available to the user. - -**Data locations, access, and retention** - -Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. - -The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer, in the following file: - -> This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents\\Trace\<*ddmmyyhhmmss*>.etl - -> [!NOTE] -> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. - -The diagnostic information remains in these locations until the user deletes it. From 07a81e3ca4a7eb14af00ec9e040d94084513d9a6 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Thu, 19 Mar 2020 12:51:00 -0700 Subject: [PATCH 12/13] Changes from TR --- devices/hololens/hololens-diagnostic-logs.md | 44 ++++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 46a33ea8e9..14131d7943 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -37,9 +37,9 @@ The following table compares the four methods. The table includes links to more |Method |Prerequisites |Data locations |Data access and use |Data retention | | --- | --- | --- | --- | --- | |[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | +|[Settings Troubleshooter](#settings-troubleshooter) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | |[DiagnosticLog CSP](#diagnosticlog-csp) |Network connection

              MDM environment that supports the DiagnosticLog CSP |Administrator configures storage locations |In the managed environment, the user implicitly consents to administrator access to the data.

              Administrator configures access roles and permissions. | Administrator configures retention policy. | -|[Settings app](#troubleshoot-by-using-the-settings-app) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | -|Fallback diagnostics |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | +|[Fallback diagnostics](#fallback-diagnostics) |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | ## Feedback Hub @@ -65,26 +65,7 @@ The Feedback Hub provides two places for the user to store diagnostic informatio - **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. -## DiagnosticLog CSP - -In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. - -### Prerequisites - -- The device is connected to a network. -- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. - -### Data locations, access, and retention - -Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. - -The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: - -- The cloud infrastructure that stores the diagnostic information. -- The retention period for the diagnostic information. -- Permissions that control access to the diagnostic information. - -## Troubleshoot by using the Settings app +## Settings Troubleshooter A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: @@ -110,6 +91,25 @@ The diagnostic information is stored on the device. If the device is connected t The diagnostic information remains in these locations until the user deletes it. +## DiagnosticLog CSP + +In a Mobile Device Management (MDM) environment, the IT administrator can use the the [DiagnosticLog configuration service provider (CSP)](https://docs.microsoft.com/windows/client-management/mdm/diagnosticlog-csp) to configure diagnostic settings on enrolled HoloLens devices. The IT administrator can configure these settings to collect logs from enrolled devices. + +### Prerequisites + +- The device is connected to a network. +- The device is enrolled in an MDM environment that supports the DiagnosticLog CSP. + +### Data locations, access, and retention + +Because the device is part of the managed environment, the user implicitly consents to administrative access to diagnostic information. + +The IT administrator uses the DiagnosticLog CSP to configure the data storage, retention, and access policies, including the policies that govern the following: + +- The cloud infrastructure that stores the diagnostic information. +- The retention period for the diagnostic information. +- Permissions that control access to the diagnostic information. + ## Fallback diagnostics While device telemetry usually provides an initial understanding of a problem report, some issues require a broader and deeper understanding of the device state. When you (as a user or as an administrator) investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. From 6fe463b5491dfaa3d30771b2667faa6ed7b9a0c0 Mon Sep 17 00:00:00 2001 From: Teresa-Motiv Date: Mon, 23 Mar 2020 12:11:08 -0700 Subject: [PATCH 13/13] Changes from editor --- devices/hololens/hololens-diagnostic-logs.md | 52 ++++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/devices/hololens/hololens-diagnostic-logs.md b/devices/hololens/hololens-diagnostic-logs.md index 14131d7943..212f936079 100644 --- a/devices/hololens/hololens-diagnostic-logs.md +++ b/devices/hololens/hololens-diagnostic-logs.md @@ -22,7 +22,7 @@ appliesto: # Collect and use diagnostic information from HoloLens devices -HoloLens users and administrators have four methods to choose from to collect diagnostic information from HoloLens: +HoloLens users and administrators can choose from among four different methods to collect diagnostic information from HoloLens: - Feedback Hub app - DiagnosticLog CSP @@ -30,20 +30,20 @@ HoloLens users and administrators have four methods to choose from to collect di - Fallback diagnostics > [!IMPORTANT] -> Device diagnostic logs contain PII information, such as information about what processes or applications that the user launched during typical operations. When multiple users share a HoloLens device, for example, when users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts, the diagnostic logs may contain PII information that pertains to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). +> Device diagnostic logs contain personally identifiable information (PII), such as about what processes or applications the user starts during typical operations. When multiple users share a HoloLens device (for example, users sign in to the same device by using different Microsoft Azure Active Directory (AAD) accounts) the diagnostic logs may contain PII information that applies to multiple users. For more information, see [Microsoft Privacy statement](https://privacy.microsoft.com/privacystatement). -The following table compares the four methods. The table includes links to more detailed information that follows the table. +The following table compares the four collection methods. The method names link to more detailed information in the sections that follow the table. |Method |Prerequisites |Data locations |Data access and use |Data retention | | --- | --- | --- | --- | --- | -|[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period defined by Next Generation Privacy (NGP), after which it is deleted automatically

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | -|[Settings Troubleshooter](#settings-troubleshooter) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | +|[Feedback Hub](#feedback-hub) |Network and internet connection

              Feedback Hub app

              Permission to upload files to the Microsoft cloud |Microsoft cloud

              HoloLens device (optional) |User requests assistance, agrees to the terms of use, and uploads the data

              Microsoft employees view the data, as consistent with the terms of use |Data in the cloud is retained for the period that is defined by Next Generation Privacy (NGP). Then the data is deleted automatically.

              Data on the device can be deleted at any time by a user who has **Device owner** or **Admin** permissions. | +|[Settings Troubleshooter](#settings-troubleshooter) |Settings app |HoloLens device

              Connected computer (optional) |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data is retained until the user deletes it. | |[DiagnosticLog CSP](#diagnosticlog-csp) |Network connection

              MDM environment that supports the DiagnosticLog CSP |Administrator configures storage locations |In the managed environment, the user implicitly consents to administrator access to the data.

              Administrator configures access roles and permissions. | Administrator configures retention policy. | -|[Fallback diagnostics](#fallback-diagnostics) |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data remains until the user deletes it. | +|[Fallback diagnostics](#fallback-diagnostics) |Device configuration:
              • Powered on and connected to computer
              • Power and Volume buttons functioning
              |HoloLens device

              Connected computer |The user stores the data, and only the user accesses the data (unless the user specifically shares the data with another user). |The data is retained until the user deletes it. | ## Feedback Hub -A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). +A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnostic information to Microsoft Support. For details and complete instructions, see [Give us feedback](hololens-feedback.md). > [!NOTE] > **Commercial or enterprise users:** If you use the Feedback Hub app to report a problem that relates to MDM, provisioning, or any other device management aspect, change the app category to **Enterprise Management** > **Device category**. @@ -55,24 +55,24 @@ A HoloLens user can use the Microsoft Feedback Hub desktop app to send diagnosti ### Data locations, access, and retention -By agreeing to the terms-of-use of Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). +By agreeing to the terms-of-use of the Feedback Hub, the user explicitly consents to the storage and usage of the data (as defined by that agreement). The Feedback Hub provides two places for the user to store diagnostic information: -- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for a number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access this information during this period. +- **The Microsoft cloud**. Data that the user uploads by using the Feedback Hub app is stored for the number of days that is consistent with Next Generation Privacy (NGP) requirements. Microsoft employees can use an NGP-compliant viewer to access the information during this period. > [!NOTE] > These requirements apply to data in all Feedback Hub categories. -- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. +- **The HoloLens device**. While filing a report in Feedback Hub, the user can select **Save a local copy of diagnostics and attachments created when giving feedback**. If the user selects this option, the Feedback Hub stores a copy of the diagnostic information on the HoloLens device. This information remains accessible to the user (or anyone that uses that account to sign in to HoloLens). To delete this information, a user must have **Device owner** or **Admin** permissions on the device. A user who has the appropriate permissions can sign in to the Feedback Hub, select **Settings** > **View diagnostics logs**, and delete the information. ## Settings Troubleshooter A HoloLens user can use the Settings app on the device to troubleshoot problems and collect diagnostic information. To do this, follow these steps: 1. Open the Settings app and select **Update & Security** > **Troubleshoot** page. -1. Select the appropriate area, and then select **Start**. +1. Select the appropriate area, and select **Start**. 1. Reproduce the issue. -1. After you reproduce the issue, return to Settings and select **Stop**. +1. After you reproduce the issue, return to Settings and then select **Stop**. ### Prerequisites @@ -80,14 +80,14 @@ A HoloLens user can use the Settings app on the device to troubleshoot problems ### Data locations, access, and retention -Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone that the user shares the data with, can access the data. +Because the user starts the data collection, the user implicitly consents to the storage of the diagnostic information. Only the user, or anyone with whom that the user shares the data, can access the data. -The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer, in the following file: +The diagnostic information is stored on the device. If the device is connected to the user's computer, the information also resides on the computer in the following file: > This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents\\Trace\<*ddmmyyhhmmss*>.etl > [!NOTE] -> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device. \<*ddmmyyhhmmss*> represents the date and time that the file was created. +> In this file path and name, \<*HoloLens device name*> represents the name of the HoloLens device, and \<*ddmmyyhhmmss*> represents the date and time that the file was created. The diagnostic information remains in these locations until the user deletes it. @@ -112,17 +112,17 @@ The IT administrator uses the DiagnosticLog CSP to configure the data storage, r ## Fallback diagnostics -While device telemetry usually provides an initial understanding of a problem report, some issues require a broader and deeper understanding of the device state. When you (as a user or as an administrator) investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. +While device telemetry usually provides an initial understanding of a problem report, some issues require a broader and deeper understanding of the device state. When you (as a user or an administrator) investigate such issues, diagnostic logs that reside on the device are more useful than the basic device telemetry. -The fallback diagnostics process provides a way for you to gather diagnostic information when no other methods are available. Such scenarios include the following: +The fallback diagnostics process provides a way for you to gather diagnostic information if no other methods are available. Such scenarios include the following: -- The network or network-based resources (such as Feedback Hub, MDM, and so forth) are not available. -- The device is "stuck" or locked in a state where normal troubleshooting capabilities (such as the Settings app) are not available. Such scenarios include the Out-of-Box-Experience (OOBE), kiosk mode, or a locked or "hung" user interface. +- The network or network-based resources (such as the Feedback Hub, MDM, and so on) are not available. +- The device is "stuck" or locked in a state in which usual troubleshooting capabilities (such as the Settings app) are not available. Such scenarios include the Out-of-Box-Experience (OOBE), kiosk mode, and a locked or "hung" user interface. > [!IMPORTANT] -> - On HoloLens 2 devices, you can use fallback diagnostics only under the following conditions: +> - On HoloLens 2 devices, you can use fallback diagnostics under the following conditions only: > - During the Out-of-the-Box-Experience (OOBE) and when you select **Send Full Diagnostics Data**. -> - When the environment's Group Policy enforces the **System\AllowTelemetry** policy value of **Full**. +> - If the environment's Group Policy enforces the **System\AllowTelemetry** policy value of **Full**. > - On HoloLens (1st gen) devices, you can use fallback diagnostics on HoloLens version 17763.316 or a later version. This version is the version that the Windows Device Recovery Tool restores when it resets the device. ### How to use fallback diagnostics @@ -140,7 +140,7 @@ To collect fallback diagnostic information, follow these steps: ### Data locations -The device stores the data locally, and you can access that information from the connected desktop computer at the following location: +The device stores the data locally. You can access that information from the connected desktop computer at the following location: > This PC\\\<*HoloLens device name*>\\Internal Storage\\Documents @@ -154,7 +154,7 @@ The data remains until you delete it. ### Frequently asked questions about fallback diagnostics on HoloLens -#### Does the device have to be enrolled with an MDM server? +#### Does the device have to be enrolled with an MDM system? No. @@ -171,9 +171,9 @@ To collect fallback diagnostic information, follow these steps: 1. On the device, press the Power and Volume Down buttons at the same time and then release them. 1. Wait for few seconds while the device collects the data. -#### How would I know that data collection has completed? +#### How would I know that data collection finished? -The fallback diagnostics process does not have a user interface. On HoloLens 2, the process creates a file that is named HololensDiagnostics.temp when it begins collecting data. When the process finishes, it removes the file. +The fallback diagnostics process does not have a user interface. On HoloLens 2, when the process starts to collect data, it creates a file that is named HololensDiagnostics.temp. When the process finishes, it removes the file. #### What diagnostics files does the fallback diagnostics process collect? @@ -187,7 +187,7 @@ The fallback diagnostics process collects one or more .zip files, depending on t |TPMDiagnostics.zip |Information that's related to the trusted platform module (TPM) on the device | | |✔️ | > [!NOTE] -> Starting May 2, 2019, the fallback diagnostics process collects EventLog*.etl files only when the signed-in user is the Device owner. This is because these files may contain PII data. Such data is accessible to only device owners. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log file but other users do not. +> Starting on May 2, 2019, the fallback diagnostics process collects EventLog*.etl files only if the signed-in user is the device owner. This is because these files may contain PII data. Such data is accessible to device owners only. This behavior matches the behavior of Windows desktop computers, where administrators have access to event log files but other users do not. **Sample diagnostic content for HoloLens (1st gen)**