本文へスキップ

拡張機能

拡張パックの設定​

通常のインストール後に拡張パックの機能を使用するには、構成ファイルを作成し、次のようにエージェントを再起動します。

MySQLサーバーリスト​

MySQL/MariaDB モニタリングエージェントが利用可能です。

Web URLの性能チェック​

WhaTapインフラエージェントは、与えられたWebアドレスに接続し、接続有無および応答時間を収集します。収集されたWeb URLの性能はカテゴリserver_webcheckで確認できます。次のコマンドでチェックするWebアドレスを追加します。URLモニタリングサービスの詳細については、次の文書を参照してください。

echo "チェックするウェブアドレス" | sudo tee -a /usr/whatap/infra/conf/webcheck.conf
echo "webcheck.enabled=true" | sudo tee -a /usr/whatap/infra/conf/whatap.conf
sudo service whatap-infra restart

Redisインスタンス​

WhaTapインフラエージェントは、特定のRedisアドレスに接続し、接続数を含む複数の性能指数を収集します。収集された性能情報は、カテゴリserver_redisで確認できます。次のコマンドでチェックするRedisサーバーの接続情報を追加できます。

sudo echo "addr=Redisアドレス:ポート番号" | sudo tee /usr/whatap/infra/conf/redis.conf
sudo echo "password=Redisパスワード" | sudo tee -a /usr/whatap/infra/conf/redis.conf
sudo service whatap-infra restart

Memcachedインスタンス​

WhaTapインフラエージェントは、特定のMemcachedアドレスに接続し、接続数を含む複数の性能指数を収集します。収集された情報は、カテゴリserver_memcachedで確認できます。次のコマンドでチェックするMemcachedサーバーの接続情報を追加できます。

sudo echo "addr=Memcachedアドレス:ポート番号" | sudo tee /usr/whatap/infra/conf/memcached.conf
sudo echo "password=Memcachedパスワード" | sudo tee -a /usr/whatap/infra/conf/memcached.conf
sudo service whatap-infra restart

TCPポートモニタリング​

ネットワークデーモンの受信ポートが無効になった場合に通知を受け取ることができます。

ホーム画面 > プロジェクトの選択 > アラート通知 > イベント設定 > サーバータブを選択して、+ イベント設定追加ボタンを選択します。

TCPポート

  • number-sポート指標のトグルボタンをクリックして、使用状態に変更します。

  • number-s 保存ボタンを選択して保存します。

  • 対象サーバーに、次のコマンドを追加します。

#以下の変数にモニタリング対象IPを指定します。
export TARGET_IP=127.0.0.1
#以下の変数にモニタリング対象ポート番号を指定します。
export TARGET_PORT=80
echo "tcp.check.$TARGET_PORT=tcp://$TARGET_IP:$TARGET_PORT" |sudo tee -a /usr/whatap/infra/conf/whatap.conf
ノート

マルチポートモニタリング​

複数のポートをモニタリングするためにはwhatap.confファイル内の追加設定が必要です。 次の例を参考にしてください。

whatap.conf
# port 8080, port 80 
tcp.check.8080=tcp://127.0.0.1:8080
tcp.check.80=tcp://127.0.0.1:80

プロセスFile Descriptor情報の収集​

プロセスFile Descriptor情報は、サーバーリスト > サーバー 詳細画面のプロセスウィジェットで確認できます。

echo "process.fdcheck=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

サーバースペック収集​

CPU、MEMORY、DISK、NICの仕様とインストールされたパッケージおよび仮想マシンのメタ情報を収集します。 各カテゴリで、次の内容を確認できます。

  • server_package：インストールされているパッケージです。
  • server_inventory：CPU、MEMORY、DISK、NICの仕様です。
  • server_pending_security_update：Linuxのセキュリティパッチの待機リストです。
echo "inventory.product.enabled=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

Linuxコンテナの性能収集​

LinuxコンテナのCPU、MEMORY、DISK、NIC性能を収集します。収集された性能情報は、カテゴリserver_containerで確認できます。

Linux Shell
echo "container.enabled=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

Windowsサーバーサービスの動作状態を収集する​

ウィンドウサーバーサービスの運用状態を収集します。収集されたサービスの運用状態はカテゴリ server_windows_serviceで確認できます。

Windows Powershell
# 管理者権限が必要です。
Add-Content -Path "C:\Program Files\WhatapInfra\whatap.conf" -Value "winservice.enabled=true"

ファイルモニタリング​

