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

user.properties

Collector バージョン 19.137 以降では、user.properties ファイルにパラメータを設定しておいて、新しい未登録の Collector のインストール中にパラメータ設定を渡すことができます。一度登録された Collector を再起動することでパラメータを変更できるかどうかは、下記の「user.properties のパラメータ」にある表の「インストール後の変更可否」の列で確認してください。シェル スクリプト (コマンド ライン) インストーラを使用する場合は、コマンド ライン引数または変数ファイルでパラメータを渡す必要があり、インストーラがインストール中に user.properties ファイルを作成します (詳細については「コマンド ライン インストーラのパラメータ」を参照してください)

user.properties の作成

Collector のバイナリ パッケージ (tarball など) をダウンロードしたら、特定のディレクトリに user.properties ファイルを作成します。

user.propertiesを手動で作成するには、次の手順を実行します。

  1. テキスト エディタ (または同様のプログラム) を使用して新しいファイルを作成します。
  2. 下記の「user.properties のパラメータ」を参照して、必須のパラメータと省略可能なパラメータを追加します。パラメータは、大文字と小文字が区別されます。
  3. ファイルを CollectorInstallationDirectory/config/user.properties に保存します。

デフォルトの Collector のインストール場所

デフォルトの Collector のインストール場所は次のとおりです。

Linux:
    /opt/SumoCollector/
または
    /usr/local/SumoCollector

Windows:
    C:\Program Files (x86)\Sumo Logic Collector
または
    C:\Program Files\Sumo Logic Collector

user.properties の例

以下の例では、アクセス ID とアクセス キーを設定しています。バイナリ パッケージをインストールする場合は、JRE を実行するコマンドを指定する必要があります。また、JRE が $PATH で指定されているパス上に存在しない場合は、JRE のパスを指定する必要があります。

name = My Collector
accessid = accessId
accesskey = accessKey
wrapper.java.command = java

以下の例では、アクセス ID とアクセス キー、プロキシ、およびカスタム JRE を設定しています。

name = My Collector
accessid = accessId
accesskey = accessKey
proxyHost = 10.0.0.8
proxyPort = 3128
wrapper.java.command = /opt/java_1.7/bin/java
wrapper.java.maxmemory = 2048

user.properties のパラメータ

次の表に、user.properties で設定できるすべてのパラメータの一覧を示します。

パラメータ 説明
wrapper.java.command=JRE Bin Location Collector の起動時に JRE バイナリを設定します。 デフォルトのシステム Java バージョンを使用する場合:

wrapper.java.command=java

特定の JRE インストールを使用する場合 (Linux):

wrapper.java.command=/opt/java_1.7/bin/java

特定の JRE インストールを使用する場合 (Windows):

wrapper.java.command=C:\\Program Files (x86)\\Java\\jre7\\bin

キー/値パラメータ (キー = 値).必要に応じて追加します。

パラメータ 説明 インストール後の変更可否
accessid=accessId アクセス ID とキーでログインする場合に使用するアクセス ID を設定します。    不可
accesskey=accessKey アクセス ID とキーでログインする場合に使用するアクセス キーを設定します。

Collector バージョン v19.182-17 の時点では、インストールが正常に完了した後に accesskey が自動的に user.properties から削除されます。(この動作を無効にするには、下記の skipAccessKeyRemoval プロパティを使用します。)

Collector をエフェメラルに設定して、オフライン状態が 12 時間続くと登録解除されるようにした場合は、accesskeyuser.properties に再度追加する必要があります。
不可
category=category

Collector バージョン 19.182 以降で使用できます。
Source でカテゴリが指定されていない場合に使用する Source Category。 不可。変更するには Collector 管理 API を使用します。
clobber=true/false true に設定すると、同じ名前の Collector がすでに存在する場合は、既存の Collector が削除されます。詳細については「Collector 名の強制的な適用」を参照してくだい。 不可。変更するには Collector 管理 API を使用します。
description=description

