Instana ホストエージェントの設定

Instana SaaS, では、エージェントのバックエンド接続用の TLS 証明書は Instana によって提供されます。 自社でホストする Instana バックエンドの場合、バックエンド接続用の TLS 証明書はお客様ご自身で用意することができます。 詳細については、「セルフホスト型 Standard Edition で既存の証明書を使用する」 を参照してください。

セルフホスト型の Instana バックエンドの場合、 Instana エージェントを設定して、バックエンドの TLS 証明書のフィンガープリントを確認させることができます。 ファイル *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.Backend.cfg 内で、プロパティ fingerprints に証明書のフィンガープリントをカンマ区切りでリストとして指定してください。 エージェントは、指定されたフィンガープリントと一致しないバックエンドへの接続を拒否します。

構成の例は、次のようになります。

fingerprints=29:17:5A:F4:2E:35:DF:87:D6:1F:4D:C8:A8:01:D2:43:18:47:BF:6E
 

場合によっては、複数のバックエンドに報告するためにエージェントが必要になることがあります。 例えば、共有サービスが分離された環境で使用されている場合、これらの分離された環境で複数のバックエンドにレポートするようにエージェントを手動で構成できます。

エージェントは、使用するライセンスの数とセットアップによってエージェントの帯域幅使用量が効果的に乗算されるため、すべてのバックエンドで別個にカウントされます。

複数のバックエンドにレポートするようにホスト・エージェントを構成するには、以下の手順を実行します。

1. *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.Backend.cfg 構成ファイルの名前を *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.Backend-1.cfg に変更します。
2. エージェントが報告する各種バックエンドに適した構成を使用して、 *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.Backend-2.cfg 構成ファイルのコピーを作成します。

前の手順で作成された各ファイルは、異なるホストエージェントのエンドポイントやエージェントキー を記述するように調整することができます。 これらのファイルには、異なるプロキシー設定を含めることもできます。

注:

• 構成ファイルでは、任意の数値または英数字の ID を使用できます。 例: *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.Backend-<alphanumeric>.cfg

• *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.Backend.cfg 構成ファイルが存在する場合、他のすべてのバックエンド・ファイルは無視されます。

• Instana のホストエージェント用 Docker イメージは特別に構成されており、. com.instana.agent.main.sender.Backend-2.cfgなどのバックエンドファイルをマウントするだけで、バックエンドを簡単に追加できるようになっています。

  dockerize したエージェントの引数の例を以下に示します。

  --volume <path-to-additional-backend-config>:/opt/instana/agent/etc/instana/com.instana.agent.main.sender.Backend-2.cfg

機密性の高いプロキシ認証情報を非公開にするには、環境変数を使用してプロキシ設定を紐付けることができます。

環境変数を使用してバックエンドプロキシのプロパティを設定するには、 <instana-agent-dir>/etc/instana/com.instana.agent.main.sender.Backend.cfg 以下の例を参照してください。 ユーザー名とパスワードを環境変数 `username BACKEND_PROXY_USER ` および `password` としてエージェント BACKEND_PROXY_PASSWORDに設定する必要があります。

proxy.user=${env:BACKEND_PROXY_USER}
proxy.password=${env:BACKEND_PROXY_PASSWORD}

環境変数を使用して Maven リポジトリのプロキシを設定するには、以下の例を mvn-settings.xml ファイルに適用してください。 ユーザー名とパスワードを環境変数 `username MAVEN_PROXY_USER ` および `password` としてエージェント MAVEN_PROXY_PASSWORDに設定する必要があります。

<proxies>
  <proxy>
    <id>agent-proxy</id>
    <active>true</active>
    <protocol>http</protocol>
    <username>${env.MAVEN_PROXY_USER}</username>
    <password>${env.MAVEN_PROXY_PASSWORD}</password>
    <host></host>
    <port></port>
  </proxy>
</proxies>

他のプロキシが利用できない場合は、 Instana と組み合わせて Squid プロキシ（ www.squid-cache.org ）を設定することができます。

Squid をシステムにインストールするには、いくつかの方法があります。 ほとんどの Linux® ディストリビューションのリポジトリーには Squid が含まれており、優先パッケージ・マネージャーを使用してソフトウェアをインストールできます。

使用可能なパッケージがない場合、または Microsoft® Windows®で Squid を実行する場合は、 Squid バイナリー・ファイルを (Squid Web キャッシュ資料) から入手できます。

Squid がインストールされると、サンプル構成 squid.conf が作成され、デフォルト構成になります。 Instana との通信にのみプロキシを使用したい場合は、デフォルトの設定をバックアップし、以下の squid.conf の設定を使用してください：

# The tcp port squid is listening on
http_port 3128

# Please specify subnet with instana agents
acl instana_agent_net src 10.0.0.0/8

