すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:Java 用 ARMS エージェントのパラメーターとデータレポートリージョンを変更する

    ドキュメントセンター

    Application Real-Time Monitoring Service:Java 用 ARMS エージェントのパラメーターとデータレポートリージョンを変更する

    最終更新日:Apr 15, 2025

    静的構成ファイルを使用して、Java 用 Application Real-Time Monitoring Service (ARMS) エージェントのデフォルト構成を制御できます。

    静的構成ファイルは、一部の静的構成とデフォルト構成のみを変更します。 これらの構成の優先度は、動的構成、Java システムプロパティ、および環境変数よりも低くなります。

    エージェント V4.x 以降

    これらのエージェントでは、すべての構成ファイルが JAR パッケージに組み込まれています。 外部パラメーターを記述するための外部構成ファイルを作成できます。 外部構成ファイルは、JAR パッケージ内の組み込み構成ファイルをオーバーライドしますが、動的構成、Java システムプロパティ、および環境変数よりも優先度は低くなります。

    エージェント構成を変更する

    1. .properties 拡張子を持つエージェント構成ファイル（例：my-app.properties）を作成します。作成場所は、エージェントがあるディレクトリが推奨されます。

    2. 必要に応じて、次のパラメーターを記述します。 デフォルト値はすべて空です。

      パラメーター

      説明

      arms.licenseKey

      エージェントのインストールに必要な LicenseKey です。 ARMS コンソールの 統合センター ページにある [Java アプリケーションモニター] カードをクリックするか、OpenAPI プラットフォームで DescribeTraceLicenseKey を呼び出すことで取得できます。

      arms.appName

      アプリケーション名です。

      profiler.tags.env

      アプリケーション環境タグです。

      profiler.tags.version

      アプリケーションバージョンタグです。

      profiler.tags.customtags

      アプリケーションのカスタムインスタンスタグです。

      最後の 3 つの設定項目は、ARMS で監視される インスタンスのタグ を指定します。

    3. エージェントの起動時に、起動コマンドに -Dotel.javaagent.configuration-file=/path/to/my-app.properties を追加するか、環境変数 OTEL_JAVAAGENT_CONFIGURATION_FILE=/path/to/my-app.properties を設定します。

      説明

      • /path/to/my-app.properties を構成ファイルの絶対パスに置き換えます。

      • 起動コマンドと環境変数の両方が構成されている場合、起動コマンドが優先されます。

    4. 必要に応じて、変更された構成ファイルを Java V4.x 用の ARMS エージェントのインストールに適用します。

    レポートリージョンを変更する

    デフォルトのデータレポートリージョンは、統合方法によって異なります。

    • Alibaba Cloud Container Service for Kubernetes (ACK) を介した統合：ACK クラスタのリージョン。

    • 手動統合：エージェントのダウンロードに使用される Object Storage Service (OSS) バケットのリージョン。

    エージェントがモニタリングデータをレポートするリージョンを変更するには、次の手順を実行します。

    方法 1

    ACK クラスタにデプロイされたアプリケーションの場合：

    1. ack-onepilot コンポーネントを V4.0.0 以降に更新します。

    2. ack-onepilot-ack-onepilotack-onepilot 名前空間の アプリケーションに ARMS_REPORT_REGION 環境変数を追加します。 値は、ARMS が利用可能なリージョンの ID である必要があります。 例： cn-hangzhou または cn-beijing。

    3. 既存のアプリケーションを再起動するか、新しいアプリケーションをデプロイして、リージョン間でデータをレポートします。

      説明

      環境変数が追加されると、クラスタにデプロイされたすべてのアプリケーションは、前の手順で指定されたリージョンにデータをレポートします。

    方法 2

    起動コマンドに -Daliyun.javaagent.profileId=cn-hangzhou を追加するか、ALIYUN_JAVAAGENT_PROFILEID=cn-hangzhou 環境変数を追加します。

    説明

    エージェント V3.x

    エージェント構成を変更する

    1. 解凍したエージェントディレクトリに移動し、arms-agent.config ファイルを見つけます。

      image

    2. arms-agent.config ファイル内の構成を変更して変更を保存するか、準備した arms-agent.config ファイルに置き換えます。

      展開して arms-agent.config ファイルを表示する（例）

      ########################################################################