Collector バージョン 19.182 以降で使用できます。
Sumo Logic に表示する Collector の説明。 不可。変更するには Collector 管理 API を使用します。
disableActionSource=true/false

Collector バージョン 19.245-4 で非推奨となっています。代わりに enableActionSource を使用してください。
組織の内部ポリシーによってスクリプト アクションの使用が制限されている場合は、このパラメータを true に設定して、スクリプト アクションを無効にしてください。 可。Collector の再起動によって変更されます。
disableScriptSource=true/false

Collector バージョン 19.245-4 で非推奨となっています。代わりに enableScriptSource を使用してください。
組織の内部ポリシーによってスクリプト Source の使用が制限されている場合は、このパラメータを true に設定して、スクリプト Source を無効にしてください。 可。Collector の再起動によって変更されます。
disableUpgrade=true/false true に設定すると、Collector は Sumo からのアップグレード リクエストを拒否します。 可。Collector の再起動によって変更されます。
enableActionSource=true/false

Collector バージョン 19.245-4+ 以降で使用できます。
デフォルトでは、スクリプト アクション Source は無効になっています。有効にするには、このパラメータを true に設定します。 可。Collector の再起動によって変更されます。
enableScriptSource=true/false

Collector バージョン 19.245-4+ 以降で使用できます。
デフォルトでは、スクリプト Source は無効になっています。有効にするには、このパラメータを true に設定します。 可。Collector の再起動によって変更されます。
ephemeral=true/false true に設定すると、操作が何も行われない状態が 12 時間続いた時点で Collector が削除されます。詳細については、「エフェメラルとしての Collector の設定」を参照してください。

操作が何も行われない状態が 12 時間続いた時点で Collector が登録解除された後は、user.properties を編集して accesskey プロパティを追加する必要があります。上述のように、Collector が Sumo に正常に登録された時点で (下記の skipAccessKeyRemoval プロパティでこの動作が無効に設定されていない限り)、Sumo は accesskey 行の accesskeyuser.properties から削除します。
不可。変更するには Collector 管理 API を使用します。
fields=[list of fields] Collector に適用するキーと値のフィールド (メタデータ) のコンマ区切りリスト。

Collector に Ingest Budget を割り当てるには、フィールド _budget を使用して、割り当てる Ingest Budget の値を指定します。たとえば、予算のフィールド値が Dev_20GB である場合は、次を追加します。

fields=_budget=Dev_20GB
不可。変更するには Collector 管理 API を使用します。
fipsJce=true/false


Collector バージョン 19.253-3 以降で使用できます。
FIPS 140-2 準拠の Java Cryptography Extension (JCE) が有効の場合に通知されます。

このオプションは、特定のデプロイでのみサポートされます。詳細については、Sumo アカウント担当者にお問い合わせください。
不可。新規インストールが必要です。
hostName=hostname

Collector バージョン 19.182 以降で使用できます。
Collector が動作しているマシンのホスト名。ホスト名は最大 128 文字です。 不可。変更するには Collector 管理 API を使用します。
name=name Sumo Logic で使用する Collector の名前を設定します。名前は最大 128 文字です。

新たにインストールする Collector の名前が既存の Collector の名前と重複するような場合には、自動的に 13 桁の UNIX タイムスタンプが Collector 名に付加されます。
不可。変更するには Collector を編集するか、または Collector 管理 API を使用します。
proxyHost=host プロキシ サーバを使用する場合にプロキシ ホストを設定します。 可。Collector の再起動によって変更されます。
proxyNtlmDomain=NTLM domain プロキシ サーバで NTLM 認証を使用する場合に NTLM ドメインを設定します。     可。Collector の再起動によって変更されます。
proxyPassword=password プロキシ サーバで認証を使用する場合にプロキシ パスワードを設定します。     可。Collector の再起動によって変更されます。
proxyPort=port プロキシ サーバを使用する場合にプロキシ ポートを設定します。 可。Collector の再起動によって変更されます。
proxyUser=username プロキシ サーバで認証を使用する場合にプロキシ ユーザを設定します。 可。Collector の再起動によって変更されます。
skipAccessKeyRemoval=true/false true に設定すると、user.properties ファイルからのアクセス キーの削除をスキップします。 不可
sources=filepath or folderpath Collector の登録時に設定する Source を記述した、UTF-8 でエンコードされた単一の JSON ファイルか、複数の JSON ファイル (UTF-8 形式) が格納されたフォルダを指定します。ファイル (1 つまたは複数) の内容は、Collector の登録時にのみ読み取られ、以降の Collector 設定の変更とは同期しません。