# This is the ip of the instana backend
acl instana_backend dstdomain saas-eu-west-1.instana.io
#acl instana_backend dstdomain ec2-54-144-114-141.compute-1.amazonaws.com
#acl instana_backend dstdomain saas-us-east-1.instana.io
#acl instana_backend dstdomain saas-us-east-1.instana.io

# This is the port used by Instana
acl instana_backend_port port 443

# This is the repo to download updates and additional sensors
acl instana_repo dstdomain artifact-public.instana.io
acl instana_repo_port port 80
acl instana_repo_port_secure port 443

# Protocol used for instana backend
acl instana_backend_proto proto HTTP

# Protocol used for instana backend
acl instana_repo_proto proto HTTP
acl instana_repo_proto_secure proto HTTPS

http_access allow instana_agent_net instana_backend instana_backend_port
http_access allow instana_agent_net instana_repo instana_repo_port
http_access allow instana_agent_net instana_repo instana_repo_port_secure

# DO NOT REMOVE THIS RULE!
http_access deny all

エージェントのエンドポイントで TLS の暗号化を設定する際、次のような監視に関する問題が発生する可能性があります。 これらの課題は、 Instana のUI内のエージェントダッシュボードに表示されます。 続行する前に、それらを解決する必要があります。

監視対象の種類： agent_tls_cert_expired

エージェントエンドポイントの TLS 暗号化を設定するために使用される証明書の有効期限が切れます。 有効期限が切れた証明書を新しい証明書ファイルに置き換えるようにしてください。

監視対象の種類： agent_tls_cert_about_to_expire

エージェントエンドポイントの TLS 暗号化の設定に使用されている証明書は、あと数日で有効期限が切れます。 証明書を新しい証明書ファイルに置き換えるようにしてください。

動的ホスト・エージェントはそれ自体を更新できるため、管理オーバーヘッドを減らすことができます。 更新間隔の設定など、ダイナミックホストエージェントの更新を設定するには、 「ダイナミックホストエージェントの更新の設定」 を参照してください。

エージェントモードは Instana のUIからも設定できるため、設定ファイルにはこの上書き機能を無効にするために使用できるフラグが用意されています。 この方法では、構成ファイルのみを使用するか、インストール済みエージェントのローカル環境変数のみを使用して、エージェント・モードを構成できます。

UI からエージェント・モードを設定しない場合は、以下の行を *instanaAgentDir*/etc/instana/com.instana.agent.main.config.Agent.cfg 構成ファイルに追加します。

mode.web-override.allowed = false

デフォルトでは、エージェントは、5 MB のエージェント・ログ・ファイルの 10 倍のログ・ローテーションを使用します。 つまり、5 MB ごとにファイルがローテートされ、10 個のファイルが保持され、ファイル 11 が削除されます。

log4j2.appender.rolling.policy.type = SizeBasedTriggeringPolicy
log4j2.appender.rolling.policy.size = 5MB
log4j2.appender.rolling.strategy.type = DefaultRolloverStrategy
log4j2.appender.rolling.strategy.max = 10

エージェントは、最新の柔軟なロギング機能である Log4j2を使用します。 syslog を構成するには、以下の例を参照してください。

log4j2.rootLogger.appenderRef.Syslog.ref = Syslog
log4j2.rootLogger.appenderRef.Syslog.level = ERROR
log4j2.appender.syslog.type=Syslog
log4j2.appender.syslog.name=Syslog
log4j2.appender.syslog.layout.type=PatternLayout
log4j2.appender.syslog.layout.pattern = ${log4j2.pattern}
log4j2.appender.syslog.facility=SYSLOG
log4j2.appender.syslog.host=localhost
log4j2.appender.syslog.port=514
log4j2.appender.syslog.protocol=UDP

カスタム・コンテナー・イメージでは、 STDOUTにログを記録することができます。 これを行うには、 <instana-agent-install-dir>etc/org.ops4j.pax.logging.cfg 構成ファイルで以下の構成を指定します。

log4j2.rootLogger.appenderRef.Console.ref = Console

log4j2.appender.console.type = Console
log4j2.appender.console.name = Console
log4j2.appender.console.layout.type = PatternLayout
log4j2.appender.console.layout.pattern = ${log4j2.pattern}

ロギングでは標準の log4j2 ロギングが使用されるため、 log4j2 の資料で説明されているように、さらに多くの方法でロギングを構成できます。

エージェントは、このエージェントを介してディスク上のファイルに送信されたメトリックまたはトレースを一時的にログに記録することができます。 メトリックまたはトレースをファイルに記録する機能は、多くの場合、メトリック、トレース、トレース、またはスパンに関連するさまざまな問題をデバッグするために使用されます。

この機能を有効にするには、 *instanaAgentDir*/etc/instana/com.instana.agent.main.sender.File.cfg 構成ファイルを見つけ、以下のコマンドを使用してその内容を更新します。

