基本設定
WhaTapサーバーモニタリングエージェントは、whatap.conf設定ファイルを通じて動作を制御します。このドキュメントでは、エージェントの基本設定を案内します。
設定ファイルの場所
- Unix/Linux:
$WHATAP_HOME/whatap.conf - Windows:
%WHATAP_HOME%\whatap.conf
設定変更後、変更事項を適用するにはエージェントを再起動する必要があります。
エージェント名の識別
WhaTapは、モニタリング情報の収集対象となるインフラストラクチャサーバーの識別のために、サーバーから収集した情報を使用します。 既定値は、サーバーのホスト名(hostname)です。
- エージェント名は、プロジェクトごとに一意である必要があります。
- エージェントID／名前を変更しても、古いデータには関連付けられません。
ユーザーが設定したエージェント名を WhaTapのモニタリングサービスを確認するには、サーバーを再起動してください。
ユーザーフレンドリーな名前を指定する場合、次のように設定ファイルに指定できます。
-
Linux Shell
export WHATAP_SERVER_NAME=ユーザーフレンドリーな名前
echo "oname=$WHATAP_SERVER_NAME" |sudo tee -a /usr/whatap/infra/conf/whatap.conf -
Windows Power Shell
# 管理者権限が必要です。
$WHATAP_SERVER_NAME="ユーザーフレンドリーな名前"
Add-Content "C:\Program Files\WhatapInfra\whatap.conf" "oname=$WHATAP_SERVER_NAME"
ネットワーク設定
WhaTapは、エージェントにサーバー通信でTCP接続してからモニタリングデータを送信します。
エージェントは、1つのTCP セッションを介してデータ送信とサーバーの制御要求を処理します。ノードエージェントはUDPを使用しません。ノードエージェントからWhaTap収集サーバーの通信はファイアウォールを開きます。
収集サーバーのアドレスとポート
WhaTapサーバーは、データリージョンサーバーとフロントサーバー、ユーレカなどに区分します。データリージョンにはProxy、Yard、Gateway、Keeperなどがあります。エージェントは、Proxyサーバーと通信します。
NodeエージェントにWhaTapサーバのproxyサーバのアドレスを設定します。(ex,whatap.server.host=10.0.3.1/10.0.3.2)サーバアドレスを設定する場合、proxyサーバの数を入力します。WhaTapサーバは、インストール方法によって、proxyサーバを1つまたは複数使用できます。
WhaTap Proxyサーバは6600番ポートでリスニング(Listening)します。エージェントで何も設定しない場合、エージェントは6600番ポートへの接続を試みます。
whatap.server.port=6600
2つのProxyサーバーが異なるポートを使用することはできません。複数のProxyサーバーを使用している場合は、(Listening) ポートが同じである必要があります。
通信接続およびセキュリティ
WhaTapは、パブリックネットワークでモニタリングデータを収集することを前提に設計されています。そのため、すべてのモニタリングデータを暗号化してサーバーに送信します。WhaTapは、オーバーヘッドを最小限に抑えるため、データを選択的に暗号化します。エージェントとサーバー間の通信プロセスは次のとおりです。
- プロジェクト作成時にプロジェクトアクセスキーを生成してコピーします。
- プロジェクトアクセスキーには秘密鍵が含まれているため、外部に露出しないように注意してください。
- エージェントを起動すると、WhaTap収集サーバーにTCPセッションを接続します。
- プロジェクトアクセスキーに含まれる通信用秘密鍵でデータを暗号化し、新しいセッション用セキュリティキーをリクエストします。
- サーバーは、エージェントがリクエストしたセッション用セキュリティキーを生成してエージェントに渡します。
- その後、エージェントはテキスト、数値などのデータを暗号化してサーバーに送信します。
変更を有効にするには、サーバーを再起動してください。
エージェントリソース制限
Linux及びWindowsサーバーで使用するWhaTapのサーバーモニタリングエージェントは、過負荷発生時にサーバーの安定性を維持し、資源使用量の影響を最小限にするため、次のようなエージェント設定を提供します。
Linux / Windows
メモリ使用量の保護
WhaTapエージェントは、メモリの使用量が臨界点(100MB)を超える場合、自動的にプロセスを再起動し、ユーザーサーバーの利用可能なメモリを保護します。
memory.usage.limit=104857600 #メモリ使用量の臨界値(100MB、バイト単位)
自動的再起動
WhaTapエージェントは1日1回、自動的に再起動されます。 該当サイクルはユーザー設定を通じて調整可能です。 この機能は、データ収集の障害と一時的なプロセスの誤動作を解消するために提供されます。
housekeeping.enabled=true #自動的な再起動機能の活性化(デフォルト：true)
housekeeping.hour=2 #再起動時間(サーバー時間基準、デフォルト：2時)
housekeeping.exitoncheckfail=true #収集障害の発生時、自動的に再起動(デフォルト：true)
再起動の時刻は、時間単位のほかに分単位でも指定できます。housekeeping.minuteオプションをあわせて設定すると、エージェントはhousekeeping.hourとhousekeeping.minuteが指す時刻以降に再起動します。サーバーが多い環境では、再起動の時刻が正時に集中しないよう、サーバーごとに分の値を分けて指定できます。
housekeeping.hour=2 #再起動時間(サーバー時間基準、デフォルト：2時)
housekeeping.minute=30 #再起動の分(デフォルト：0)
| Item | Description |
|---|---|
housekeeping.hour | 再起動時刻の時（hour）。デフォルト値2 |
housekeeping.minute | 再起動時刻の分（minute）。デフォルト値0。0の場合は従来と同じく、指定した時（hour）内に再起動 |
サポートするエージェントバージョンは、Linux・Windowsは2.9.22以上、Unix（AIX・HP-UX・Solaris）は1.4.13以上です。
CPU使用量の保護
CPUの使用量が臨界値を超える場合、WhaTapエージェントは実行速度を自動的に調整してサーバーのCPU可用性を保護します。 デフォルトでは非アクティブになっており、必要に応じてアクティブにできます。
cpu.limit.enabled=false # CPU使用量の保護機能を非アクティブにする(デフォルト：false)
cpu.usage.limit=50 # CPU使用量の臨界値(単一コア基準 50%)
Windows
Handle使用量の保護
Windows環境では、WhaTapエージェントが使用するHandleの数が臨界点(1000個)を超える場合、自動的に再起動してユーザサーバーの利用可能なHandleを保護します。
windows.handle.threshold=1000 # Handle使用量の臨界値(既定値：1000個)
PDH収集エラー時の再起動基準
Windowsエージェントは、パフォーマンス指標をPDH（Performance Data Helper）で収集します。PDHは、カウンターインスタンスが一時的に消えるなどの一時的なエラーを返すことがあります。エージェントは、PDHの収集が所定の回数だけ連続して失敗した場合にのみ収集障害と判断し、再起動します。失敗回数がそれより少ない場合は、その収集周期だけをスキップして収集を続けます。
pdh.error.restart.limit=12 # 再起動の基準となる連続失敗回数（デフォルト：12）
| Item | Default | Description |
|---|---|---|
pdh.error.restart.limit | 12 | PDH収集の連続失敗許容回数。この回数に達すると収集障害とみなして再起動 |
一度でも収集に成功すると、連続失敗回数をリセットします。サポートするエージェントバージョンは、Windows 2.9.26以上です。
ウォッチドッグの通信方式
Windows環境のエージェントは、監視プロセス（ウォッチドッグ）と収集プロセスが互いに状態をやり取りします。この通信にはデフォルトで名前付きパイプ（named pipe）を使用し、パイプへの書き込みが失敗して通信が切断される環境では、ローカルTCPソケット方式に変更できます。
housekeeping.rpc.mode=socket #ウォッチドッグの通信方式(デフォルト：pipe)
housekeeping.rpc.port=6601 #socket方式で使用するポート(デフォルト：6601)
| Item | Description |
|---|---|
housekeeping.rpc.mode | ウォッチドッグの通信方式。socketを指定するとローカルTCPソケットを使用。デフォルトは名前付きパイプ |
housekeeping.rpc.port | socket方式で使用するTCPポート。デフォルト値6601 |
socket方式はサーバー内部（ローカル）の通信にのみ使用するため、外部のファイアウォールを開放する必要はありません。ただし、指定したポートを他のプログラムが使用していないか確認してください。
収集項目別の周期設定
サーバーモニタリングエージェントは、サーバーメトリクス V2のカテゴリごとに決められたデフォルト周期でデータを収集します。すべての項目を同じ周期で収集する必要がない環境では、カテゴリごとに周期を延ばしたり、使用しないカテゴリの収集を停止したりして、エージェントの負荷と送信量を減らせます。この節は、収集範囲をきめ細かく調整したいサーバー運用者を対象としています。
whatap.confファイルに、カテゴリごとのcounter.{項目}.intervalキーを追加してください。値は次のように解釈します。
| Value | Description |
|---|---|
| 未設定または負の値 | デフォルトの収集周期を維持 |
0 | 該当カテゴリの収集を停止 |
| 正の値 | 指定した値（秒）を収集周期として使用 |
counter.infracpu.interval=10 # infra_cpuを10秒ごとに収集
counter.infrantpinfo.interval=0 # infra_ntp_infoの収集を停止
設定ファイルを保存すると、エージェントを再起動しなくても次の収集から反映されます。キーを削除すると、デフォルト周期に戻ります。
| Item | Category | Default | OS |
|---|---|---|---|
counter.hostinfo.interval | サーバーインベントリ（ホスト情報） | 3600 | Linux, Windows, Unix |
counter.infracpu.interval | infra_cpu | 2 | Linux, Windows, Unix |
counter.infracpucores.interval | infra_cpu_core | 5 | Linux, Windows, Unix |
counter.inframem.interval | infra_mem | 2 | Linux, Windows, Unix |
counter.infrakernel.interval | infra_kernel | 2 | Linux, Windows, Unix |
counter.infraswap.interval | infra_swap | 2 | Linux, Windows, Unix |
counter.infradisk.interval | infra_disk | 2 | Linux, Windows, Unix |
counter.infradiskperf.interval | infra_disk_perf | 5 | Linux, Windows, Unix |
counter.infrafilesystem.interval | infra_filesystem | 5 | Linux, Windows, Unix |
counter.infranetwork.interval | infra_network | 2 | Linux, Windows, Unix |
counter.infranicperf.interval | infra_nic_perf | 5 | Linux, Windows, Unix |
counter.infranicinfo.interval | infra_nic_info | 60 | Linux, Windows, Unix |
counter.infranetstat.interval | infra_netstat | 60 | Linux, Unix |
counter.infrantpinfo.interval | infra_ntp_info | 60 | Linux, Windows, Unix |
counter.infraprocess.interval | infra_process | 2 | Linux, Windows, Unix |
counter.infraprocesstopn.interval | infra_process_topn | 5 | Linux, Windows, Unix |
counter.infraprocessgroup.interval | infra_process_group | 5 | Linux, Windows, Unix |
counter.infrazpoolperf.interval | infra_zpool_perf | 5 | Linux, Unix |
counter.infraosparameter.interval | infra_os_parameter | 3600 | Linux, Unix |
counter.infrawinservice.interval | infra_win_service | 60 | Windows |
Default列は秒単位のデフォルト周期で、UnixはAIX・HP-UX・Solarisを指します。
Unixエージェントの最小周期
Unixエージェントには、カテゴリごとに最小周期（2秒または5秒）があります。これより小さい正の値を入力すると、最小周期に切り上げて適用します。
counter.infraosparameter.intervalとos.parameter.intervalを両方設定すると、counter.infraosparameter.intervalが優先されます。OSパラメーターの収集オプションは、OS Parameter情報を参照してください。
サポートするエージェントバージョンは、Linux・Windowsは2.9.22以上（キーごとに2.9.12から順次サポート）、Unix（AIX・HP-UX・Solaris）は1.4.17以上です。