ファイル名には .json という拡張子が必要です。

Windows では、パス値を \\ で囲む必要があります。例:

sources=c:\\sumo\\sources.json
不可
syncSources=filepath or folderpath Collector の登録時に設定する Source を記述した、UTF-8 でエンコードされた 1 つの JSON ファイルか、複数の JSON ファイル (UTF-8 形式) が格納されたフォルダを指定します。このパラメータで指定した Source 定義は継続してモニタリングされ、Collector の設定と同期されます。

Windows では、パス値を \\ で囲む必要があります。

ファイル名には .json という拡張子が必要です。

詳細については、「ローカル設定ファイル管理」を参照してください。
可。Collector の再起動によって変更されます。
targetCPU=target

Collector バージョン 19.182 以降で使用できます。
CPU ターゲットを設定することで、Collector が使用できる CPU リソースの量を制限できます。値は、整数のパーセント値で指定します。例:

targetCPU=20

Collector は、使用する最大 CPU リソースの量を 20% に制限します。詳細については、 「Collector が使用する CPU ターゲットの設定」を参照してください。
不可。変更するには Collector 管理 API を使用します。
timeZone=timezone 

Collector バージョン 19.182 以降で使用できます。
タイム ゾーンがログ スタンプから抽出されない場合に使用するタイム ゾーン。例:

timeZone=America/Los_Angeles

指定できる値については、この Wikipedia 記事の「TZ」の列を参照してください。
不可。変更するには Collector 管理 API を使用します。
token=token セットアップ ウィザード トークンを設定します。このトークンは、1 回限りのトークンで、生成後 1 時間は有効ですが、その後は期限切れになります。このトークンでユーザを認証します。1 つの Collector のみに使用できます。API では使用できず、無効化はできません。

これはエンコードされたトークン + URL ではありません。デコードされたトークンのみです。
不可
url=collection endpoint Collector を登録するために使用される収集エンドポイント URL を設定します。たとえば、アカウントが US2 デプロイにある場合は、次のようになります。

url=https://collectors.us2.sumologic.com
可。Collector の再起動によって変更されます。


(省略可能) JVM またはラッパー設定パラメータ

JVM またはラッパー設定パラメータを設定するには、バージョン 19.137 以前の Collector では、Collector の config フォルダにある wrapper.conf ファイルに次の行を追加する必要があります。 #include ./config/user.properties

パラメータ 説明 インストール後の変更可否
wrapper.java.command=JRE Bin Location Collector の起動時に JRE バイナリを設定します。

例:

デフォルトのシステム Java バージョンを使用する場合:

wrapper.java.command=java

特定の JRE インストールを使用する場合 (Linux):

wrapper.java.command=/opt/java_1.7/bin/java

特定の JRE インストールを使用する場合 (Windows):

wrapper.java.command=C:\\Program Files (x86)\\Java\\jre7\\bin
可。Collector の再起動によって変更されます。
wrapper.java.initmemory=size 初期 Java ヒープ サイズを MB 単位で設定します。

デフォルト: 64
可。Collector の再起動によって変更されます。
wrapper.java.maxmemory=size 最大 Java ヒープ サイズを MB 単位で設定します。

デフォルト: 128
可。Collector の再起動によって変更されます。

 

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