Skip to main content
OnCommand Workflow Automation 5.1
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

ロギングのガイドライン

共同作成者
PDF

OnCommand Workflow Automation （ WFA ）用の PowerShell スクリプトまたは Perl スクリプトを作成する際には、ログ記録に関するガイドラインに注意する必要があります。

PowerShell のロギング

ガイドライン 例

ログには Get-WFALogger コマンドレットを使用します。

 
Get-WFALogger -Info -message “Creating volume”

Data ONTAP 、 VMware 、 PowerCLI などの内部パッケージとの対話を必要とするすべてのアクションをログに記録します。すべてのログメッセージは、ワークフローの実行ステータス履歴の実行ログで使用できます。

なし

内部パッケージに渡される関連するすべての引数を記録します。

なし

使用状況に応じて、 Get-WFALogger コマンドレットを使用する場合は、適切なログレベルを使用してください。- INFO 、 - Error 、 - Warn 、 - Debug は、使用可能なさまざまなログレベルです。ログレベルが指定されていない場合、デフォルトのログレベルは Debug です。

なし

Perl のロギング

ガイドライン 例

ログには WFAUtil sendLog を使用します。

 
my wfa_util = WFAUtil->new();
eval {
$wfa_util->sendLog('INFO', "Connecting to the
cluster: $DestinationCluster");
}

Data ONTAP 、 VMware 、 WFA など、コマンドの外部にある処理とのやり取りが必要なすべてのアクションをログに記録します。WFAUtil sendLog ルーチンを使用して作成するログメッセージは、すべて WFA データベースに格納されます。これらのログメッセージは、実行されるワークフローとコマンドで使用できます。

なし

呼び出されたルーチンに渡されたすべての関連引数を記録します。

なし

適切なログレベルを使用します。 - 情報、 - エラー、 - 警告、 - デバッグは、使用可能なさまざまなログレベルです。

なし

-Info レベルでロギングする場合は、正確かつ簡潔にしてください。ログメッセージにクラス名や関数名などの実装の詳細を指定しないでください。正確な手順またはエラーの正確な説明を英語で入力してください。

次のコードスニペットは、正常なメッセージと不正なメッセージの例を示しています。

$wfa_util->sendLog('WARN', "Removing volume:
'.$VolumeName);
# Good Message
$wfa_util->sendLog('WARN', 'Invoking volume-
destroy ZAPI: '.$VolumeName);
# Bad message