Updated on 2024-03-06 GMT+08:00

Connecting Agents

Prerequisite

The network between your host and APM is normal.

You can run the Telnet command to check the network. For example, to check the network connectivity in the CN-Hong Kong region, log in to the host where the application is deployed and run the telnet 100.125.6.106:41333 command. For details about the access addresses of other regions, see Access Addresses.

Procedure

  1. Log in to the management console.
  2. Click on the left and choose Application > Application Performance Management.
  3. In the navigation pane, choose Application Monitoring > Applications.
  4. On the displayed page, click Access Application.

    Figure 1 Connecting an application

  5. For Code Source, select Enhanced probe.
  6. Select a region and application.

    Figure 2 Basic information

  7. For Backend language, select Java.

    Figure 3 Access mode

  8. Select an access mode based on the application type, and access data by following the instructions.

    Figure 4 Data access
    Table 1 Parameter description

    Parameter

    Description

    Mandatory

    pwd

    Path where the apm-javaagent.jar package is located.

    Yes

    appName

    Component name, which must start with a character. A component can contain multiple environments. The names of components under an application must be unique. If there are duplicate names, use instanceName to distinguish them.

    Yes

    env

    Name of an environment where an application is deployed. A program can be deployed in different environments (such as the test or live network environment). Each environment is deployed in one region and has a unique region attribute. If this parameter is blank, the default environment will be used.

    No

    envTag

    Environment tag for filtering environments. Different environments may have the same tag. This parameter can be left blank.

    No

    business

    Name of an application that already exists (a global concept). If this parameter is left blank, the automatically created application will be used.

    No

    subBusiness

    Name of a sub-application (a global concept), which is similar to a folder. If it is left blank, resources will be mounted to the root application. There can be up to three layers of sub-applications. For example, for a/b/c, a, b, and c respectively represents a layer.

    No

    instanceName

    Name of an instance, which is left blank by default. If an application has multiple instances deployed on a host, use this parameter to distinguish them. Generally, Java instances deployed on a host belong to different applications. An application rarely has identical instances.

    No

Dynamically Configuring master.address and AK/SK

APM supports dynamic configuration of the master.address and AK/SK.

You can set the APM_MASTER_ADDRESS, APM_ACCESS_KEY (apm-ak), and APM_SECRET_KEY (apm-sk) environment variables. For details about how to obtain the AK/SK, see Manually Installing Agents for Java Applications. For details about how to obtain the master.address, see Access Address (master.address).

  • If you set the AK/SK and master.address in both the JavaAgent configuration file and environment variables, your environment variable settings will take precedence.
  • Agents later than 2.3.19 support dynamic configuration of master.address and AK/SK.