vRealize Automation で vRealize Log Insight へのログ転送を設定する方法

ログを vRealize Automation から vRealize Log Insight に転送して、より確かなログ分析とレポート生成を利用できます。

vRealize Automation は、fluentd ベースのログエージェントにバンドルされています。このエージェントはログを収集して保存することで、ログをログバンドルに含めて後で検証できるようにします。vRealize Log Insight REST API を使用してログのコピーを vRealize Log Insight サーバに転送するように、エージェントを設定できます。API により、他のプログラムが vRealize Log Insight と通信できます。

vRealize Log Insight REST API のドキュメントなど、vRealize Log Insight の詳細については、vRealize Log Insight のドキュメントを参照してください。

提供されている vracli コマンドラインユーティリティを使用して、vRealize Automation ログを継続的に vRealize Log Insight に転送するようにログエージェントを構成します。

ログのすべての行には、ホスト名と環境タグがタグ付けされています。これらの行は、vRealize Log Insight で調べることができます。高可用性 (HA) 環境の場合、ログには、ログ生成元のノードに応じて、さまざまなホスト名がタグ付けされます。環境タグは、--environment ENV オプションを使用して設定できます。詳細については、以下の「vRealize Log Insight の統合の設定または更新」セクションの説明を参照してください。HA 環境の場合、環境タグの値は、ログ生成元のノードに関係なく、すべてのログ行で同じになります。

vracli コマンドラインユーティリティの使用方法については、vracli コマンドラインの --help 引数を使用して確認できます。例：vracli vrli --help。ユーザーフレンドリな応答を得る場合は、コマンドを vracli -j vrli で開始します。

注：構成できるリモートログ統合は 1 つだけです。 vRealize Log Insight サーバと Syslog サーバの両方が使用可能な場合は、 vRealize Log Insight が優先されます。

vRealize Log Insight の既存の構成の確認

Command

vracli vrli

Arguments

コマンドライン引数はありません。

Output

vRealize Log Insight 統合の現在の設定が JSON 形式で出力されます。

Exit codes

終了コードは次のとおりです。

0：vRealize Log Insight との統合が設定されています。
1：コマンドの実行中に例外が発生しました。詳細については、エラーメッセージを確認してください。
61 (ENODATA) -vRealize Log Insight との統合は設定されていません。詳細については、エラーメッセージを確認してください。

Example - check integration configuration

$ vracli vrli
No vRLI integration configured
 
$ vracli vrli
{
    "agentId": "0",
    "environment": "prod",
    "host": "my-vrli.local",
    "port": 9543,
    "scheme": "https",
    "sslVerify": false
}

vRealize Log Insight の統合の設定または更新

Command

vracli vrli set [options] FQDN_OR_URL

注：コマンドを実行した後、指定した構成がログエージェントによって適用されるまでに最大 2 分かかることがあります。

Arguments

FQDN_OR_URL
ログの送信に使用する vRealize Log Insight サーバの FQDN または URL アドレスを指定します。デフォルトでは、ポート 9543 と https が使用されます。これらの設定のいずれかを変更する必要がある場合は、代わりに URL を使用できます。
```
vracli vrli set <options> https://FQDN:9543
```
注：
次の例に示すように、ログの送信に使用するホストスキーム（デフォルトは https）とポート（デフォルトは、https では 9543、http では 9000）には別の値を設定することもできます。
```
vracli vrli set https://HOSTNAME:9543
vracli vrli set --insecure HOSTNAME
vracli vrli set http://HOSTNAME:9000
```
vRealize Log Insight の取り込み REST API では、ポートとして https では 9543、http では 9000 が使用されます。詳細については、vRealize Log Insight のドキュメントの「vRealize Log Insight の管理」と「ポートおよび外部インターフェイス」を参照してください。
オプション
- --agent-id SOME_ID
  このアプライアンスのログエージェントの ID を設定します。デフォルトは 0 です。vRealize Log Insight REST API を使用してログを vRealize Log Insight に送信するときにエージェントを識別するために使用されます。
- --environment ENV
  現在の環境の識別子を設定します。vRealize Log Insight ログで、各ログエントリのタグとして使用できるようになります。デフォルトは prod です。
- --ca-file /path/to/server-ca.crt
  vRealize Log Insight サーバの証明書の署名に使用された認証局 (CA) の証明書を含むファイルを指定します。指定された CA をログエージェントが信頼するように設定し、vRealize Log Insight サーバの証明書が信頼されていない認証局によって署名されている場合に証明書を検証できるようにします。ファイルには、証明書を検証するための証明書チェーン全体を含めることができます。自己署名証明書の場合は、証明書自体を渡します。
- --ca-cert CA_CERT
  定義は --ca-file の場合と同じですが、代わりに証明書（チェーン）が文字列としてインラインで渡されます。