ファイルシステム上に存在または存在する可能性のあるファイルおよびディレクトリをモニタリングできます。

echo "filecheck.enabled=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf
echo "モニタリングするファイルまたはディレクトリのフルパス" |sudo tee -a /usr/whatap/infra/conf/filesystem.conf

WhaTapエージェントのログオプション​

ログの保存場所​

WhaTapエージェントログ(whatap_infrad.log、whatap_infra.log、whatap_infrad.fork.stdout.log)のパスを変更します。指定パスがない場合は、WhaTapエージェントは指定パスの作成を試みます。エージェント2.0.6バージョン以降に対応されています。

echo "agent.log.prefix=変更するディレクトリ" |sudo tee -a /usr/whatap/infra/conf/whatap.conf
ノート

Windowsの場合、パスの区切り文字を\\と入力できます。

ログ出力制御オプション​

サーバーモニタリングエージェントのログは、デフォルトで /var/log ディレクトリ配下に保存されます。
以下のオプションを使用して、ログファイルのサイズ上限およびバックアップファイル数を調整できます。

  • Linux / Windows
    • agent.log.size
      • 既定値：10（単位：MB）
    • agent.log.backupfile
      • 既定値：2（単位：個数）

Netstatモニタリング​

netstatコマンドが入力された場合、1分間隔で収集され、カテゴリserver_netstat(netstat connection統計)、server_netstat_s(netstat -sコマンドの結果)がアップロードされます。

echo "netstats.enabled=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

ユーザースクリプトモニタリング​

Linuxサーバーで実行可能なユーザースクリプトを定期的に実行して結果をアップロードします。 ユーザースクリプトモニタリング機能は、決められたサイクルに従ってスクリプトを実行し、その結果を収集サーバーにアップロードします。 30秒周期間隔でスクリプトを実行して結果を収集します。

データはスクリプト実行が完了した時点を基準に収集され、実行するスクリプト内容によって実際の収集時刻とデータ反映時刻には一部差が生じることがあります。 次の例を参考にして、ユーザースクリプトを作成します。

  1. スクリプトを次のように作成して実行してください。

    Linux Shell
    #!/bin/bash

    urls=("https://www.whatap.io"  "https://blog.whatap.io"  "https://service.whatap.io")

    for url in ${urls[*]}; do

    echo "M $url url $url"
    curl -w @- -o /dev/null -s "$url" <<'EOF'
    M %{url_effective} url %{url_effective}\n
    H %{url_effective} time_namelookup %{time_namelookup}\n
    H %{url_effective} time_connect %{time_connect}\n
    H %{url_effective} time_appconnect %{time_appconnect}\n
    H %{url_effective} time_pretransfer %{time_pretransfer}\n
    H %{url_effective} time_redirect %{time_redirect}\n
    H %{url_effective} time_starttransfer %{time_starttransfer}\n
    H %{url_effective} time_total %{time_total}\n
    EOF

    done

  2. 次のように出力されるか確認してください。

    Linux Shell
    $ ./curl.sh
    M https://www.whatap.io/ url https://www.whatap.io/
    H https://www.whatap.io/ time_namelookup 0.007289
    H https://www.whatap.io/ time_connect 0.010702
    H https://www.whatap.io/ time_appconnect 0.033637
    H https://www.whatap.io/ time_pretransfer 0.033831
    H https://www.whatap.io/ time_redirect 0.000000
    H https://www.whatap.io/ time_starttransfer 0.043230
    H https://www.whatap.io/ time_total 0.043312
    M https://blog.whatap.io/ url https://blog.whatap.io/
    H https://blog.whatap.io/ time_namelookup 0.000000
    H https://blog.whatap.io/ time_connect 0.000000
    H https://blog.whatap.io/ time_appconnect 0.000000
    H https://blog.whatap.io/ time_pretransfer 0.000000
    H https://blog.whatap.io/ time_redirect 0.000000
    H https://blog.whatap.io/ time_starttransfer 0.000000
    H https://blog.whatap.io/ time_total 0.005654
    M https://service.whatap.io/ url https://service.whatap.io/
    H https://service.whatap.io/ time_namelookup 0.004296
    H https://service.whatap.io/ time_connect 0.007282
    H https://service.whatap.io/ time_appconnect 0.038404
    H https://service.whatap.io/ time_pretransfer 0.038607
    H https://service.whatap.io/ time_redirect 0.000000
    H https://service.whatap.io/ time_starttransfer 0.055226
    H https://service.whatap.io/ time_total 0.055307

  3. スクリプトの正常収集を確認し、次のようにWhaTapサーバーのモニタリングエージェントにスクリプトを登録してください。

    Linux Shell
    export USER_SCRIPT=実行するユーザースクリプトのフルパス
    suco chmod +x $USER_SCRIPT
    sudo mkdir /usr/whatap/infra/ext/
    sudo cp -r $USER_SCRIPT /usr/whatap/infra/ext/
    export RUNAS_USER=ユーザースクリプトを実行するアカウント、rootアカウントを除く
    sudo WHATAP_HOME=/usr/whatap/infra/conf /usr/whatap/infra/whatap_infrad --user=$RUNAS_USER init-script
    sudo service whatap-infra restart