#  arms.licenseKey（コンソールから取得）と arms.appName（統合されたアプリケーションの名前）を指定します。
#
#  例：
#  arms.licenseKey=XXXXXXXXXXXXXXX
#  arms.appName=Demo-Service
#
########################################################################

arms.licenseKey=

arms.appName=

########################################################################
#  ARMS エージェントは、デフォルトのシステム構成で動作します。 システムの安定性を確保するために、これらの設定を維持してください。
########################################################################

profiler.collector.trace.endpoint=arms-dc-hz.aliyuncs.com
profiler.collector.metric.endpoint=cn-hangzhou.arms.aliyuncs.com
profiler.collector.meta.endpoint=arms-dc-hz.aliyuncs.com
profiler.collector.endpoint=arms-dc-hz.aliyuncs.com


profiler.log.report.support=true

profiler.acm.endpoint=addr-hz-internal.edas.aliyun.com
profiler.acm.tenant=c845a7b4-23a1-4f28-a380-5ab30d8a280f
profiler.acm.region.id=cn-hangzhou

# ARMS エージェントがマイクロサービスエンジン (MSE) モニタリングデータをレポートするリージョン。
profiler.mse.region=cn-hangzhou


# エージェントログレベル： ERROR < WARN <  INFO <  DEBUG < TRACE
# 優先順位の高い設定は、優先順位の低いレベルのログを出力します。
profiler.agent.logger.level=WARN

# グローバル構成：イベントトラッキングを有効にするかどうかを指定します。 エージェントが正しく動作するように、値 true を保持します。
profiler.enable=true

# グローバル構成：サンプリング関数が有効になっているかどうかを指定します。 データを適切にサンプリングするには、値 true を保持します。
profiler.sampling.enable=true

# グローバル構成：サンプリングレート、単位：%。
profiler.sampling.rate=10

###########################################################
# Dubbo                                                   #
###########################################################
profiler.dubbo.enable=true

###########################################################
# Google HTTP Client                                      #
###########################################################
profiler.googlehttpclient.enable=true

###########################################################
# Alibaba Cloud High-speed Service Framework (HSF)        #
###########################################################
profiler.hsf.enable=true

###########################################################
# HTTPClient3                                             #
###########################################################
profiler.httpclient3.enable=true

###########################################################
# HTTPClient4                                             #
###########################################################
profiler.httpclient4.enable=true

###########################################################
# JDK HTTP                                                #
###########################################################
profiler.jdkhttp.enable=true

###########################################################
# Jetty                                                   #
###########################################################
profiler.jetty.enable=true

###########################################################
# MyBatis                                                 #
###########################################################
profiler.mybatis.enable=true

###########################################################
# MySQL JDBC                                             #
###########################################################
profiler.mysql.enable=true

###########################################################
# OkHttp                                                 #
###########################################################
profiler.okhttp.enable=true

###########################################################
# Oracle JDBC                                             #
###########################################################
profiler.oracle.enable=true

###########################################################
# PostgreSQL JDBC                                         #
###########################################################
profiler.postgresql.enable=true

###########################################################
# Redis                                                   #
###########################################################
profiler.redis.enable=true

###########################################################
# Spring                                                  #
###########################################################
profiler.spring.enable=true

###########################################################
# Spring-boot                                             #
###########################################################
profiler.springboot.enable=true

###########################################################
# Tomcat                                                  #
###########################################################
profiler.tomcat.enable=true

###########################################################
# MongoDB                                                 #
###########################################################
profiler.mongodb.enable=true

###########################################################
# Lettuce                                                 #
###########################################################
profiler.lettuce.enable=true

###########################################################
# GRPC                                                    #
###########################################################
profiler.grpc.enable=true

###########################################################
# Thrift                                                  #
###########################################################
profiler.thrift.enable=true

###########################################################
# Memcached                                               #
###########################################################
profiler.memcached.enable=true

# 無効な URL の構成。


profiler.thresholds.limit=100

profiler.defined.method=

profiler.callstack.maxLength=128

profiler.callsql.maxLength=1024

profiler.tprof.enableThreadProfiler=true

profiler.alibabacloud.metaserver.address=100.100.100.200
###########################################################
# SOFARPC                                                #
###########################################################
profiler.sofa.rpc.enable=true

profiler.exception.stacktrace=2

###########################################################
# タグ                                                    #
###########################################################
#profiler.tags.env=prod
profiler.tags.env=

#profler.tags.version=v1.0
profiler.tags.version=

