Skip to content

Log Process Details in ExecuteCommandAsync #439

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.

Sign up for GitHub

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Log Process Details in ExecuteCommandAsync #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
48f11d8
logging process details in extensions / execute command method
Feb 4, 2025
5a18dd7
Merge remote-tracking branch 'origin' into users/evellanoweth/log-pro…
Feb 13, 2025
a354e87
adding enum & fixing tests
Feb 13, 2025
76292d6
Merge branch 'main' into users/evellanoweth/log-process-details
ericavella Feb 19, 2025
2371df6
Merge branch 'main' into users/evellanoweth/log-process-details
ericavella Feb 20, 2025
0d4c675
changing execute command async to component method
Feb 21, 2025
0de72cc
Merge branch 'main' into users/evellanoweth/log-process-details
ericavella Feb 24, 2025
c430753
replacing & cleaning up tests
Feb 24, 2025
4df5d53
Merge branch 'users/evellanoweth/log-process-details' of https://gith…
Feb 24, 2025
8401cd5
removing wget property from compression
Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/VirtualClient/VirtualClient.Actions.UnitTests/MLPerf/MLPerfExecutorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,9 +345,9 @@ public TestMLPerfExecutor(IServiceCollection dependencies, IDictionary<string, I
return base.InitializeAsync(context, cancellationToken);
}

public new Task SetupEnvironmentAsync(CancellationToken cancellationToken)
public new Task SetupEnvironmentAsync(EventContext context, CancellationToken cancellationToken)
{
return base.SetupEnvironmentAsync(cancellationToken);
return base.SetupEnvironmentAsync(context, cancellationToken);
}