収集されたデータは、分析 > メトリクスチャートのカテゴリserver_ext_フォルダ_実行スクリプトで確認できます。

サーバー時間同期化モニタリング​

ノート

事前確認

  • OS：Linux

  • WhaTapサーバーモニタリングエージェントバージョン：2.5.4以降

次のオプションを使用してサーバー時間の同期化(NTP) モニタリング機能を活性化することができます。

echo "ntpq.enabled=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

追加指標の案内​

サーバー時間の同期化モニタリング機能を活性化する時に追加されるメトリクスは以下の通りです。

server_ntpq​

Tags​
タグ名説明備考
refid当該リモート(remote)の時間同期化ソースを意味します。-
remoteホストが時間同期化を実行する対象サーバーを意味します。-
Fields​
フィールド名単位説明備考
delaymsサーバーが送信したクエリへのレスポンスとして返信パケットを返すのにかかった時間を意味します。-
jitter-2つのサンプル間のオフセット測定の違いから推定した誤差の境界値を意味します。-
offsetmsサーバー設定時間とクライアント設定時間の差を意味します。-
pollsecondntp.confファイルでminpoll値として定義されたリモートホストへのポーリング間隔を意味します。-
reach-サーバーに到達する試みがどれほど成功しているかを確認できます。 2^0の位置に最新のクエリの成否を記録し、8ビットシフトレジスタで動作します。-
st-リモートホストのストラタムレベルを意味します。-
sync_client-1：同期化サーバーが存在します。-
0：同期化サーバーが存在しません。
t-使用可能なタイプは次のとおりです。-
l：ローカル(例：GPS時計)
u：ユニキャスト(一般的なタイプ)
m：マルチキャスト
b：ブロードキャスト
whensecondリモートホストの応答から過ぎた時間(秒)を意味します。-

Linuxシステムログモニタリング​

Linuxシステムログをリアルタイムでアップロードして、障害発生時点のログを確認できます。収集対象のログファイルは次のとおりです。

  • /var/log/syslog
  • /var/log/messages

設定方法は次のとおりです。

Linux Shell
echo "systemlog.enabled=true" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

ログモニタリングプラグイン​

ランダムなログを収集できます。次の設定の場合、エージェントの再起動が必要です。

Linux Shell​

  • 基本インストール

    Linux Shell
    export LOGFILES=/some/path/file1,/some/other/file2
    echo "logsink.files=$LOGFILES" | sudo tee -a /usr/whatap/infra/conf/whatap.conf

  • カテゴリ付きインストール

    Linux Shell
    cd /usr/whatap/infra
    sudo mkdir extension

    cat <<EOL | sudo tee extension/logsink.conf > /dev/null
    [[inputs.logsink]]
      category = "serverlog"
      ## ログ発生量統計の別途データとしての送信有無
      stats_enabled = true 
      ## 対数発生量の統計カテゴリ
      stats_category = "logsink_stats"
      ## ログファイルパス(path)にアスタリスク(*)が含まれれ、除外するログ非対象ファイル名を設定 
      excludeNames = [ ".gz",".zip" ] 
      [[inputs.logsink.file]]
        ## ログファイルの指定時、日付パターン(strftime.org)指定可能
        path = "/some/path/%Y-%m-%d/.log" 
        disabled = false
        encoding = "utf-8"

      [[inputs.logsink.file]]
        path = "/some/other/log"
        disabled = false
        encoding = "utf-8"

      [[inputs.logsink.file]]
        ## 行単位ログで該当キーワードを検索する時、以前のログにマージ
        nowrap_keywords = ["Caused by:", "Test"]

      [[inputs.logsink.file]]
      ## プロジェクトコード及びプロジェクトライセンスの入力時、ログを同じリージョンの希望するプロジェクトに転送可能
      # pcode = プロジェクトコード
      # license = "プロジェクトライセンス"

      [[inputs.logsink.file]]
      # whatap_host_ip = "収集サーバーIP1/収集サーバーIP2"
      # whatap_host_port = 6600

      [[inputs.logsink.file]]
      path = "/tmp/mixed.log"
      disabled = false
      encoding = "utf-8"
      ## [{"A":1,"B":2},{"C":3,"D":4},...] 形態をそれぞれのログに分離できる{"A":1,"B":2} {"C":3,"D":4}
      multiline_pattern = "simple_json_array"
    EOL

    sudo service whatap-infra restart

