Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(tools-logs): Update log capture script to be configurable and use powershell #2141

Merged
merged 4 commits into from
Aug 6, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions tools/CaptureLogs/iot_startlog.cmd

This file was deleted.

23 changes: 23 additions & 0 deletions tools/CaptureLogs/iot_startlog.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
param(
[Parameter(Mandatory)]
[string] $TraceName,

[Parameter(Mandatory)]
[string] $Output,

[Parameter(Mandatory)]
[string] $ProviderFile
)

Function StartLogCapture()
{
$createTrace = "logman create trace $TraceName -o $Output -pf $ProviderFile"
Write-Host "Invoking: $createTrace."
Invoke-Expression $createTrace

$startTrace = "logman start $TraceName"
Write-Host "Invoking: $startTrace."
Invoke-Expression $startTrace
}

StartLogCapture
2 changes: 0 additions & 2 deletions tools/CaptureLogs/iot_stoplog.cmd

This file was deleted.

17 changes: 17 additions & 0 deletions tools/CaptureLogs/iot_stoplog.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
param(
[Parameter(Mandatory)]
[string] $TraceName
)

Function StopLogCapture()
{
$stopTrace = "logman stop $TraceName"
Write-Host "Invoking: $stopTrace."
Invoke-Expression $stopTrace

$deleteTrace = "logman delete $TraceName"
Write-Host "Invoking: $deleteTrace."
Invoke-Expression $deleteTrace
}

StopLogCapture
24 changes: 24 additions & 0 deletions tools/CaptureLogs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,30 @@
## Windows
On Windows logman or PerfView can be used to collect traces. For more information please see https://github.com/dotnet/runtime/blob/master/docs/workflow/debugging/libraries/windows-instructions.md#traces

We have provided the following convinience scripts for log collection using `logman`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

convenience


1. Launch Powershell with administrator priviledges.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
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:
```powersehll
.\iot_startlog.ps1 -Output iot.etl -ProviderFile .\iot_providers.txt -TraceName IotTrace
```

3. To stop capturing traces, invoke `iot_stoplog.ps1`.
1. Pass in the following required parameter:
1. `-TraceName` - the name of the event trace data collector. Same as the one used while starting trace capture.

Sample usage:
```powersehll
.\iot_stoplog.ps1 -TraceName IotTrace
```

## Linux
On Linux and OSX LTTNG and perfcollect can be used to collect traces. For more information please see https://github.com/dotnet/runtime/blob/master/docs/project/linux-performance-tracing.md

Expand Down