【PowerShell】ログの処理方法について

2019年6月29日

Warning: preg_match(): Compilation failed: unrecognized character follows \ at offset 1 in /home/r5652521/public_html/soma-engineering.com/wp-content/themes/affinger/functions.php on line 1548

Warning: preg_match(): Compilation failed: unrecognized character follows \ at offset 1 in /home/r5652521/public_html/soma-engineering.com/wp-content/themes/affinger/functions.php on line 1548

Warning: preg_match(): Compilation failed: unrecognized character follows \ at offset 1 in /home/r5652521/public_html/soma-engineering.com/wp-content/themes/affinger/functions.php on line 1548

Warning: preg_match(): Compilation failed: unrecognized character follows \ at offset 1 in /home/r5652521/public_html/soma-engineering.com/wp-content/themes/affinger/functions.php on line 1548

Warning: preg_match(): Compilation failed: unrecognized character follows \ at offset 1 in /home/r5652521/public_html/soma-engineering.com/wp-content/themes/affinger/functions.php on line 1548

こんにちは！SE ブログの相馬です。

今回は、PowerShell でログの処理方法について書いてみました。

何かの処理結果をログとして残す事は重要です。処理が成功したのか失敗したのか、その結果をログファイルとして PC やサーバー上の指定のフォルダ内に溜め込んでおくようなイメージです。

そこでログの出力などどのように書いたら良いのか、一つの例として参考になればという事で、皆さまのお役に立てれば良いと思います。

また、前提としてファイルやフォルダの操作する知識が必要ですので、もし分からないようであれば以下の記事を読んでいただいてから進んで頂く事をお勧めします。

: 【PowerShell】ファイルやフォルダを操作する

こんにちは！SEブログの相馬です。今回は、ファイルやフォルダを作成したりする方法について書いてみました。システム運用管理の業務 ...

サンプル処理内容

それではいきなりですがサンプルを見てみましょう。適当ではありますが情報ログ、警告ログ、エラーログという文字列をログファイルに入れて出力する内容です。

ログの内容を変数にどんどん格納してゆかなければなりませんので、変数は配列化しなければなりませんが、PowerShell は省略しても問題ないようですが、ここでは一応明示的に書いてあります。また、ログの内容は配列に += で追加で代入しなければなりません。= で書くと前のログが上書きされてしまいますので注意が必要です。

また、ログファイルにタイムスタンプを付けましょう。いつログが出力されたか後で分からないといけませんよね。

# 配列化 (省略してもOK)
$Msg = @()

# 文字列をログの変数に代入
$Msg += &quot;情報ログ&quot;
$Msg += &quot;警告ログ&quot;
$Msg += &quot;エラーログ&quot;

# ログの出力先
$LogPath = &quot;D:\Log&quot;

# ログファイル名
$LogName = &quot;log&quot;

# Log 出力文字列に時刻を追加
$Time = (Get-Date).ToString(&quot;yyyy-MM-dd&quot;)

# ログファイル(XXXX_YYYY-MM-DD.log)
$LogFile = $LogName + &quot;_&quot; + $Time + &quot;.log&quot;

# ログフォルダーがなかったら作成
if(-not(Test-Path $LogPath)) {
    New-Item $LogPath -Type Directory
}

# ログファイル名作成　Join-Path で変数を結合
$LogFileName = Join-Path $LogPath $LogFile

# ログ出力
Write-Output $Msg | Out-File -FilePath $LogFileName -Encoding Default -append

# 配列化 (省略してもOK)

$Msg = @()

# 文字列をログの変数に代入

$Msg += "情報ログ"

$Msg += "警告ログ"

$Msg += "エラーログ"

# ログの出力先

$LogPath = "D:\Log"

# ログファイル名

$LogName = "log"

# Log 出力文字列に時刻を追加

$Time = (Get-Date).ToString("yyyy-MM-dd")

# ログファイル(XXXX_YYYY-MM-DD.log)

$LogFile = $LogName + "_" + $Time + ".log"

# ログフォルダーがなかったら作成

if(-not(Test-Path $LogPath)) {

New-Item $LogPath -Type Directory

}

# ログファイル名作成　Join-Path で変数を結合

$LogFileName = Join-Path $LogPath $LogFile

# ログ出力

Write-Output $Msg | Out-File -FilePath $LogFileName -Encoding Default -append

処理結果、以下のように D:\Log にファイル (log_yyyy-mm-dd) が出力されました。※PC の日付を和暦で設定しているので表示では 01 になっています。

ログの内容です。代入した文字列が全て入っていますね。

ログの出力方法

ログファイルですので、拡張子 .log を使います。また $Msg に溜め込んだログを Out-File コマンドレットでファイルとして保存する方法になります。

Write-Output $Msg | Out-File -FilePath $LogFileName -Encoding Default -append

1	Write-Output $Msg \| Out-File -FilePath $LogFileName -Encoding Default -append