- --insecure
  サーバ証明書の SSL 検証を無効にします。ログの送信時に、ログエージェントがすべての SSL 証明書を受け入れるように設定します。
詳細オプション
- --request-max-size BYTES
  1 回の API 呼び出しで複数のログイベントが取り込まれます。この引数は、各要求のペイロードの最大サイズ（バイト単位）を制御します。有効な値は 4,000 ～ 4,000,000 です。デフォルト値は 256,000 です。許容される値の関連情報については、vRealize Log Insight REST API ドキュメントで vRealize Log Insight イベントの取り込みに関する説明を参照してください。設定値が小さすぎると、許容サイズよりも大きいログイベントがドロップされる可能性があります。
- --request-timeout SECONDS
  API の呼び出しは、リモート、ネットワークの問題などのさまざまな理由からハングすることがあります。このパラメータは、接続を開く、データを書き込む、応答を待機するなどの処理が完了するのを待機する時間（秒）を表します。この時間が経過しても処理が完了しない場合、呼び出しは失敗したと見なされます。この値を 1 秒未満にすることはできません。デフォルトは 30 です。
- --request-immediate-retries RETRIES
  ログは、チャンクに集約されてから vRealize Log Insight に送信されます（次の --buffer-flush-thread-count を参照）。API 要求が失敗した場合、ログは直ちに再試行されます。即時再試行のデフォルト回数は 3 です。再試行がすべて失敗した場合は、ログのチャンク全体がロールバックされ、後で再試行されます。
- --request-http-compress
  ネットワークトラフィック量を削減するために、vRealize Log Insight サーバに送信される要求に gzip 圧縮を適用できます。このパラメータを指定しない場合、圧縮は使用されません。
- --buffer-flush-thread-count THREADS
  パフォーマンス向上とネットワークトラフィック節約のために、ログはローカルでチャンクとしてバッファリングされた後、フラッシュされてログサーバに送信されます。各チャンクには 1 つのサービスのログが含まれます。環境によっては、チャンクのサイズが大きくなり、フラッシュに時間がかかることがあります。この引数は、同時にフラッシュできるチャンクの数を制御します。デフォルトは 2 です。

注：

https を使用した統合を構成するとき、自己署名証明書や信頼されていない認証局によって署名された証明書など、信頼されていない証明書を使用するように vRealize Log Insight サーバが構成されている場合は、--ca-file、--ca-cert、--insecure の各オプションのいずれかを使用する必要があります。そうしない場合、ログエージェントがサーバの ID を検証できず、ログが送信されません。--ca-file または --ca-cert を使用する場合、vRealize Log Insight サーバ証明書がサーバのホスト名に対して有効である必要があります。いずれの場合も、処理が終わるまで数分待った後で vRealize Log Insight がログを受信したことをチェックし、統合を確認します。

Output

出力はありません。

Exit codes

終了コードは次のとおりです。

0 - 設定が更新されました。
1 - 実行中に例外が発生しました。詳細については、エラーメッセージを確認してください。

Examples - Configure or update integration configuration

次のサンプルステートメントは個別のコマンドラインに分かれて表示されていますが、引数を 1 つのコマンドラインにまとめることができます。たとえば、 vracli vrli set { somehost} または vracli vrli set --ca-file path/to/server-ca.crt を使用してデフォルトのエージェント ID または環境の値を変更するときに、複数の引数を含めることができます。関連情報については、 vracli vrli --help で表示されるオンラインコマンドのヘルプを参照してください。

$ vracli vrli set my-vrli.local 
$ vracli vrli set 10.20.30.40
$ vracli vrli set --ca-file /etc/ssl/certs/ca.crt 10.20.30.40
$ vracli vrli set --ca-cert "$(cat /etc/ssl/certs/ca.crt)" 10.20.30.40
$ vracli vrli set --insecure http://my-vrli.local:8080
$ vracli vrli set --agent-id my-vrli-agent my-vrli.local
$ vracli vrli set --request-http-compress
$ vracli vrli set --environment staging my-vrli.local
$ vracli vrli set --environment staging --request-max-size 10000 --request-timeout 120 --request-immediate-retries 5 --buffer-flush-thread-count 4 my-vrli.local

vRealize Log Insight の統合のクリア

Command

vracli vrli unset

注：コマンドを実行した後、指定した構成がログエージェントによって適用されるまでに最大 2 分かかることがあります。

Arguments

コマンドライン引数はありません。

Output

確認はプレーンテキスト形式で出力されます。

Exit codes

次の終了コードが使用可能です。

0 - 設定がクリアされたか、設定がありませんでした。
1 - 実行中に例外が発生しました。詳細については、エラーメッセージを確認してください。

Examples - Clear integration

$ vracli vrli unset
Clearing vRLI integration configuration
 
$ vracli vrli unset
No vRLI integration configured