# Configuration of local logging. Changes will be hot-reloaded.
# Activate logging of outgoing payloads to local disk by setting a non-empty
# prefix. The log file will be written to data/log, and the file will have the
# defined prefix followed by a timestamp.
# Note: There is no automatic rotation of those files.
prefix=locallog

# The file can be filtered to either "metrics" or "traces".
# If empty or absent, there will be no filtering.
type=traces

前述のように、変更はホット・リロードされ、即時にアクティブ化できます。 フィーチャーは一時的にのみ使用可能にする必要があります。これは、フィーチャーを使用可能のままにすると、十分な時間とトラフィックが与えられた場合に、使用可能なすべてのディスク・スペースを占有する可能性があるためです。

問題をトレースするときに、トラフィックがコンポーネントに生成されている間、1、2 分間ロギングを続行できるようにします。 次に、変更を元に戻すか、そのファイル内のすべての行をコメント化します。 繰り返しになりますが、ディスクに書き込まれた変更は、 Instana エージェントによってホットリロードされます。

サポート・チケットを処理する場合は、結果のログ・ファイルをサポート・チケットに添付します。 ログ・ファイルは *instanaAgentDir*/data/log/locallog_*.log ログ・ファイルにあります。

1. /etc/systemd/system/instana-agent.service.d/20-resource_limits.confという名前の構成ファイルを作成し、そのファイルに以下の内容を追加します。

   [Service]
   # ------------------------------------------------------------
   # CPU accounting and request-style configuration
   # ------------------------------------------------------------
   
   # Enable per-unit CPU usage accounting so that systemd and tools like
   # systemd-cgtop can report precise CPU usage for this service.
   CPUAccounting=true
   
   # cgroup v2:
   # CPUWeight defines relative CPU share (range 1-10000, default about 100).
   # 50 is about half of the default share and behaves similar to "0.5 CPU requested".
   # This is a soft, work-conserving control: the service can still use full CPU
   # when the system is idle but will get less CPU when there is contention.
   CPUWeight=50
   
   # cgroup v1:
   # CPUShares defines relative CPU share (default 1024).
   # 512 is half of the default share and behaves similar to "0.5 CPU requested".
   # Same semantics as CPUWeight above: acts only under contention, not as a hard cap.
   CPUShares=512
   
   # CPUQuota enforces a strict CPU ceiling and causes throttling even when the
   # machine is idle. This is not encouraged for the agent.
   #
   # In practice, using CPUQuota for the agent has been observed to:
   # - Degrade performance when the agent needs more CPU than the quota allows.
   # - Increase total CPU consumption compared to not throttling at all,
   #   because the agent needs more time to complete the same work while
   #   constantly being throttled.
   #
   #CPUQuota=50%
   
   
   # ------------------------------------------------------------
   # Memory accounting and hard memory limit
   # ------------------------------------------------------------
   
   # Enable per-unit memory usage accounting so that systemd and tools like
   # systemd-cgtop can report memory usage for this service.
   MemoryAccounting=true
   
   # MemoryMax sets a hard upper bound on memory usage for this service
   # and its child processes. When the limit is reached, the kernel will
   # reclaim memory or kill processes to enforce the limit.
   #
   # A hard memory limit is recommended for the agent to prevent runaway
   # memory usage from impacting the host.
   MemoryMax=768M

2. systemctl daemon-reload を実行します。

3. instana-agent サービスを再始動します。

以下の追加のパラメーターを指定して、instana-agent コンテナーを実行します。

Docker 1.13 以降の場合:

--cpus=0.5 --memory=512m

Docker 1.12 以前の場合:

--cpu-period=100000 --cpu-quota=50000 --memory=512m

以下の構成スニペットをホスト・エージェントのコンテナー構成に追加します。

livenessProbe:
  httpGet: # Agent liveness is published on localhost:42699/status
    path: /status
    port: 42699
  initialDelaySeconds: 75
  periodSeconds: 5
resources:
  requests:
    memory: "768Mi"
    cpu: "0.5"
  limits:
    # Memory requests and limits should be equal to ensure the pod gets
    # a guaranteed QoS class for memory, preventing memory-based eviction.
    memory: "768Mi"
    # CPU limits are not recommended for the agent as they can cause throttling
    # and degrade performance. Use requests to define relative CPU priority.
    # If you must set a CPU limit, use a value significantly higher than requests:
    #cpu: "1.5"

この設定では、コンテナ instana-agent にCPUとメモリを割り当てるとともに、メモリの使用量が過剰にならないよう、メモリの上限を厳格に設定します。 メモリの QoS を確実に確保するため、メモリの要求値と制限値を同じ値に設定します。 エージェントのパフォーマンス低下を招くスロットリングを避けるため、CPU制限は意図的に省略されています。