PowerShell ステップのログ記録を構成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:3分
  • PowerShell ステップのスクリプトにログメッセージを追加します。ログ記録とデバッグを改善するために、ログレベルを使用します。

    始める前に

    スクリプトにログメッセージを追加するには、Write-SNCLog 機能を使用する必要があります。この機能は IH\Logging.psm1 モジュールで定義されています。PSScript.ps1 を使用してこのモジュールをインポートし、インラインスクリプトが Write-SNCLog にアクセスできるようにします。詳細については、「MID サーバーの PowerShell ファイル」を参照してください。

    必要なロール:admin

    手順

    1. 移動先 すべて > MID サーバー > プロパティ.
    2. mid.property.powershell.log_infotrue に設定します。
      このプロパティは、ログ記録を有効または無効にします。詳細については、「PowerShell ログプロパティ」を参照してください。
    3. mid.property.powershell.ih.log_level を希望のログレベルに設定します。
      ログレベルにより、メッセージをログに記録するために必要なしきい値を指定します。指定されたレベル以上のメッセージがログに記録されます。たとえば、このプロパティが [WARN] に設定されている場合、WARN または ERROR レベルのメッセージがログに記録されます。レベルが INFO、DEBUG、または TRACE のメッセージは、ログに記録されません。次のレベルがあります。低いレベルから高いレベルの順に記載しています。
      • TRACE
      • DEBUG
      • INFO
      • WARN
      • ERROR
      デフォルト値は INFO です。
    4. オプション: インスタンスのログを表示できるように、システムプロパティを設定します。
      1. 移動先 すべて > プロセスの自動化 > Flow Designer > プロパティ.
      2. フローログに複製するシステムログエントリのログレベルを指定します。システムは、指定されたレベル以上のログエントリのみ複製し[INFO] または [DEBUG] に設定します。

      PowerShell スクリプトをビルドして実行した後、ログは MID エージェントログで利用可能になります。このプロパティを設定すると、インスタンスで直接ログを表示することもできます。

      このステップでは、com.glide.hub.flow_engine.listener_trace.threshold プロパティを設定します。フローエンジンのログエントリ [sys_flow_log] テーブルにログを複製します。

    5. PowerShell スクリプトで、Write-SNCLog 機能を使用してログ メッセージとレベルを追加します。
      表 : 1. Write-SNCLog 機能とパラメーター
      名前 説明
      Write-SNCLog 機能 PowerShell ステップのメッセージをログに記録します。Write-SNCLog には、-Level-Message の 2 つのパラメーターがあります。どちらのパラメーターも必須ですが、パラメーターの名前は省略できます。名前を省略すると、位置に基づき、レベルとメッセージが決定されます。例:
      • Write-SNCLog -Level WARN -Message "log warning"
      • Write-SNCLog WARN "log warning"
      これらの例はどちらも、WARN: log warning をログに記録します。
      -Level パラメーター ログメッセージのレベルを指定します。有効な値は次のとおりです。
      • ERROR
      • 警告
      • INFO
      • DEBUG
      • TRACE
      このパラメーターは必須です。
      -Message パラメーター ログに記録するメッセージを指定します。文字列として入力します。このパラメーターは必須です。
    6. アクションまたはフローのビルドを続行した後、テストして実行します。

    次のタスク

    新しいログは MID エージェントログで利用可能になり、MID サーバーからダウンロードできます。詳細については、「MID サーバーのファイルのダウンロード」を参照してください。

    インスタンスのログを表示するようにシステムプロパティを設定すると、フローエンジンのコンテキストレコードの [ フローエンジンのログエントリ] タブでログを確認できます。詳細については、「フロー実行の詳細」を参照してください。