メインコンテンツまでスキップ
Sumo Logic Japanese

コマンド ライン インストーラのパラメータ

次の表に、コマンド ライン インストーラを使用して Collector をインストールする際に使用できるパラメータの一覧を示します。Collector のインストールの詳細と例については、「Linux への Collector のインストール」「MacOS への Collector のインストール」、および「Windows への Collector のインストール」をそれぞれ参照してください。

固有のパラメータ

次の表に、コマンド ライン インストーラに固有のパラメータを示します。

パラメータ 説明
-console -q と併用する場合にのみ効果があります。インストーラの進捗状況を示すメッセージを (インストーラを GUI またはコマンド ライン モードのどちらで実行している場合でも) コンソールに表示します。

Windows の場合、このオプションを有効にするにはインストーラを start /wait を使用して実行する必要があります。例:

start /wait installer.exe -q -console
-dir [directory] デフォルト以外のインストール ディレクトリを指定します。
-q インストーラをクワイエット モードで実行し、インストール パラメータの入力を促すメッセージを表示しません。コマンド ラインで指定しなかったインストール パラメータについては、デフォルト値が使用されます。-console パラメータを一緒に指定しないと、コンソールには何も出力されません。  新規に Collector をインストールする場合は、クワイエット モードを指定した場合でも承認トークン (またはアクセス ID/アクセス キー) の入力が求められます。
-varfile [fileName] コマンド ラインで引数を渡す代わりに、引数が登録されたファイルを (-V フラグを指定せずに) 指定することができます。  多くのオペレーティング システムでは、他のユーザが所有するプロセスに関する情報をリストで指定できるため、-varfile オプションを使用して Sumo Logic の資格情報を指定することをお勧めします。

例: Collector のインストール時に資格情報を渡すには、sumo_credentials.txt というファイルを次の内容で作成します。

sumo.accessid=<access id>
sumo.accesskey=<access key>
proxy.host=<proxy host>
proxy.port=<proxy port>


そして、このファイルを次のコマンド ラインで渡します。

sudo ./SumoCollector.sh -q -varfile /path/to/sumo_credentials.txt


 -q-dir のパラメータはコマンド ラインで渡す必要があります (変数ファイルでは指定できません)。
-Vcollector.secureFiles=[true|false] デフォルトでは、新しい Collector のインストールには、ファイル システム セキュリティ強化機能を使用します。インストール時にこの機能を無効にするには、次のコマンド ライン引数を指定します。
-Vcollector.secureFiles=false
-VrunAs.username=[username] 設定すると、Collector は指定されたユーザとして実行されます (Windows と Linux の場合)。

Windows では、
ユーザ アカウントが Log on as a Service 権限を持っている必要があります。
-VwinRunAs.password=[password] (Windows のみ) -VrunAs.username と一緒に設定すると、Collector は指定されたユーザとして指定されたパスワードで実行されます。

多くのオペレーティング システムでは、他のユーザが所有するプロセスに関する情報をリストで指定できます。この情報には、コマンド ライン引数が含まれる場合もあります。セキュリティを強化するため、-varfile オプションを使用して Windows の実行ユーザ パスワードを指定することをお勧めします。

認証パラメータ

次の表に、Collector の認証に関連するパラメータを示します。

パラメータ 説明
-VskipRegistration=[boolean] true と指定すると、インストーラは登録をスキップします。

通常、Collector はインストール プロセス中に Sumo Logic に登録されますが、‑VskipRegistration=true フラグを指定することで登録をスキップできます。この場合、Collector はサービスとしてインストールされ、インスタンスの起動時に自動的に起動して登録されるようになります。
-Vsumo.accessid=[accessId]
-Vsumo.accesskey=[accessKey]
このオプションまたはトークン オプションのいずれかの認証オプション (この表の次の項目を参照) は必須です。Sumo Logic のアクセス ID とアクセス キーを持っている場合は、両方とも指定してください。(-Vsumo.accessid および -Vsumo.accesskey)。システム管理者は、Web アプリケーションの [Preferences (環境設定)] ページでアクセス ID/アクセス キーのペアを生成できます。「アクセス キー」を参照してください。