public new Task CreateScratchSpace(CancellationToken cancellationToken)
Expand Down
64 changes: 28 additions & 36 deletions src/VirtualClient/VirtualClient.Actions/7zip/Compression7zipExecutor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,11 @@ protected override async Task ExecuteAsync(EventContext telemetryContext, Cancel
{
string commandLineArguments = this.GetCommandLineArguments();

using (IProcessProxy process = await this.ExecuteCommandAsync("7z", commandLineArguments, this.Compressor7zipDirectory, telemetryContext, cancellationToken)
using (IProcessProxy process = await this.ExecuteCommandAsync("7z", commandLineArguments, this.Compressor7zipDirectory, telemetryContext, cancellationToken, runElevated: true)
.ConfigureAwait(false))
{
if (!cancellationToken.IsCancellationRequested)
{
await this.LogProcessDetailsAsync(process, telemetryContext, "7Zip", logToFile: true);

process.ThrowIfWorkloadFailed();
this.CaptureMetrics(process, telemetryContext, commandLineArguments);
}
Expand All @@ -119,8 +117,33 @@ protected override async Task InitializeAsync(EventContext telemetryContext, Can
// Choose default file for compression and decompression if files/dirs are not provided.
if (string.IsNullOrWhiteSpace(this.InputFilesOrDirs))
{
await this.ExecuteCommandAsync("wget", $"https://sun.aei.polsl.pl//~sdeor/corpus/silesia.zip", this.Compressor7zipDirectory, cancellationToken);
await this.ExecuteCommandAsync("unzip", "silesia.zip -d silesia", this.Compressor7zipDirectory, cancellationToken);
using (IProcessProxy process = await this.ExecuteCommandAsync(
"wget",
$"https://sun.aei.polsl.pl//~sdeor/corpus/silesia.zip",
this.Compressor7zipDirectory,
telemetryContext,
cancellationToken,
runElevated: true))
{
if (!cancellationToken.IsCancellationRequested)
{
process.ThrowIfErrored<WorkloadException>(process.StandardError.ToString(), ErrorReason.WorkloadUnexpectedAnomaly);
}
}

using (IProcessProxy process = await this.ExecuteCommandAsync(
"unzip",
"silesia.zip -d silesia",
this.Compressor7zipDirectory,
telemetryContext,
cancellationToken,
runElevated: true))
{
if (!cancellationToken.IsCancellationRequested)
{
process.ThrowIfErrored<WorkloadException>(process.StandardError.ToString(), ErrorReason.WorkloadUnexpectedAnomaly);
}
}
}

state.Compressor7zipStateInitialized = true;
Expand Down Expand Up @@ -155,37 +178,6 @@ private void CaptureMetrics(IProcessProxy process, EventContext telemetryContext
telemetryContext);
}

private async Task ExecuteCommandAsync(string pathToExe, string commandLineArguments, string workingDirectory, CancellationToken cancellationToken)
{
if (!cancellationToken.IsCancellationRequested)
{
this.Logger.LogTraceMessage($"Executing process '{pathToExe}' '{commandLineArguments}' at directory '{workingDirectory}'.");

EventContext telemetryContext = EventContext.Persisted()
.AddContext("command", pathToExe)
.AddContext("commandArguments", commandLineArguments);

await this.Logger.LogMessageAsync($"{nameof(Compression7zipExecutor)}.ExecuteProcess", telemetryContext, async () =>
{
DateTime start = DateTime.Now;
using (IProcessProxy process = this.systemManager.ProcessManager.CreateElevatedProcess(this.Platform, pathToExe, commandLineArguments, workingDirectory))
{
this.CleanupTasks.Add(() => process.SafeKill());
await process.StartAndWaitAsync(cancellationToken)
.ConfigureAwait(false);

if (!cancellationToken.IsCancellationRequested)
{
await this.LogProcessDetailsAsync(process, telemetryContext)
.ConfigureAwait(false);

process.ThrowIfErrored<WorkloadException>(errorReason: ErrorReason.WorkloadFailed);
}
}
}).ConfigureAwait(false);
}
}

private string GetCommandLineArguments()
{
string inputFilesOrDirs = string.IsNullOrWhiteSpace(this.InputFilesOrDirs)
Expand Down
62 changes: 20 additions & 42 deletions src/VirtualClient/VirtualClient.Actions/ASPNET/AspNetBenchExecutor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ namespace VirtualClient.Actions
{
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO.Abstractions;
using System.Runtime.InteropServices;
using System.Threading;
Expand Down Expand Up @@ -101,7 +102,7 @@ public string DotNetSdkPackageName
/// </summary>
protected override async Task ExecuteAsync(EventContext telemetryContext, CancellationToken cancellationToken)
{
Task serverTask = this.StartAspNetServerAsync(cancellationToken);
Task serverTask = this.StartAspNetServerAsync(telemetryContext, cancellationToken);
await this.RunBombardierAsync(telemetryContext, cancellationToken)
.ConfigureAwait(false);

Expand Down Expand Up @@ -150,8 +151,15 @@ await this.systemManagement.MakeFileExecutableAsync(this.bombardierFilePath, thi
// ~/vc/packages/dotnet/dotnet build -c Release -p:BenchmarksTargetFramework=net8.0
// Build the aspnetbenchmark project
string buildArgument = $"build -c Release -p:BenchmarksTargetFramework={this.TargetFramework}";
await this.ExecuteCommandAsync(this.dotnetExePath, buildArgument, this.aspnetBenchDirectory, cancellationToken)
.ConfigureAwait(false);

using (IProcessProxy process = await this.ExecuteCommandAsync(this.dotnetExePath, buildArgument, this.aspnetBenchDirectory, telemetryContext, cancellationToken, runElevated: true)
.ConfigureAwait(false))
{
if (!cancellationToken.IsCancellationRequested)
{
process.ThrowIfErrored<WorkloadException>(process.StandardError.ToString(), ErrorReason.WorkloadUnexpectedAnomaly);
}
}

// "C:\Users\vcvmadmin\Benchmarks\src\Benchmarks\bin\Release\net8.0\Benchmarks.dll"
this.aspnetBenchDllPath = this.Combine(
Expand Down Expand Up @@ -192,7 +200,7 @@ private void CaptureMetrics(IProcessProxy process, EventContext telemetryContext
}
}

private Task StartAspNetServerAsync(CancellationToken cancellationToken)
private async Task StartAspNetServerAsync(EventContext telemetryContext, CancellationToken cancellationToken)
{
// Example:
// dotnet <path_to_binary>\Benchmarks.dll --nonInteractive true --scenarios json --urls http://localhost:5000 --server Kestrel --kestrelTransport Sockets --protocol http
Expand All @@ -202,7 +210,13 @@ private Task StartAspNetServerAsync(CancellationToken cancellationToken)
string headers = @"--header ""Accept: application/json,text/html;q=0.9,application/xhtml+xml;q=0.9,application/xml;q=0.8,*/*;q=0.7"" --header ""Connection: keep-alive""";
this.serverArgument = $"{this.aspnetBenchDllPath} {options} {headers}";

return this.ExecuteCommandAsync(this.dotnetExePath, this.serverArgument, this.aspnetBenchDirectory, cancellationToken, isServer: true);
using (IProcessProxy process = await this.ExecuteCommandAsync(this.dotnetExePath, this.serverArgument, this.aspnetBenchDirectory, telemetryContext, cancellationToken, runElevated: true)
.ConfigureAwait(false))
{
this.killServer = () => process.SafeKill();
}

return;
}

private async Task RunBombardierAsync(EventContext telemetryContext, CancellationToken cancellationToken)
Expand All @@ -218,47 +232,11 @@ private async Task RunBombardierAsync(EventContext telemetryContext, Cancellatio
{
if (!cancellationToken.IsCancellationRequested)
{
await this.LogProcessDetailsAsync(process, telemetryContext, "AspNetBench", logToFile: true);

process.ThrowIfWorkloadFailed();
process.ThrowIfWorkloadFailed(process.StandardError.ToString());
this.CaptureMetrics(process, telemetryContext);
}
}
}
}

private async Task ExecuteCommandAsync(string pathToExe, string commandLineArguments, string workingDirectory, CancellationToken cancellationToken, bool isServer = false)
{
if (!cancellationToken.IsCancellationRequested)
{
this.Logger.LogTraceMessage($"Executing process '{pathToExe}' '{commandLineArguments}' at directory '{workingDirectory}'.");

EventContext telemetryContext = EventContext.Persisted()
.AddContext("command", pathToExe)
.AddContext("commandArguments", commandLineArguments);

using (IProcessProxy process = this.systemManagement.ProcessManager.CreateElevatedProcess(this.Platform, pathToExe, commandLineArguments, workingDirectory))
{
if (isServer)
{
this.killServer = () => process.SafeKill();
}

this.CleanupTasks.Add(() => process.SafeKill());
await process.StartAndWaitAsync(cancellationToken).ConfigureAwait(false);

if (!cancellationToken.IsCancellationRequested)
{
await this.LogProcessDetailsAsync(process, telemetryContext);

if (!isServer)
{
// We will kill the server at the end, exit code is -1, and we don't want it to log as failure.
process.ThrowIfWorkloadFailed();
}
}
}
}
}
}
}
Loading
Loading