#profiler.tags.customtags=key1:value1&key2:value2
profiler.tags.customtags=
      重要

      構成ファイル内の他のパラメーターは変更しないでください。変更すると、予期しないサンプリング結果が生じる可能性があります。 エージェント構成を変更するには、Java アプリケーションの設定をカスタマイズする をご参照ください。

      パラメーター

      説明

      デフォルト値

      arms.licenseKey

      エージェントのインストールに必要な LicenseKey です。 ARMS コンソールの 統合センター ページにある [Java アプリケーションモニター] カードをクリックするか、OpenAPI プラットフォームで DescribeTraceLicenseKey を呼び出すことで取得できます。

      -

      arms.appName

      アプリケーション名です。

      -

      profiler.tags.env

      アプリケーション環境タグです。

      -

      profiler.tags.version

      アプリケーションバージョンタグです。

      -

      profiler.tags.customtags

      アプリケーションのカスタムインスタンスタグです。

      -

      profiler.collector.trace.endpoint

      トレースデータをレポートするためのエンドポイントです。

      arms-dc-hz.aliyuncs.com

      profiler.collector.metric.endpoint

      メトリックデータをレポートするためのエンドポイントです。

      cn-hangzhou.arms.aliyuncs.com

      profiler.collector.meta.endpoint

      メタデータをレポートするためのエンドポイントです。

      arms-dc-hz.aliyuncs.com

      profiler.collector.endpoint

      その他の情報をレポートするためのエンドポイントです。

      arms-dc-hz.aliyuncs.com

      profiler.acm.endpoint

      Application Configuration Management (ACM) の動的構成をリッスンするためのエンドポイントです。

      addr-hz-internal.edas.aliyun.com

      profiler.acm.region.id

      ACM の動的構成があるリージョンです。

      cn-hangzhou

      説明

      • profiler.tags.env、profiler.tags.version、および profiler.tags.customtags パラメーターは、ARMS で監視される インスタンスのタグ を指定します。

      • 最後の 6 つのパラメーターは、例として中国 (杭州) リージョンを使用しています。

    3. 必要に応じて、変更された構成ファイルを Java V3.x 用の ARMS エージェントのインストールに適用します。

    レポートリージョンを変更する

    デフォルトのデータレポートリージョンは、統合方法によって異なります。

    • Alibaba Cloud Container Service for Kubernetes (ACK) を介した統合：ACK クラスタのリージョン。

    • 手動統合：エージェントのダウンロードに使用される Object Storage Service (OSS) バケットのリージョン。

    エージェントがモニタリングデータをレポートするリージョンを変更するには、次の手順を実行します。

    方法 1 (推奨)

    ACK クラスタにデプロイされたアプリケーションの場合：

    1. ack-onepilot コンポーネントを V4.0.0 以降に更新します。

    2. ack-onepilot-ack-onepilot アプリケーションの ack-onepilot 名前空間に ARMS_REPORT_REGION 環境変数を追加します。値は、ARMS が使用可能なリージョンの ID である必要があります。たとえば、値を cn-hangzhou または cn-beijing に設定できます。

    3. 既存のアプリケーションを再起動するか、新しいアプリケーションをデプロイして、リージョン間でデータをレポートします。

      説明

      環境変数が追加されると、クラスタにデプロイされたすべてのアプリケーションは、前の手順で指定されたリージョンにデータをレポートします。

    方法 2 (推奨)

    手動でインストールされたエージェントの場合は、ターゲットリージョンで新しいインストールパッケージを取得し、エージェントを再インストールします。

    方法 3 (非推奨)

    構成ファイル内の profiler.collector.trace.endpoint、profiler.collector.metric.endpoint、profiler.collector.meta.endpoint、profiler.collector.endpoint、profiler.acm.endpoint、および profiler.acm.region.id パラメーターを変更します。 エンドポイントの詳細については、「エンドポイント」をご参照ください。

    重要

    ARMS エージェントには、仮想パブリッククラウド (VPC) 接続チェックが含まれています。 VPC 接続に失敗した場合、自動的にパブリックネットワークに切り替わります。 そのため、VPC エンドポイントを使用することをお勧めします。

    Agents 2.x

    ARMS アプリケーションモニタリングは、Java V2.x 用のエージェントをサポートしなくなりました。 できるだけ早く エージェントをアップグレード してください。