PowerShellで並列処理を効率化

EXCEL

PowerShellで並列処理を効率化

PowerShellの並列処理は、多数のWindowsホストに対する操作や大規模データ処理の効率を劇的に向上させます。本稿では、現場で適用可能な並列処理の実装、検証、運用を解説します。

目的と前提 / 設計方針（同期/非同期、可観測性）

単一のPowerShellスクリプトが複数のタスクを逐次実行する際、全体の処理時間は各タスクの合計に比例し、特にネットワークI/OやCPUバウンドな処理でボトルネックとなります。並列処理は、これらのタスクを同時に実行することで、実行時間の短縮を目的とします。

設計方針として、PowerShell 7以降の環境では ForEach-Object -Parallel コマンドレットが最も簡潔で推奨されます。PowerShell 5.1環境では RunspacePool を使用した並列処理が一般的です。可観測性のため、各並列タスクの進行状況、成功・失敗、出力はログに記録し、中央集約する仕組みを考慮します。エラー発生時には、再試行やタイムアウト処理を導入し、堅牢性を確保します。

コア実装（並列/キューイング/キャンセル）

ここでは、ForEach-Object -Parallel を用いたリモートサーバー監視の例と、RunspacePool を用いた一般的な並列処理の例を提示します。

コード例1: ForEach-Object -Parallel (PowerShell 7+) によるリモートサービス監視と再試行

この例では、複数のリモートホストのサービス状態を並列に確認し、特定のサービスが停止していた場合に再試行ロジックを適用して開始を試みます。CIM/WMIを活用してリモート操作を行います。

# 設定パラメータ
$TargetComputers = @("Server01", "Server02", "NonExistentServer") # 監視対象ホストリスト
$ServiceName = "BITS" # 監視対象サービス名
$MaxRetries = 3 # サービス開始の最大再試行回数
$RetryDelaySeconds = 5 # 再試行間の待機時間
$ThrottleLimit = 5 # 並列実行の最大スレッド数

# ロギング関数 (構造化ログの簡易実装)
function Write-StructuredLog {
    param (
        [string]$Level,
        [string]$Message,
        [object]$Data = $null
    )
    $LogEntry = @{
        Timestamp = (Get-Date -Format "yyyy-MM-dd HH:mm:ss.fff")
        Level = $Level
        Message = $Message
        Data = $Data
    } | ConvertTo-Json -Compress
    Add-Content -Path "ParallelServiceCheck.log" -Value $LogEntry
}

Write-StructuredLog -Level "INFO" -Message "サービス監視開始" -Data @{ TargetComputers = $TargetComputers; ServiceName = $ServiceName }

$Results = $TargetComputers | ForEach-Object -Parallel {
    param($ComputerName)

    # 外部スコープ変数を参照する際は $using: を使用
    $serviceName = $using:ServiceName
    $maxRetries = $using:MaxRetries
    $retryDelay = $using:RetryDelaySeconds
    $scriptBlockLog = $using:Write-StructuredLog

    $result = [PSCustomObject]@{
        ComputerName = $ComputerName
        ServiceName = $serviceName
        Status = "Unknown"
        Message = ""
        ActionTaken = "None"
        Error = $null
    }

    $retries = 0
    do {
        try {
            # リモートCIMインスタンスの取得を試行、タイムアウトを設定
            $service = Get-CimInstance -ClassName Win32_Service -Filter "Name='$serviceName'" -ComputerName $ComputerName -ErrorAction Stop -OutVariable CimService -OperationTimeoutSeconds 10

            if ($service -and $service.State -eq "Running") {
                $result.Status = "Running"
                $result.Message = "サービスは実行中です。"
                $scriptBlockLog -Level "INFO" -Message "$ComputerName: $serviceName は実行中。" -Data $result
                break # 成功したのでループを抜ける
            } elseif ($service -and $service.State -eq "Stopped") {
                $scriptBlockLog -Level "WARN" -Message "$ComputerName: $serviceName が停止しています。開始を試行します。" -Data $result
                $result.Message = "サービスが停止しています。開始を試行中..."

                # サービス開始を試行、タイムアウトを設定
                $startResult = $CimService | Invoke-CimMethod -MethodName StartService -ErrorAction Stop -OperationTimeoutSeconds 30

                if ($startResult.ReturnValue -eq 0) {
                    $result.Status = "Started"
                    $result.Message = "サービスを開始しました。"
                    $result.ActionTaken = "Started"
                    $scriptBlockLog -Level "INFO" -Message "$ComputerName: $serviceName を開始しました。" -Data $result
                    break # 成功したのでループを抜ける
                } else {
                    $result.Status = "FailedToStart"
                    $result.Message = "サービス開始に失敗しました (エラーコード: $($startResult.ReturnValue))。"
                    $scriptBlockLog -Level "ERROR" -Message "$ComputerName: $serviceName 開始失敗。" -Data $result
                }
            } else {
                # サービスが見つからない、または予期せぬ状態
                $result.Status = "NotFound"
                $result.Message = "サービス '$serviceName' が $ComputerName で見つかりません。"
                $scriptBlockLog -Level "WARN" -Message "$ComputerName: $serviceName が見つからないか、予期せぬ状態。" -Data $result
            }
        }
        catch {
            $retries++
            $result.Status = "Error"
            $result.Error = $_.Exception.Message
            $result.Message = "処理中にエラーが発生しました: $($_.Exception.Message)"
            $scriptBlockLog -Level "ERROR" -Message "$ComputerName: 処理エラー (再試行 $retries/$maxRetries)" -Data $result
            Start-Sleep -Seconds $retryDelay # 再試行前に待機
        }
    } while ($result.Status -ne "Running" -and $result.Status -ne "Started" -and $retries -lt $maxRetries)

    if ($result.Status -ne "Running" -and $result.Status -ne "Started") {
        # 最大再試行回数を超えてもサービスが実行されていない場合
        $result.Message = "最大再試行回数 ($maxRetries) を超えましたが、$serviceName は $ComputerName で実行されていません。"
        $scriptBlockLog -Level "CRITICAL" -Message "$ComputerName: $serviceName 最終的に実行されず。" -Data $result
    }

    $result
} -ThrottleLimit $ThrottleLimit