多くのオペレーティング システムでは、他のユーザが所有するプロセスに関する情報をリストで指定できます。この情報には、コマンド ライン引数が含まれる場合もあります。セキュリティを強化するため、-varfile オプションを使用して Sumo Logic の資格情報を指定することをお勧めします。
-Vsumo.token_and_url=[token] このオプションまたはアクセス ID/アクセス キー オプションのいずれかの認証オプション (この表の上の項目を参照) は必須です。

Sumo Logic からインストールのためのワンタイム トークンが発行されている場合は、このパラメータで指定してください。

user.properties のパラメータ

コマンド ライン インストーラでは、user.properties ファイルで設定可能なすべてのパラメータを使用できます。user.properties のパラメータを使用するには、パラメータの先頭に -V を追加します。スペース文字は不要です。たとえば、sources パラメータを使用するには、-Vsources のように指定します。

参考までに、設定可能な user.properties のパラメータを確認してください。

形式が異なるパラメータ

user.properties のパラメータの中には、コマンド ライン インストーラで使用するときに特定のフォーマット設定が必要なものがいくつかあります。

user.properties のパラメータの形式 コマンド ライン インストーラの形式
name -Vcollector.name
url -Vcollector.url
proxyHost -Vproxy.host
proxyPort -Vproxy.port
proxyUser -Vproxy.user
proxyPassword -Vproxy.password
proxyNtlmDomain -Vproxy.ntlmdomain

collector.properties のパラメータ

コマンド ライン インストーラでは、collector.properties ファイルで設定可能なすべてのパラメータを使用できます。collector.properties のパラメータを使用するには、パラメータの先頭に -V を追加します。スペース文字は不要です。たとえば、source.max.threads.num パラメータを使用するには、-Vsource.max.threads.num のように指定します。

