ターゲット マシンでカスタム スクリプトを実行し、カスタム データを収集して、メトリックとして使用することができます。

前提条件

  • カスタム スクリプトを使用して実行するすべてのスクリプトでは、単一の整数値を出力する必要があります。出力が単一の整数値ではない場合、ユーザー インターフェイスにエラーが表示されます。
  • カスタム スクリプトは、ターゲット マシンのオペレーティング システムでスクリプトを実行するために、Telegraf の exec プラグインを使用します。Linux オペレーティング システムでは、特定の権限を持つ arcuser という特殊なユーザーが、このエージェントをインストールするために作成されます。その結果、exec プラグインでは、 arcuser ユーザーを使用してスクリプトを実行します。arcuser でカスタム スクリプトを使用するスクリプトを実行できることを確認します（ arcuser には、スクリプトを実行するための権限が必要です）。たとえば、クラウド プロキシによって自動的に作成された arcuser には、/root ディレクトリに格納されているスクリプトを実行する権限がありません。
  • Windows オペレーティング システムでは、Telegraf エージェントをインストールする際にシステム ユーザーが使用されます。その結果、exec プラグインはこのシステム ユーザーを使用してスクリプトを実行します。システム ユーザーが権限を持っていて、カスタム スクリプトを実行できることを確認します。
  • スクリプトは /opt/vmware フォルダに配置する必要があります。
  • ユーザーが powershell -File プリフィックスを使用している場合、Windows オペレーティング システムで PowerShell スクリプトを実行するには、環境変数 PATH を設定する必要があります。たとえば、環境変数 PATH 変数で「%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\」を設定します。

カスタム スクリプトの実行方法

  • [Telegraf エージェントの管理]タブで、[エージェント ステータス] > [エージェント実行中] を選択してフィルタリングします。
  • エージェントがインストールされているターゲット マシンのドロップダウン矢印を展開します。[カスタム監視] セクションが表示されます。
  • [カスタム スクリプト] オプションの縦方向の省略記号をクリックし、[追加] をクリックします。
  • [カスタム サービスの管理] ダイアログ ボックスで、監視対象の Windows サービスを追加および構成できます。

インスタンス設定

オプション 説明
ステータス カスタム スクリプトの実行を有効にします。
表示名 スクリプトに適切な名前を追加します。* は無効な文字であるため、名前に使用することはできません。
Filepath ターゲット マシンのスクリプト ファイルへのパスを入力します。

例：

Linux マシンの場合： 
 /opt/vmware/scripts/customscript.py
Windows マシンの場合： 
c:\scripts\customscript.ps1
プレフィックス 必要に応じてプリフィックスを入力します。

例：

Linux マシンの場合：python2.7、/bin/bash、perl など

Windows マシンの場合：powershell -File
引数 スクリプト内の引数を一覧表示します。
タイムアウト 仮想マシンのスクリプト実行タイムアウトを入力します。

スクリプトを保存すると、[カスタム スクリプト] の下に表示されます。追加したカスタム スクリプトの縦方向の省略記号で [編集] または [削除] オプションをクリックすると、スクリプトを編集または削除できます。スクリプトを追加して保存したら、[カスタム スクリプト] のドロップダウン矢印をクリックして、スクリプトとそのステータスのリストを表示します。

注：
  • エラーを伝達するために、カスタム スクリプトではすべてのエラーを ERROR|<Error_message> 形式でスローする必要があります。スクリプトで指定された形式でエラーがスローされない場合、VMware Aria Operations はユーザー インターフェイスにエラーメッセージ「Unable to parse the error message. Please check the endpoint」を表示します。これは、設計仕様であり、クラウド プロキシによって正確なエラー メッセージが伝達されるまで表示されます。
  • bash スクリプトは shebang (#!/bin/bash) で始まる必要があります。

[すべてのメトリック] タブ

データが正常に収集されたら、[すべてのメトリック] タブで、ターゲット マシンのメトリックとしてスクリプトが表示されます。スクリプト メトリックは、ターゲット マシンごとの単一オブジェクトである Custom Script と呼ばれるオブジェクトの下に作成されます。ターゲット マシンのスクリプトのすべてのメトリックは、作成したすべてのカスタム スクリプトを含む Custom Script オブジェクトの下に配置されます。特定のメトリックの出力を確認できます。Scripts フォルダの下にあるメトリック名は、スクリプト設定の作成時にユーザーが指定した表示名です。たとえば、表示名を Python script として設定すると、データが正常に収集された場合、[Python script] という名前のメトリックが作成されます。