また、出力したログをパイプでファイル出力に渡しているので、その辺はパイプについて理解されていたほうが良いでしょう。

: 【PowerShell】Pipeline(パイプライン)とは何か

こんにちは！SE ブログの相馬です。今回はパイプラインについて書きました。早速パイプラインとは何かから説明します。 ...

関数化してみる

ログの出力処理はスクリプト内で何度も使われる場合があります。というか使われます。

処理に成功したらログに出力する、失敗してもログに出力するのですが、処理内容の中で失敗した場合のほうが明らかに多いためにエラー処理の中で何度も再利用する事になります。

そのたびに上の処理内容をエラー処理の中に都度書くと処理内容が多くなってしまうばかりか、保守性によくありません。例えば、エラー処理毎にログの処理を書いているスクリプトをリリースした場合、その後にログの処理を変更する事になった場合、ログの処理を書いた分全てを修正しなければなりません。

これは労力が要りますし、時間の無駄でもあり、一部のログの内容を修正しわすれてしまって処理が失敗してしまったという人的ミスになりかねません。これは避けたいところですよね。

このように、処理を再利用しなければならない場合は関数化してしまえば 1 つの処理内容だけメンテナンスすれば良くなりますので効率的です。

関数について知識がまだ無い方は、以下の記事を理解してから進んで頂く事をお勧めします。

: 【PowerShell】関数(function)を使ってみる

こんにちは！そーまんです。今回は、PowerShell での関数とは何か、関数の書き方、またどう使うかについて説明いたします。関数とは何か私もそうですが PowerShell を書き始めた時には ...

ここでは、テキストファイルの中にユーザー名があると仮定して、そのテキストファイルがあれば Import-Csv コマンドレットで読み込んでから ForEach-Object を使い繰り返し処理で AD のグループにユーザーを追加する処理を書いてみました。

function Log($Msg) {

    # ログの出力先
    $LogPath = &quot;D:\Log&quot;

    # ログファイル名
    $LogName = &quot;log&quot;

    # Log 出力文字列に時刻を追加
    $Time = (Get-Date).ToString(&quot;yyyy-MM-dd&quot;)

    # ログファイル(XXXX_YYYY-MM-DD.log)
    $LogFile = $LogName + &quot;_&quot; + $Time + &quot;.log&quot;

    # ログフォルダーがなかったら作成
    if( -not (Test-Path $LogPath) ) {
        New-Item $LogPath -Type Directory
    }

    # ログファイル名
    $LogFileName = Join-Path $LogPath $LogFile

    # ログ出力
    Write-Output $Msg | Out-File -FilePath $LogFileName -Encoding Default -append

}
$Msg = @()

$File = &quot;D:\Work\AddUser.txt&quot;
# 処理開始の宣言
$Msg += Write-Output &quot;$(Get-Date) ADグループにメンバを追加する処理を開始します。&quot;

# ファイルの有無確認
If (Test-Path $File) {

    # ファイルの読み込み
    Import-CSV -Path $File | `
    # 繰り返し処理で、ADのグループにユーザーを追加
    ForEach-Object { `
        Add-ADGroupMember -Identity &quot;Marketing&quot; -Members $_.'user' -Confirm:$false `
    }
}
# 成功した場合のメッセージ追加
$Msg += Write-Output &quot;$(Get-Date) ADグループにメンバを追加しました。&quot;

} Else {
    # 失敗した場合のメッセージ追加
    $Msg += Write-Output &quot;$(Get-Date) ファイルが見つかりません。&quot;
    # 関数に$Msgを渡す
    Log($Msg)
    # 処理中断
    Exit

}
# 関数に$Msgを渡す
Log($Msg)

function Log($Msg) {

# ログの出力先

$LogPath = "D:\Log"

# ログファイル名

$LogName = "log"

# Log 出力文字列に時刻を追加

$Time = (Get-Date).ToString("yyyy-MM-dd")

# ログファイル(XXXX_YYYY-MM-DD.log)

$LogFile = $LogName + "_" + $Time + ".log"

# ログフォルダーがなかったら作成

if( -not (Test-Path $LogPath) ) {

New-Item $LogPath -Type Directory

}

# ログファイル名

$LogFileName = Join-Path $LogPath $LogFile

# ログ出力

Write-Output $Msg | Out-File -FilePath $LogFileName -Encoding Default -append

}

$Msg = @()

$File = "D:\Work\AddUser.txt"

# 処理開始の宣言

$Msg += Write-Output "$(Get-Date) ADグループにメンバを追加する処理を開始します。"

# ファイルの有無確認

If (Test-Path $File) {

# ファイルの読み込み

Import-CSV -Path $File | `

# 繰り返し処理で、ADのグループにユーザーを追加

ForEach-Object { `

Add-ADGroupMember -Identity "Marketing" -Members $_.'user' -Confirm:$false `

}

# 成功した場合のメッセージ追加

$Msg += Write-Output "$(Get-Date) ADグループにメンバを追加しました。"

} Else {

# 失敗した場合のメッセージ追加

$Msg += Write-Output "$(Get-Date) ファイルが見つかりません。"

# 関数に$Msgを渡す

Log($Msg)

# 処理中断

Exit

}

