Skip to content

Commit

Permalink
refactor(doc): Add additional comments to log capture readme
Browse files Browse the repository at this point in the history
  • Loading branch information
abhipsaMisra committed Aug 10, 2021
1 parent 39baeb8 commit 41e519b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion tools/CaptureLogs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ We have provided the following convenience scripts for log collection using `log
1. Launch Powershell with administrator privileges.
2. To start capturing traces, invoke `iot_startlog.ps1`.
1. Pass in the following required parameters:
1. `-TraceName` - the name of the event trace data collector.
1. `-TraceName` - the name of the event trace data collector. This can be any name that will be used to identity the collector created.
2. `-Output` - the output log file that will be created. This should be a `.etl` file.
3. `-ProviderFile` - The file listing multiple Event Trace providers to enable. The file should be a text file containing one provider per line.
The Azure IoT SDK providers file is present [here](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/tools/CaptureLogs/iot_providers.txt). The providers list with their corresponding package details are present [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/master/tools/CaptureLogs#azure-iot-sdk-providers).

Sample usage:

To create an event trace data collector called `IotTrace`, using the file `iot_providers.txt` for the list of event providers to be enabled, putting the results in a file `iot.etl` in the same folder from where the command is invoked, type:
```powersehll
.\iot_startlog.ps1 -Output iot.etl -ProviderFile .\iot_providers.txt -TraceName IotTrace
```
Expand Down

0 comments on commit 41e519b

Please sign in to comment.