Windows Powershell​

  • 基本インストール

    Windows Powershell
    $LOGFILES="c:\\whatap\\logs\\%Y-%m-%d\\*.log,c:\\whatap\\logs\\*.log"
    Add-Content "c:\Program Files\WhatapInfra\whatap.conf" -Value "logsink.files=$LOGFILES"

  • カテゴリ付きインストール

    Windows Powershell
    # 管理者権限が必要
    New-Item -type "Directory" -Path "C:\Program Files\WhatapInfra\extension"

    $contentToAdd = @"
    [[inputs.logsink]]
    category = "serverlog"
    ## ログ発生量統計の別途データとしての送信有無
    stats_enabled = true 
    ## 対数発生量の統計カテゴリ
    stats_category = "logsink_stats"
    ## ログファイルパス(path)にアスタリスク(*)が含まれ、除外するログの非対象ファイル名を設定 
    excludeNames = [ ".gz",".zip" ] 
    [[inputs.logsink.file]]
    ## ログ ファイルの指定時、日付パターン(strftime.org)指定可能
    path = "c:\\whatap\\logs%Y-%m-%d_.log"
    disabled = false
    encoding = "utf-8"

    [[inputs.logsink.file]]
    ## 行単位ログで該当キーワードを検索する時、以前のログにマージ
    nowrap_keywords = ["Caused by:", "Test"]

    [[inputs.logsink.file]]
    ## プロジェクトコード及びプロジェクトライセンスの入力時、ログを同じリージョンの希望するプロジェクトに転送可能
    # pcode = プロジェクトコード
    # license = "プロジェクトライセンス"

    [[inputs.logsink.file]]
    # whatap_host_ip = "収集サーバーIP1/収集サーバーIP2"
    # whatap_host_port = 6600

    [[inputs.logsink.file]]
    path = "/tmp/mixed.log"
    disabled = false
    encoding = "utf-8"
    ## [{"A":1,"B":2},{"C":3,"D":4},...] 形態をそれぞれのログに分離することができる。
    {"A":1,"B":2} {"C":3,"D":4}
    multiline_pattern = "simple_json_array"

    "@

    New-Item -path "C:\Program Files\WhatapInfra\extension" -name "logsink.conf" -type "file" -value $contentToAdd -Force

    Restart-Service "Whatap Infra"

オプション設定​

  • stats_enabled：収集ステータスデータの収集有無を設定します。 (既定値: false)

    • true に設定する必要があり、stats_category で設定したカテゴリ（logsink_stats）に統計データが生成されます。

  • stats_category：収集ステータスデータを保存するメトリクスカテゴリを設定します。 logsink_statsに設定する必要があります。 統計データのフィールドは次のとおりです。

    保存される統計データフィールド: file checkInterval encoding filepos checkedLocalTime lastupdatedLocalTime fileSize error firstCheck transferBytes

  • excludeNames：ログファイルのパス（path）にアスタリスク（*）が含まれている場合、ログ収集対象外のファイル名を設定して除外することができます。 カンマ（,）を区切り文字として使用することで、複数の値を設定できます。

    Example
    excludeNames = [ ".gz",".zip" ]

  • nowrap_keywords: 行単位のログ検索時に、このオプションで指定されたキーワードが検出されると、前のログと結合されます。

  • pcode: ログを送信する同じリージョンのプロジェクトコードを入力します。

  • license: ログを送信する同じリージョンのプロジェクトのライセンスコードを入力します。

ノート

pcode、licenseオプションの場合、サーバーエージェント2.7.4バージョン以降に対応します。

Windowsイベントログのオプション設定​

Windowsイベントログ収集時、次のようにオプションを設定することができます。

# 管理者権限が必要
New-Item -type "Directory" -Path "C:\Program Files\WhatapInfra\extension"

