Link Agent設定ファイル

Link Agent設定ファイルの使用方法

Link Agentを設定するには、コマンドラインでオプションを渡す方法に加え、設定ファイルを使用することもできます。起動時に設定ファイルを読み込ませるには、次のコマンドライン引数のいずれかを使用します。

--config /path/to/config.json
# Or:
-c /path/to/config.json

設定ファイルの形式はJSONになっており、Link Agentディストリビューションのルートにあるconfig.example.jsonファイルを設定ファイルのサンプルとして参考にしていただけます。一般的に使用される設定オプションの例を以下に示します。

{
  "disableAutoUpdates": false,
  "httpProxy": {
    "host": "host",
    "port": 1234
  },
  "proxyAuth": {
    "password": "password",
    "username": "username"
  },
  "proxyExclusions": [
    "localhost",
    "127.0.0.1"
  ],
  "proxyMode": "all",
  "tunnels": [
    {
      "apiKey": "apiKey1",
      "name": "name1"
    },
    {
      "apiKey": "apiKey2",
      "name": "name2"
    }
  ]
}

Link Agentが複数のトンネルを管理するための設定

1つの設定ファイルで複数のトンネルを定義することが可能です。その場合、同じLink Agentインスタンスが、設定ファイルに指定されたすべてのトンネルを確立します。同じLink Agentに複数のトンネルを統合することで、管理するエージェントインスタンスの数を減らすことができ、特に小規模のトンネルが複数ある場合に便利です。複数のトンネルを同じLink Agentに統合する場合の注意事項については、以下の注記を参照してください。

🚧
複数のトンネルを統合するとパフォーマンスと安定性に影響を与えることがあります
同じLink Agentインスタンスに複数のトンネルを統合する場合には、注意が必要です。同じLink Agentで処理されるトラフィックが増えると、メモリやCPUの要件が上昇する可能性があります。同じLink Agentインスタンスに複数のトンネルを統合する前に、まずLink Agentが動作しているホストの現在のリソース使用量を把握しておくことをお勧めします。トンネルは一度に1つずつ追加します。各トンネルを追加した後で、エージェントログファイルでエラーを監視し、ホストのメモリやCPUの使用率が以前に比べてどのように変化したかを観察します。正確な測定を行うには、管理対象のすべてのトンネルでテストがアクティブになっているときにホストを監視することが重要です。リソース使用率の平均値とピーク値を観察し、必要に応じてホストのメモリとCPUリソースを増やします。また、JVMが利用できるメモリを増やすことが必要な場合もあります。

プロキシ自動設定 (PAC) を使用する場合のLink Agentの設定

プロキシ設定にPACファイル/スクリプトを使用している場合は、PACを使用するようにLink Agentを設定できます。この設定を行うためのJSONおよびYAML形式の構成用スニペットの例を以下に示します。

{
 "proxyAutoConfiguration": {
   "auth": {
     "proxy1.example.com:8080": {
       "username": "my-user-1",
       "password": "password-1"
     },
     "proxy2.example.com:8080": {
       "username": "my-user-2",
       "password": "password-2"
     }
   },
   "reloadPeriodMinutes": 5,
   "url": "http://proxy.example.com/pac.js"
 },
}

proxyAutoConfiguration:
 auth:
   proxy1.example.com:8080:
     username: my-user-1
     password: my-password-1
   proxy2.example.com:8080:
     username: my-user-2
     password: my-password-2
   reloadPeriodMinutes: 5
   url: http://proxy.example.com/pac.js

PAC用に必要な設定はURLのみです。通常、これはhttp://で始まるURLです。ローカルファイルシステム上のファイルからPACスクリプトを読み込む場合は、file://で始まるURLを使用できます (例: file:///opt/mabl/link-agent/pac.js)。

認証が必要なプロキシサーバーがある場合は、認証が必要なプロキシごとにauthエントリを追加する必要があります。各認証情報設定に対するプロキシは、ホスト名とポートの両方を含む形式で、PACスクリプトで返されるとおりに指定する必要があります (例: proxy.example.com:8080)。

オプションのreloadPeriodMinutesの設定では、Link AgentがPACを再読み込みする頻度を指定します。Link Agentでは、接続待機時間を最小限に抑えるため、接続のたびにPACを再読み込みするのではなく、バックグラウンドで定期的にPACの再読み込みを行います。ほとんどの場合、PACが頻繁に変更されることはないため、数分ごとに再読み込みを行えば十分です。デフォルト設定では、1分に1回の頻度でPACの再読み込みが行われます。

🚧
静的プロキシとPACの設定は共存不可
設定ファイルにPACの設定を追加する場合は、静的プロキシの設定が存在しないことを確認する必要があります。proxyAutoConfigurationを追加する前に、必ずhttpProxy、proxyAuth、proxyExclusionsの設定を削除しておく必要があります。

📘
PACの設定時にはプロキシモードは無視される
PACを使用するようにLink Agentを設定すると、proxyModeの設定は無視されます。これは、PACスクリプトでプロキシを使用するURLと直接接続を行うURLが決まるためです。

Updated almost 2 years ago

Link Agent設定ファイル