More formatting updates

This commit is contained in:
ManikaDhiman 2019-11-19 11:26:10 -08:00
parent 256f328b57
commit e118e6e8f4

View File

@ -15,11 +15,11 @@ ms.date: 11/19/2019
# DiagnosticLog CSP
The DiagnosticLog configuration service provider (CSP) provides the following feature areas:
- [DiagnosticArchive area: Capture and upload event logs, log files and registry values for troubleshooting](#DiagnosticArchive-area:-Capture-and-upload-event-logs,-log-files-and-registry-values-for-troubleshooting)
- [Policy area: Configure Windows event log policies such as maximum log size](#Policy-area:-Configure-Windows-event-log-policies-such-as-maximum-log-size)
- [EtwLog area: Control ETW trace sessions](#EtwLog-area:-control-etw-trace-sessions)
- [DeviceStateData area: Additional device information](#DeviceStateData-area:-Additional-device-information)
- [FileDownload area: Pull trace and state data directly from the device](#FileDownload-area:-Pull-trace-and-state-data-directly-from-the-device)
- [DiagnosticArchive area](#diagnosticarchive-area). Capture and upload event logs, log files, and registry values for troubleshooting.
- [Policy area](#policy-area). Configure Windows event log policies, such as maximum log size.
- [EtwLog area](#etwlog-area). Control ETW trace sessions.
- [DeviceStateData area](#devicestatedata-area). Provide additional device information.
- [FileDownload area](#filedownload-area). Pull trace and state data directly from the device.
Here are the links to the DDFs:
- [DiagnosticLog CSP version 1.4](diagnosticlog-ddf.md#version-1-4)
@ -35,7 +35,8 @@ The root node for the DiagnosticLog CSP.
Rest of the nodes in this CSP are described within their respective feature area sections.
## DiagnosticArchive area: Capture and upload event logs, log files and registry values for troubleshooting
## DiagnosticArchive area
The DiagnosticArchive functionality within the DiagnosticLog CSP is used to trigger devices to gather troubleshooting data into a zip archive file and upload that archive to cloud storage. DiagnosticArchive is designed for ad-hoc troubleshooting scenarios, such as an IT admin investigating an app installation failure using a collection of event log events, registry values, and app or OS log files.
> [!Note]
@ -209,7 +210,9 @@ Each data gathering node is annotated with the HRESULT of the action and the col
The zip file which is created also contains a results.xml file whose contents align to the Data section in the SyncML for ArchiveResults. Accordingly, an IT admin using the zip file for troubleshooting can determine the order and success of each directive without needing a permanent record of the SyncML value for DiagnosticArchive/ArchiveResults.
## Policy area: Configure Windows event log policies such as maximum log size
## Policy area
The Policy functionality within the DiagnosticLog CSP configures Windows event log policies, such as maximum log size.
The following section describes the nodes for the Policy functionality.
@ -680,10 +683,11 @@ Replace **Enabled**
</SyncML>
```
## EtwLog area: Control ETW trace sessions
## EtwLog area
The Event Tracing for Windows (ETW) log feature of the DiagnosticLog CSP is used to control the following types of event tracing:
- Collector-based tracing
- Channel-based tracing
- [Collector-based tracing](#collector-based-tracing)
- [Channel-based tracing](#channel-based-tracing)
The ETW log feature is designed for advanced usage, and assumes developers' familiarity with ETW. For more information, see [About Event Tracing](https://docs.microsoft.com/windows/win32/etw/about-event-tracing).
@ -1251,7 +1255,9 @@ Set channel **State**
</SyncML>
```
## DeviceStateData area: Additional device information
## DeviceStateData area
The DeviceStateData functionality within the DiagnosticLog CSP provides additional device information.
The following section describes the nodes for the DeviceStateData functionality.
@ -1284,7 +1290,7 @@ The supported value is Execute.
</SyncML>
```
## FileDownload area: Pull trace and state data directly from the device
## FileDownload area
The FileDownload feature of the DiagnosticLog CSP enables a management server to pull data directly from the device. In the FileDownload context the client and server roles are conceptually reversed, with the management server acting as a client to download the data from the managed device.
### Comparing FileDownload and DiagnosticArchive