$contentToAdd = @"
[[inputs.win_eventlog]]
    category = "win_event_log"
    stats_category = "win_event_log_stats"
    stats_enabled = true
    enabled = true
    [[inputs.win_eventlog.file]]
        #true | false
        enabled = true
        # Application, Security, Setup, System, ForwardedEvents
        file = "Application"
        #1: Information, 2: Warning 3: Error 4: Audit Success 5 Audit Fail
        #event_type = 
        #event id
        #event_id = 
        #event source name
        #source_name = ""
        #プロジェクトコード及びプロジェクトライセンスの入力時、ログを同じリージョンの希望するプロジェクトに転送可能
        #pcode = プロジェクトコード
        #license = "プロジェクトライセンス"
        #whatap_host_ip = "収集サーバーIP1/収集サーバーIP2"
        #whatap_host_port = 6600

"@

New-Item -path "C:\Program Files\WhatapInfra\extension" -name "win_eventlog.conf" -type "file" -value $contentToAdd -Force

Restart-Service "Whatap Infra"

  • カテゴリ指定(category) 必須

    例）win_event_log

  • 統計カテゴリ指定(stats_category) 必須

    例）win_event_log_stats

  • 統計カテゴリOn/Off(stats_enabled) 必須

    例）trueまたはfalse

  • 収集機能On/Off(enabled) 必須

    例）trueまたはfalse

  • ファイル別収集機能On/Off(enabled) 必須

    例）trueまたはfalse

  • ファイル(file) 必須

    例）Application、Security、Setup、System、Forwarded

  • イベントタイプ(event_type) 非必須

    例）1、2、3、4、5

    ノート

    イベントタイプ

    1. Information

    2. Warning

    3. Error

    4. Audit Success

    5. Audit Fail

  • イベントID(event_id) 非必須

  • イベントソース名(source_name) 非必須

  • プロジェクトコード(pcode)非必須

  • プロジェクトライセンス(license)非必須

ノート

エージェント対応バージョン

  • ウィンドウイベントログ収集の場合、サーバーエージェント2.5.2バージョン以降に対応します。

  • ウィンドウイベントログオプションの中でpcode、licenseオプションの場合、サーバーエージェント2.7.4バージョン以降に対応します。

ログ複数ファイルの指定と分離​

複数のファイル指定​

複数のログファイルを同じカテゴリに設定するには、各ログファイルのパスを[[inputs.logsink.file]]項目に追加して、path設定により、ファイルパスを指定します。 また、category、stats_enabled、stats_categoryなどのオプションを使用して、ログ発生量の統計設定などの付加的な設定が可能です。

/root/test1 および /root/test2 ファイルを同じカテゴリ（serverlog）に指定した例です。

[[inputs.logsink]]
  category = "serverlog"
  stats_enabled = true
  stats_category = "logsink_stats"
  excludeNames = [ ".gz",".zip" ]

[[inputs.logsink.file]]
  path = "/root/test1"
  disabled = false
  encoding = "utf-8"

[[inputs.logsink.file]]
  path = "/root/test2"
  disabled = false
  encoding = "utf-8"
ノート

category、stats_enabled、stats_category、nowrap_keywords などのオプションに関する詳細は、オプション設定 を参照してください。

この例は、ログTail メニューで次のように確認できます。

複数ファイル指定

ファイル分離​

異なるカテゴリにログファイルを割り当てるには、logsink{数字}.conf ファイルをそれぞれ作成し、各ファイルの category 項目に異なる値を設定してください。

logsink.conf と logsink1.conf を使用して、異なるログカテゴリを設定した例です。

logsink.conf
# cat logsink.conf
[[inputs.logsink]]
  category = "serverlog1"
  stats_enabled = true
  stats_category = "logsink_stats"
  excludeNames = [ ".gz",".zip" ]

[[inputs.logsink.file]]
  path = "/root/test1"
  disabled = false
  encoding = "utf-8"
logsink1.conf
#cat logsink1.conf
[[inputs.logsink]]
  category = "serverlog2"
  stats_enabled = true
  stats_category = "logsink_stats"
  excludeNames = [ ".gz",".zip" ]

[[inputs.logsink.file]]
  path = "/root/test2"
  disabled = false
  encoding = "utf-8"
ノート

category、stats_enabled、stats_category、nowrap_keywords などのオプションに関する詳細は、オプション設定 を参照してください。

この例は、ログTail メニューで次のように確認できます。

ファイル分離

最終修正：