# 関数に$Msgを渡す

Log($Msg)

まとめ

以上になります。いかがでしょうか。

スクリプトを書くにあたり、ログの処理は必須ですのでこの処理内容には慣れておくと良いでしょう。また関数に慣れて再利用できるようにもしておきましょう。

関数は慣れないとなかなか使えないと思います。私がそうでしたが最初は、function の関数と一緒に指定する引数が最初は分かりにくいのかなと思ったりします。あと、関数を実行する際に指定する引数についても分かりにくいと思います。

これは慣れるしかないので、コードを書いて実行する事を繰り返しやっていけば理解できるようになりますので心配ないと思います。とにかく継続してスクリプトを書いてみましょう。

それでは最後までお読みいただきありがとうございました！

そーまん

セキュリティエンジニアやってます。
ブログ歴3年。PVは月15万PV程度。
趣味はボクシング、筋トレ、登山です。
穏やかで人見知りな性格です。

同じカテゴリーでおすすめの記事

【PowerShell】比較演算子を元に条件式(IF文)を使ってみる

こんにちは！前回は比較演算子の記事を書いてみましたが、それらを使って条件式を書いてみました。処理を分岐する事ができますので、パターンA の場合、パターンB の場合、パターンB の場合などで処理を分ける事ができるようになります。また、比較演算子についての記事は以下にリンクを貼っておきましたので必要であれば参考いただくと幸いです。【PowerShell】色々な比較演算子を使ってみるでは早速、進めましょう。 &nbsp ...

【PowerShell】ファイルを比較する方法

こんにちは！SE ブログの相馬です。今回は、PowerShell を使ってテキストファイルの中身を比較してみました。普段は皆さんは作業される時にデータの比較などされているかと思います。実際に作業で使うデータに誤りがある事を避ける為ですが、WinMerge などのツールを使って手動でされていますよね。実は、PowerShell ではファイルの比較をする事ができます。つまり、スクリプト内でファイルの比較に問 ...

【PowerShell】Pipeline(パイプライン)とは何か

こんにちは！SE ブログの相馬です。今回はパイプラインについて書きました。早速パイプラインとは何かから説明します。パイプラインとはパイプラインとは、先行のコマンドの結果をパイプラインを使って次のコマンドに渡してあげる為のものです。PowerShell では、パイプラインを |（縦棒）で書きます。例えばイメージとしてこんな感じです。ここでは、Get-ChildItem コマンドレットを使って ...

【PowerShell】メッセージボックスを表示する

こんにちは！SE ブログの相馬です。今まで PowerShell で記事を書いてきましたが、画面に表示する処理ができる事を知りませんでした。私が知っている PowerShell でできる事といえば、主にサーバーの管理だと思っていましたので。PowerShell から .NET Frameworkライブラリを使用することが可能なので、画面に表示させたりする事ができるそうです。もちろんサーバーの管理としても使えると思いますけど、GUI でシステム管理 ...

【PowerShell】フォルダを作成しアクセス権限を付与する

こんにちは！そーまんです。今回は、PowerShell を使いフォルダを作成し、アクセス権限を付与する方法について書いてみました。色々な用途で使えるとは思いますが、これが自動でできますと、ユーザーの PC 管理が効率的にできるような感じですね。企業で大量の PC を管理する場合は、例えばユーザーの PC の C ドライブに対してユーザーのアクセス権限が無い環境が多いかと思います。そこで、C ドライブ直下にログ格納用のフォルダを作成したり、また別のローカルドライブがある場合は、そこに一時作業用のフォル ...

【VMware Workstation】仮想マシンの所有権の取得に失敗し起動しない

【PowerShell】フォルダ内にあるファイルを取得する方法

【PowerShell】ログの処理方法について

サンプル処理内容

ログの出力方法

関数化してみる

まとめ

【Active Directory】PCに適用されているGPOを確認する方法

【Windows10】sysprepとは何か？

【Active Directory】ユーザーにローカル管理者権限を持たせる

【Windows10】一時ユーザープロファイルの問題を解決する

【Windows10】ユーザープロファイルを削除する

【PowerShell】繰り返し文(While, For)について

【Windows10】コマンドでPCの負荷状況を確認する

【PowerShell】プログラムと機能にあるアプリの一覧を表示する

【Active Directory】Group Policyが適用されない場合の対処方法

【Windows Server 2019】NTPサーバーと同期する方法

【PowerShell】ログの処理方法について

サンプル処理内容

ログの出力方法

関数化してみる

まとめ

関連記事