-
Notifications
You must be signed in to change notification settings - Fork 495
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
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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`. | ||
|
||
1. Launch Powershell with administrator priviledges. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
convenience