Server
サーバーアプリケーションでログを収集するための設定方法を案内します。
エージェントのアップデート
サーバーエージェントのバージョン2.1.2以降で利用可能です。アップデート方法は 次の文書 を参照してください。
エージェント設定の確認
**ホーム画面 > プロジェクト選択 > ログ > **ログ設定**
-
WhaTapモニタリングサービスの初期画面でプロジェクトを選択した後、ログ > ログ設定 メニューに移動してください。
-
ログモニタリングを始めるの1. エージェント設定の確認にあるOS選択タブで、**Linux(shell)またはWindows(PowerShell、管理者権限)**を選択してください。
-
基本インストールまたはカテゴリ付きインストールを参考にして、エージェント設定を確認してください。
次の設定は、エージェントを再起動する必要があります。
Linux Shell
-
基本インストール
Linux Shellexport LOGFILES=/some/path/file1,/some/other/file2
echo "logsink.files=$LOGFILES" | sudo tee -a /usr/whatap/infra/conf/whatap.conf -
カテゴリ付きインストール
Linux Shellcd /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
)にアスタリスク(*
)が含まれている場合、ログ収集対象外のファイル名を設定して除外することができます。 カンマ(,
)を区切り文字として使用することで、複数の値を設定できます。ExampleexcludeNames = [ ".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, Forwarded
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
ノートイベントタイプ
-
Information
-
Warning
-
Error
-
Audit Success
-
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 を使用して、異なるログカテゴリを設定した例です。
# 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"
#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 メニューで次のように確認できます。
ログモニタリングの活性化
ホーム画面 > プロジェクト選択 > ログ > ログ設定
ログモニタリングを開始するセクションのログモニタリングを有効にするタブのトグルボタンで、WhaTapログモニタリングの有効または無効にできます。
ログモニタリングの有効化:トグルボタンをオンにするとログモニタリングが有効になり、有効化した日から15日間は無料でお試しいただけます。
ログモニタリングの無効化:トグルボタンをオフにするとログモニタリングが無効になり、以降ログは保存されません。
ログモニタリングの有効化権限
エージェントをインストールした後、プロジェクトに対して編集権限を持つユーザーのみがログモニタリングを有効化できます。 権限の詳細については、次のドキュメントを参照してください。