ローカル設定ファイル管理
ローカル設定ファイル管理により、UTF-8 でエンコードされた 1 つまたは複数の JSON ファイルを使用して Installed Collector の Source を設定できます。
ローカル設定ファイル管理に切り替えた後は、Sumo Web アプリケーションや Collector 管理 API では Source を管理できなくなりますので注意してください。Sumo Web アプリケーションの [Manage Data (データの管理)] > [Collection (コレクション)] > [Collection (コレクション)] ページで [Add Source (Source の追加)] オプションが無効になります。
ローカル設定ファイル管理の利点
経験豊かなシステム管理者であれば、ローカル設定ファイル管理を使用することで、デプロイ全体で Source をすばやく設定することができます。
- Sumo Web アプリケーションへのログインや API コールは不要になります。その代わりに、JSON 設定ファイルを編集するだけで、Collector によって直ちに変更内容が読み込まれます。
- 大規模なデプロイでは、Source を 1 つずつ追加または編集することは現実的ではありません。ローカル設定管理を使用することで、Source の管理が容易になります。
- デプロイ ツールを使用することで、確立されたデプロイ ポリシーが妨げられません。
ローカル設定ファイルでの Source の指定オプション
ローカル設定ファイル管理は 2 通りの方法で実装できます。
- すべての Source を UTF-8 でエンコードされた 1 つの JSON ファイルで指定する
- UTF-8 でエンコードされた複数の JSON ファイルを使用して Source を指定し、それらのファイルを単一のフォルダに配置する。各 Source の定義をそれぞれのファイルに記述するか、または複数の Source の定義を 1 つのファイルに記述することができます。
各 JSON ファイルには .json
という拡張子を付ける必要があります。例:
source1.json
JSON 設定の例は、「JSON を使用した Source の設定」を参照してください。同トピックには、すべての Source タイプに適用される共通パラメータと、各 Source タイプに特有のパラメータを説明したトピックへのリンクがあります。
設定ファイルは Collector 上に残り、変更がないか常時チェックされます。
JSON ファイルでの 1 つの Source の定義
1 つの Source を定義した JSON ファイルの例です。
{
"api.version":"v1",
"source":{
"sourceType":"LocalFile",
"name":"Example1",
"pathExpression":"/var/logs/maillog",
"blacklist":[
"/var/log/*log1.log"
]
}
}
JSON ファイルでの複数の Source の定義
1 つの JSON ファイルで複数の Source を定義する場合は、各 Source を sources
JSON 配列に定義します。
{
"api.version":"v1",
"sources":[
{
"sourceType":"LocalFile",
"name":"Example1",
"pathExpression":"/var/logs/maillog",
"blacklist":["/var/log/*log1.log"]
},{
"sourceType":"LocalFile",
"name":"Example2",
"pathExpression":"/var/logs/syslog",
"Blacklist":["/var/log/*log1.log"]
}
]
}
新しい Collector と Source の設定方法については、「新規 Collector および Source のローカル設定ファイル管理」を参照してください。
既存の Source をクラウド管理からローカル設定ファイル管理に変換する方法については、「既存の Collector および Source のローカル設定ファイル管理」を参照してください。
JSON ファイルまたはフォルダの場所の設定
ローカルファイル設定管理を使用する場合は、1 つの JSON ファイルまたは複数の JSON ファイルが入ったフォルダの場所を Collector の config/user.properties
ファイルに指定します。設定ファイルまたはフォルダの場所を指定するには、syncSources
パラメータを使用します。利用できるすべてのパラメータの詳細については、user.properties
を参照してください。
- syncSources.Collector の登録時に Source を定義するために使用します。このパラメータで指定した Source 定義は継続してモニタリングされ、Collector の設定と同期されます。
- *nix では、Collector の Source を定義する 1 つの JSON ファイルを指定します。
syncSources=/path/to/sources.json
- *nix では、Collector の Source を定義する複数の JSON ファイルが格納されたフォルダを指定します。
syncSources=/path/to/sources-folder
- Windows では (バックスラッシュのエスケープに注意)、Collector の Source を定義する複数の JSON ファイルが格納されたフォルダを指定します。
syncSources=C:\\path\\to\\sources-folder\\