Application Real-Time Monitoring Service:Add and use tags

Tag types

Application Monitoring provides application tags and instance tags. Select a tag type based on your business requirements. Both application tags and instance tags use key-value pairs. You can add multiple key-value pairs at the same time.

Application tags

To view or modify application tags, log on to the ARMS console. In the left-side navigation pane, choose Application Monitoring > Application List. You can use application tags to query applications, manage application permissions, and split bills.

Instance tags

Each application monitored in Application Monitoring can contain multiple application instances, and each application instance represents a Java process. Different application instances that belong to the same application may have different instance tags.

To application instances that are automatically connected from Kubernetes environments to Application Monitoring, ARMS adds the following tags by default.

In addition to the default instance tags, you can add custom instance tags. At the same time, instance tags added to an application are fully inherited and displayed with the monitoring data of each application instance.

Example:

As shown in the following figure, the application my-app contains two instances: Instance A and Instance B. The arms_jvm_gc_total metric of Instance B has the following tags: env: Dev, team: Observability, app: my-app, workloadKind: Deployment, workloadName: my-app, clusterName: ClusterA, namespace: nsA, and gitVersion: 1.0.2.

Add custom instance tags

Add custom instance tags to applications deployed in Kubernetes environments

Method 1 (recommended): Use pod labels to add custom instance tags

To applications that are deployed in Kubernetes environments and have the ARMS agent automatically installed, you can add custom instance tags by using pod labels.

Take an application deployed in an ACK cluster as an example:

Log on to the ACK console. In the left-side navigation pane of the cluster details page, click Deployments or StatefulSets. On the page that appears, select a namespace, find the Deployment or StatefulSet, and then choose More > View in YAML in the Actions column. In the Edit YAML dialog box, add custom tags and click Update. The application instance will be restarted, and new instance tags will be added.

Method 2: Use a pod environment variable to add custom instance tags

To add custom instance tags that can be obtained only after pods are created, such as podName, you can add an environment variable in the startup script of the container. Perform the following steps:

1. Add an environment variable named ARMS_HOST_TAGS to the container. Set the value to the instance tags. Format: key1:value1&key2:value2. Example: export ARMS_HOST_TAGS="gitVersion:1.0.2&ip:192.168.1.101".

2. After the environment variable takes effect, start the Java process.

Add custom instance tags to applications that have the ARMS agent manually installed

Method 1: Add a -D command-line parameter

Add a -D command-line parameter named -Darms.host.tags="${yourLabel}" to the startup parameters of the application.

Replace ${yourLabel} with the instance tags that you want to add. Format: key1:value1&key2:value2. Example: -Darms.host.tags="gitVersion:1.0.2&ip:192.168.1.101".

Method 2: Modify the configuration file

Use pod labels to add application tags to applications deployed in Kubernetes environments

If a pod label is prefixed with app.customAppKey., it is recognized as an application tag, rather than an instance tag.

In the following code, ARMS adds an application tag env: dev to the application.

  template:
    metadata:
      labels:
        app.customAppKey.env: dev
        app: mall-gateway
        armsPilotAutoEnable: 'on'
        armsPilotCreateAppName: mall-gateway

Use application tags

Application query

When you view the application list or create alert rules in the ARMS console, you can use application tags to query applications.

Tag-based permission management

You can manage RAM permissions based on application tags. For more information, see Attach a custom policy to a RAM user.

Use instance tags

Query monitoring data on the application details page

1. Log on to the ARMS console. In the left-side navigation pane, choose Application Monitoring > Applications.

2. On the Applications page, select a region in the top navigation bar and click the name of the application that you want to manage.

   Note

   If the icon is displayed in the Language column, the application is connected to Application Monitoring. If a hyphen (-) is displayed, the application is connected to Managed Service for OpenTelemetry.

3. In various modules of the application details page, you can use instance tags to query monitoring data. For example, you can compare and analyze monitoring data based on image versions.

Query metrics on the Grafana view page

1. Log on to the ARMS console. In the left-side navigation pane, choose Application Monitoring > Applications.

2. On the Applications page, select a region in the top navigation bar and click the name of the application that you want to manage.

   Note

   If the icon is displayed in the Language column, the application is connected to Application Monitoring. If a hyphen (-) is displayed, the application is connected to Managed Service for OpenTelemetry.

3. In the left-side navigation pane, click Grafana view. On the page that appears, configure tags to view metrics.