パラメータ タイプ 説明 デフォルト値
-Valerts.ttl.min 整数 Collector ディレクトリに保存されているアラートが削除されるまでの期間 (分)。 180
-Vaws.metadata.cache.enabled ブール AWS 固有のローカル メタデータの取得およびキャッシュを有効にします。 true
-Vaws.metadata.cache.fetch.timeout.ms 整数 AWS 固有のローカル メタデータの取得を試みるときの HTTP 接続タイムアウト (ミリ秒)。 1000
-Vaws.metadata.cache.url 文字列 キャッシュに入れるローカル メタデータを取得するための AWS 固有の URL。 http://169.254.169.254/latest/dynamic/instance-identity/document
-Vcollector.backoff.max.timeInMillis 整数 Windows イベント ログ Source の最大バックオフ期間 (ミリ秒)。 60000
-Vcollector.backoff.min.timeInMillis 整数 Windows イベント ログ Source の初期バックオフ期間 (ミリ秒)。 5000
-Vcollector.connection.fixCount 整数 Sumo Logic にデータを送信するときに確立する既定の接続数を指定します。collector.connection.max 以下にする必要があります。 -1
-Vcollector.connection.max 整数 Sumo Logic にデータを送信するときに確立する最大接続数。 3
-Vcollector.localfile.inputType 文字列 ローカル ファイル読み取りメカニズムのタイプを上書きします。指定できる上書き値には、「nonblocking」と「simple」があります。 NULL
-Vcollector.localFile.oldFileMaxEps 整数 古いファイルを監視する際、スリープ時間の長さを決定するために使用される 1 秒あたりのイベント数。 500
-Vcollector.localFile.oldThresholdMillis 整数 この期間 (ミリ秒) を過ぎると、監視対象ファイルが「古い」作業セットに移動されます。 900000
-Vcollector.metrics.dumper.millis 整数 Collector のメトリクスと使用情報を collector-usage.log に記録する期間 (ミリ秒)。 600000
-Vcollector.pipeline.maxMessageCount 整数 蓄積するメッセージ数。この数を超えると、ログ アウトバウンド キューがフラッシュされます。 1000
-Vcollector.pipeline.maxMessagesSize 整数 蓄積するサイズ (バイト)。このサイズを超えると、ログ アウトバウンド キューがフラッシュされます。 1048576
-Vcollector.pipeline.metrics.maxMessageCount 整数 蓄積するメッセージ数。この数を超えると、メトリクス アウトバウンド キューがフラッシュされます。 1000
-Vcollector.pipeline.metrics.maxMessagesSize 整数 蓄積するサイズ (バイト)。このサイズを超えると、メトリクス アウトバウンド キューがフラッシュされます。 1048576
-Vcollector.pipeline.metrics.windowSizeMillis 整数 メトリクス アウトバウンド キューをフラッシュする期間 (ミリ秒)。 200
-Vcollector.pipeline.windowSizeMillis 整数 ログ アウトバウンド キューをフラッシュする期間 (ミリ秒)。 1000
-Vcollector.registration.delay.ms 整数 Collector 登録の遅延 (ミリ秒)。 0
-Vcollector.syslog.udp.readBufferSize 整数 Syslog Source を使用して UDP 経由で受信したペイロードをバッファリングする最大サイズ (バイト)。 2048
-Vcollector.wildcard.fpSize 整数 新しいファイル 循環を決定するときに使用する指紋のサイズ (バイト)。 2048
-Vcollector.wildcard.pathMatcher 文字列 ファイル パスを評価するときに使用するパス式マッチャー。 RegexPathExpressionMatcher
-Vcollector.winlog.dcom.connectionTimeout 整数 Windows イベント ログ Source の WMI 接続タイムアウト (ミリ秒)。 60000
-Vcollector.winlog.dcom.notificationSessionTimeout 整数 Windows イベント ログ Source の WMI 通知セッション タイムアウト (ミリ秒)。 1800000
-Vcollector.winlog.dcom.querySessionTimeout 整数 Windows イベント ログ Source の WMI クエリ セッション タイムアウト (ミリ秒)。 30000
-Vcollector.winlog.initial.sleep.ms 整数 このスリープ期間 (ミリ秒) を過ぎると、キャッチアップと最初の通知の間で欠落したイベントがないかチェックされます。 10000
-Vcollector.winlog.maxThreads 整数 Windows イベントの処理時に使用するスレッドの最大数。 16
-Vcollector.winlog.queryBatchSize 整数 Windows イベント ログ Source のキャッチアップ時に取得する要素の数。 20000
-Vcollector.winlog.queryDoCatchup ブール Windows イベント ログ Source のキャッチアップ クエリの実行を有効にします。 true
-Vcollector.winlog.queryLongWaitTime 整数 Windows イベント ログ Source で実行された長いクエリのスリープ期間 (ミリ秒)。 3000
-Vcollector.winlog.queryShortWaitTime 整数 Windows イベント ログ Source で実行された短いクエリのスリープ期間 (ミリ秒)。 250
-Vcollector.winlog.retryConnection 整数 この待機期間 (ミリ秒) を過ぎると、失敗した接続が Windows イベント ログ Source で再試行されます。 15000
-Vcommand.fetch.maxRetry 整数 Sumo Logic からリモート コマンドの取得を再試行する最大回数。この回数を過ぎると、コマンド チャネルが閉じます。 15
-Vcommand.fetch.retryInterval 整数 Sumo Logic からリモート コマンドの取得を再試行する期間 (ミリ秒)。 5000
-Vdocker.apiVersion 文字列 Docker コンテナ Source から収集を行うときに使用する Docker API バージョンを上書きします。 NULL
-Vdocker.blockProblematicContainerInMs 整数 エラーが発生している Docker コンテナ Source の再試行をブロックする最大時間 (ミリ秒)。 900000
-Vdocker.maxContainerErrorPerMinute 整数 Docker コンテナ Source あたりの最大エラー再試行回数。 20
-Vdocker.maxPerContainerConnections 整数 監視する Docker コンテナ接続の Source あたりの最大数。 40
-Vforwarding.hcp.dateStamperFormat 文字列 REST シンク Source へのデータ転送時に使用するタイムスタンプ形式。 yyyy-MM-dd
-Vforwarding.http.iso8859 ブール REST シンク Source への ISO-8859 エンティティの転送を有効にします。 false
-Vforwarding.syslog.maxMessageSize 整数 転送する syslog メッセージのセグメント サイズ (バイト) を設定します。 1024
-VfreeSpace.threshold.percent 整数 空きディスク スペースのしきい値 (%)。このしきい値を超えると、Collector はフラッシュ モードになります。 10
-Vgraphite.hostname 文字列 レガシー Graphite Source の syslog サーバのホスト名を上書きします。 NULL
-Vhttp.connectionTimeout 整数 Sumo Logic へのデータ送信を試みるときの HTTP 接続タイムアウト (ミリ秒)。 60000
-Vhttp.socketTimeout 整数 Sumo Logic へのデータ送信を試みるときの HTTP ソケット タイムアウト (ミリ秒)。 60000
-Vhttp.transmitter.retry.sleep.ms 整数 接続失敗時に送信を再試行するまでのスリープ期間 (ミリ秒)。 5000
-VhttpAppender.disable ブール Collector ログ用の診断 HTTP アペンダを無効にします。 false
-Vjson.sync.sleep.time 整数 Source JSON 同期ファイルの変更をチェックする期間 (ミリ秒)。 1000
-Vjson.sync.waiting.after.fail 整数 JSON Source 同期ファイルへの同期が失敗した場合、この待機期間 (ミリ秒) が経過すると、同期が再試行されます。 600000
-Vlocal.win.event.collection.flag 文字列 ローカル Windows イベント収集のタイプを上書きします。指定できる上書き値には、レガシー モードの「0」があります。 NULL
-Vlocal.win.event.collection.legacy 文字列 ローカル Windows イベント収集のタイプを上書きします。指定できる上書き値には、レガシー モードの「1」があります。 NULL
-VlocalWindowsEventLog.batchSize 整数 Windows イベント ログ Source のバッチあたりに取得する要素の数。 512
-VlocalWindowsEventLog.sleepIntervalMs 整数 Windows イベント ログ Source の取得イベント間で待機するスリープ時間 (ミリ秒)。 0
-VLogSender.pause.override ブール ログ送信側から Sumo Logic への HTTP データ送信を一時停止します。 false
-Vmetadata.cache.expiration.sec 整数 Collector によってキャッシュに格納されたローカル メタデータが期限切れになった後、その取得を再試行する期間 (秒)。 600
-VMetricsSender.pause.override ブール メトリクス送信側から Sumo Logic への HTTP データ送信を一時停止します。 false
-Voffline.numRetries 整数 接続が失敗した場合、この回数だけ再試行を繰り返すと、オフライン収集モードになります。 3
-Vpaging.lowerbound.mb 整数 使用可能な空きストレージ スペースがこのサイズ (メガバイト) になると、Collector はフラッシュ モードを終了します。 32
-Vpaging.upperbound.mb 整数 使用可能な空きストレージ スペースがこのサイズ (メガバイト) になると、Collector はフラッシュ モードを開始します。 2048
-VpileAggregator.maxBatchPayloadSize 整数 ログ パイプラインの集計済みパイルを蓄積してフラッシュする最大サイズ (バイト)。 4194304
-VpileAggregator.maxPiles 整数 集計するパイルの最大数。この数を超えると、ログ パイプラインのパイルがフラッシュされます。 5
-VpileAggregator.metrics.maxBatchPayloadSize 整数 メトリクス パイプラインの集計済みパイルを蓄積してフラッシュする最大サイズ (バイト)。 1048576
-VpileAggregator.metrics.maxPiles 整数 集計するパイルの最大数。この数を超えると、メトリクス パイプラインのパイルがフラッシュされます。 10
-VpileAggregator.metrics.period 整数 メトリクス パイプラインの集計済みパイルをフラッシュする期間 (ミリ秒)。 1000
-VpileAggregator.period 整数 ログ パイプラインの集計済みパイルをフラッシュする期間 (ミリ秒)。 1000
-Vqueue.checking.interval.sec 整数 Collector がアウトバウンド キュー統計を計算する期間 (秒)。 300
-Vqueue.max.disk.gb 整数 ログ Source のディスク上のアウトバウンド キューのサイズ (ギガバイト)。 3
-Vqueue.max.memory.mb 整数 ログ Source のインメモリ アウトバウンド キューのサイズ (メガバイト)。 8
-Vqueue.metrics.max.disk.gb 整数 メトリクス Source のディスク上のアウトバウンド キューのサイズ (ギガバイト)。 1
-Vqueue.metrics.max.memory.mb 整数 メトリクス Source のインメモリ アウトバウンド キューのサイズ (メガバイト)。 8
-Vrefresh.event.session.period 整数 Windows イベント ログ Source のイベント セッションを更新する期間 (ミリ秒)。 3600000
-Vrefresh.local.log.names.period 整数 Windows イベント ログ Source の新規のイベント ログのログ名を取得する期間 (ミリ秒)。 86400000
-Vremote.file.connect.retries 整数 リモート ファイル ホストに接続するときの再試行回数。 3
-Vsource.max.threads.num 整数 特定の Source のファイルをスキャンするときに使用するスレッドの最大数。 6
-Vsource.scan.file.cacheTtl 整数 ディレクトリ階層にデータを再設定するまでの最大期間 (ミリ秒)。 1800000
-Vssh.host.verify.file 文字列 リモート ホストの検証時に使用する SSH ホスト キー検証ファイルのファイル パス。 NULL
-Vstreaming.metrics.hostname 文字列 ストリーミング メトリクス Source タイプの syslog サーバのホスト名を上書きします。 NULL
-Vsyslog.dns.cache.timeout 整数 Syslog Source の DNS ホスト ルックアップ情報を解決する際のタイムアウト (ミリ秒)。 300000
-Vsyslog.hostname 文字列 Syslog Source がバインドする必要のあるネットワーク インターフェイスを示すホスト名。 NULL
-Vtcp.syslog.server.socket.timeout.ms 整数 Syslog Source で使用されるソケット タイムアウトの期間 (ミリ秒)。0 に設定すると、タイムアウトが無効になります。 120000
-VthreadDumps.enabled ブール スレッド ダンプを collector.log ファイルに定期的に出力する操作を有効にします。 false
-VthreadDumps.frequencyMs 整数 スレッド ダンプが有効であるときに、スレッド ダンプを記録する期間 (ミリ秒)。 60000
-Vupgrade.auto.enabled ブール Collector の自動アップグレード チェックを有効にします。 false
-Vupgrade.check.frequency 整数 自動アップグレードが有効であるときに、アップグレードをチェックする期間 (秒)。 3600
-Vwaiting.time.before.stop.thread 整数 この待機期間 (ミリ秒) を過ぎると、Source JSON 同期ファイルの監視が停止します。 15000
-Vwildcard.inputs.handler.removed.input.timeout 整数 この待機期間 (ミリ秒) を過ぎると、未変更ファイルの監視が停止します。 1800000
-Vwindows.local.jni ブール ローカル Windows イベント ログ Source に対する JNI の使用を有効にします。 true
-Vwrapper.out.oom 文字列 ラッパーから OutOfMemory 例外が出されたときにログに記録するカスタム メッセージ。 The JVM has run out of memory. (JVM がメモリ不足です。)
-Vwrapper.out.stop 文字列 ラッパーが停止したときにログに記録するカスタム メッセージ。 Wrapper Stopped (ラッパーが停止しました)

参考までに、設定可能な collector.properties のパラメータを確認してください。

  • この記事は役に立ちましたか?