Write-StructuredLog -Level "INFO" -Message "サービス監視完了"

# 結果表示
$Results | Format-Table -AutoSize

処理フロー

graph TD
    A["スクリプト開始"] --> B{"対象ホストリストの取得"};
    B --> C["ForEach-Object -Parallel 初期化"];
    C --> D{"各ホストに対して並列処理"};

    D -- ホストA --> E["サービス状態取得 (Get-CimInstance)"];
    D -- ホストB --> F["サービス状態取得 (Get-CimInstance)"];
    D -- ... --> G["サービス状態取得 (Get-CimInstance)"];

    E --> H{"サービスは実行中か？"};
    F --> I{"サービスは実行中か？"};
    G --> J{"サービスは実行中か？"};

    H -- Yes --> L["結果: 実行中"];
    I -- Yes --> M["結果: 実行中"];
    J -- Yes --> N["結果: 実行中"];

    H -- No --> O{"サービスは停止中か？"};
    O -- Yes --> P["サービス開始を試行 (Invoke-CimMethod)"];
    O -- No --> Q["サービス不明/エラー"];

    P -- 成功 --> L;
    P -- 失敗 --> R{"再試行回数  S["待機 & 再試行"];
    S --> P;
    R -- No --> T["結果: 開始失敗/最大再試行"];

    Q --> T;

    L, M, N, T --> U["結果収集"];
    U --> V["スクリプト終了"];

コード例2: RunspacePool (PowerShell 5.1+) による並列ファイル処理

この例では、RunspacePool を利用して複数のファイルに対して並列に処理を実行します。各ランスペースは独立したPowerShellセッションとして動作し、独自の変数スコープを持ちます。

# 設定パラメータ
$FilesToProcess = @("file1.txt", "file2.txt", "file3.txt", "nonexistent.txt") # 処理対象ファイルリスト
# ダミーファイル作成 (実行前提)
"Content for file1." | Out-File file1.txt -Encoding utf8
"Content for file2." | Out-File file2.txt -Encoding utf8
"Content for file3." | Out-File file3.txt -Encoding utf8

$MaxRunspaces = 5 # RunspacePoolの最大Runspace数

# $ErrorActionPreference を明示的に設定
$ErrorActionPreference = "Continue" # 並列処理内のエラーは各Runspaceで捕捉、メインは続行

# ロギング関数
function Write-JobLog {
    param (
        [string]$JobName,
        [string]$Message,
        [string]$Level = "INFO"
    )
    $Timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss.fff"
    "$Timestamp [$JobName] [$Level] $Message" | Out-File -FilePath "RunspacePool.log" -Append -Encoding utf8
}

# RunspacePoolの作成
$RunspacePool = [runspacefactory]::CreateRunspacePool(1, $MaxRunspaces) # 最小1, 最大$MaxRunspaces
$RunspacePool.Open()

$Jobs = @()
foreach ($file in $FilesToProcess) {
    $powershell = [powershell]::Create()
    $powershell.RunspacePool = $RunspacePool

    # スクリプトブロックに渡す引数を定義
    $powershell.AddScript({
        param($filePath, $jobLogger)

        # 外部で定義されたロギング関数を呼び出すためのプロキシ
        $script:JobLogger = $jobLogger # ロギング関数をスクリプトブロック内で利用可能にする

        try {
            $script:JobLogger -JobName $filePath -Message "処理開始。"

            if (-not (Test-Path $filePath)) {
                throw "ファイル '$filePath' が見つかりません。"
            }

            # ファイル内容を読み込み、簡単な処理をシミュレート
            $content = Get-Content -Path $filePath -Raw -Encoding utf8 -ErrorAction Stop
            $wordCount = ($content -split '\s+' | Measure-Object).Count
            $lineCount = ($content -split "`n" | Measure-Object).Count

            # 処理に時間のかかる作業をシミュレート
            Start-Sleep -Seconds (Get-Random -Minimum 1 -Maximum 3)

            $script:JobLogger -JobName $filePath -Message "処理完了。単語数: $wordCount, 行数: $lineCount" -Level "INFO"

            # 結果をカスタムオブジェクトとして返す
            [PSCustomObject]@{
                FilePath = $filePath
                Status = "Success"
                WordCount = $wordCount
                LineCount = $lineCount
                ErrorMessage = $null
            }
        }
        catch {
            $errorMessage = $_.Exception.Message
            $script:JobLogger -JobName $filePath -Message "処理中にエラーが発生: $errorMessage" -Level "ERROR"
            [PSCustomObject]@{
                FilePath = $filePath
                Status = "Failed"
                WordCount = $null
                LineCount = $null
                ErrorMessage = $errorMessage
            }
        }
    }) | Out-Null

    # スクリプトブロックに引数を渡す
    $powershell.AddParameter("filePath", $file)
    $powershell.AddParameter("jobLogger", (Get-Command Write-JobLog)) # 関数オブジェクトを渡す

    # ジョブを非同期で開始
    $handle = $powershell.BeginInvoke()

    $Jobs += [PSCustomObject]@{
        Handle = $handle
        PowerShell = $powershell
        FilePath = $file
    }
}

$AllResults = @()
while ($Jobs.Count -gt 0) {
    foreach ($job in $Jobs.Clone()) { # コレクション変更時にエラーを避けるためCloneを使用
        if ($job.Handle.IsCompleted) {
            $AllResults += $job.PowerShell.EndInvoke($job.Handle) # 結果を収集
            $job.PowerShell.Dispose() # Runspace内のPowerShellオブジェクトを解放
            $Jobs.Remove($job) # 完了したジョブをリストから削除
        }
    }
    Start-Sleep -Milliseconds 100 # 短時間待機してCPUを占有しすぎないようにする
}

$RunspacePool.Close()
$RunspacePool.Dispose()

Write-Host "全てのジョブが完了しました。"
$AllResults | Format-Table -AutoSize

# ダミーファイルの削除
Remove-Item file1.txt, file2.txt, file3.txt -ErrorAction SilentlyContinue

検証（性能・正しさ）と計測スクリプト

並列処理の有効性を評価するには、同期処理と比較して性能を計測し、出力の正しさを検証します。

# 性能計測の例
# コード例1のForEach-Object -Parallel スクリプトブロックを関数化し、Measure-Command で実行時間を比較

function Measure-ParallelServiceCheck {
    param (
        [string[]]$Computers,
        [string]$Service,
        [int]$Throttle
    )
    Measure-Command {
        $Computers | ForEach-Object -Parallel {
            # ... (コード例1のForEach-Object -Parallel の中身をここに配置) ...
            # 簡略化のため、ここではダミー処理
            param($ComputerName)
            Start-Sleep -Seconds (Get-Random -Minimum 1 -Maximum 2)
            [PSCustomObject]@{ ComputerName = $ComputerName; Status = "Dummy" }
        } -ThrottleLimit $Throttle
    }
}

function Measure-SequentialServiceCheck {
    param (
        [string[]]$Computers,
        [string]$Service
    )
    Measure-Command {
        $Computers | ForEach-Object {
            # ... (同期処理のコードをここに配置) ...
            # 簡略化のため、ここではダミー処理
            param($ComputerName)
            Start-Sleep -Seconds (Get-Random -Minimum 1 -Maximum 2)
            [PSCustomObject]@{ ComputerName = $ComputerName; Status = "Dummy" }
        }
    }
}

# 多数のターゲットホストを想定
$TestComputers = 1..20 | ForEach-Object { "TestServer$_" } # 20個のダミーサーバー

Write-Host "--- 並列処理の計測 ---"
$ParallelTime = Measure-ParallelServiceCheck -Computers $TestComputers -Service "BITS" -Throttle 10
Write-Host "並列処理時間 (Throttle 10): $($ParallelTime.TotalSeconds) 秒"

Write-Host "`n--- 逐次処理の計測 ---"
$SequentialTime = Measure-SequentialServiceCheck -Computers $TestComputers -Service "BITS"
Write-Host "逐次処理時間: $($SequentialTime.TotalSeconds) 秒"

# 正しさの検証: ログファイルの内容や最終的な結果オブジェクトをチェックし、期待通りの状態かを確認します。
# 例: サービスが実際に開始されたか、すべてのファイルが処理されたかなど。

運用：ログローテーション/失敗時再実行/権限

ロギング戦略

Start-Transcript / Stop-Transcript は簡単なスクリプト実行ログに有効ですが、大規模運用では構造化ログ (JSON/CSV) が推奨されます。ログファイルは肥大化するため、定期的なローテーション（例: 週次/月次でアーカイブ・削除）が必要です。Windowsの logman やカスタムスクリプトで実装します。

失敗時再実行

上記コード例の do/until ループは、サービス開始の再試行を実装しています。スクリプト全体が失敗した場合は、エラーメッセージを解析し、適切な待機期間を設けてスクリプト自体を再実行する運用も検討します。これはWindowsのタスクスケジューラやOrchestratorで実現可能です。

権限

リモート操作には管理者権限が必要です。最小権限の原則に基づき、特定のタスクに限定された権限を持つアカウントを使用します。Just Enough Administration (JEA) は、この目的のためにPowerShellで特定のコマンドレットとパラメータのみを実行できる制限付きエンドポイントを構築する際に有効です。機密情報（パスワードなど）は SecretManagement モジュールやWindows Credential Managerを利用して安全に取り扱います。

落とし穴（例：PowerShell 5 vs 7の差、スレッド安全性、UTF-8問題）

  • PowerShell 5 vs 7の差: PowerShell 7で導入された ForEach-Object -Parallel は非常に便利ですが、PowerShell 5.1環境では利用できません。代わりに RunspacePool を使用する必要があります。また、Pesterなどの一部モジュールはPS5.1とPS7で互換性が異なります。
  • スレッド安全性: 並列実行環境では、複数のスレッドが同時に同じ共有変数にアクセスしようとすると、競合状態 (Race Condition) が発生し、予期せぬ結果やデータ破損を引き起こす可能性があります。 $using: スコープ修飾子を適切に使用し、共有リソースへのアクセスは同期メカニズム（例：[System.Threading.Monitor]::Enter()/Exit()）で保護するか、各Runspaceが独立したリソースを扱うように設計します。
  • UTF-8問題: PowerShellのバージョンやコマンドレットによってデフォルトのエンコーディングが異なります。特にファイルI/Oでは、UTF-8 BOM無しで保存されたファイルが正しく読み書きされない、あるいは予期せぬ文字化けが発生することがあります。常に -Encoding UTF8 など明示的にエンコーディングを指定することを推奨します。
  • リソース消費: 並列スレッド数を過度に増やすと、CPU、メモリ、ネットワーク帯域が飽和し、かえって性能が低下することがあります。 ThrottleLimit や MaxRunspaces をシステムの許容範囲内で調整することが大切です。

まとめ

PowerShellにおける並列処理は、Windows運用の効率化に不可欠な技術です。ForEach-Object -Parallel や RunspacePool を適切に選択し、エラーハンドリング、ロギング、再試行、そして権限管理を考慮した設計を行うことで、堅牢で高性能な自動化スクリプトを構築できます。常に環境特性とリソース制限を意識し、最適な並列化戦略を適用してください。

ライセンス：本記事のテキスト/コードは特記なき限り CC BY 4.0 です。引用の際は出典URL（本ページ）を明記してください。
利用ポリシー もご参照ください。

コメント

タイトルとURLをコピーしました