Install the ARMS agent for an application deployed in an open source Kubernetes environment
Last Updated: Mar 29, 2022
You can use Application Real-Time Monitoring Service (ARMS) to monitor applications
that are deployed in open source Kubernetes environments. ARMS allows you to monitor
applications based on various performance metrics, such as the topology, API requests,
abnormal transactions, slow transactions, and SQL analysis. This topic describes how
to enable ARMS to monitor an application that is deployed in an open source Kubernetes
environment.
Helm is installed. For more information, see Installing Helm.
The version of your Kubernetes api-server is 1.10 or later.
Your cluster is accessible over the Internet.
If the JDK Version is 1.8.0_25 or 1.8.0_31, you may fail to install the arms Agent.
In this case, upgrade the JDK version to the latest version, which is 1.8.X.
Step 1: Install the ARMS agent
ARMS can monitor only the following two types of applications: Deployment and StatefulSet.
In this topic, a Deployment application that is deployed in an open source Kubernetes
environment is used as an example. To enable ARMS to monitor the Deployment application,
perform the following steps:
Download the arms-pilot installation package by using one of the following methods:
__ACK_CLUSTER_ID__: the ID of the Kubernetes cluster. We recommend that you specify this parameter in
the <uid>-<clusterid> format.
___ACCESSKEY__ and __ACCESSKEY_SECRET__: the AccessKey ID and AccessKey secret of your Alibaba Cloud account. For more information,
see Obtain an AccessKey pair.
__ACK_UID__: the ID of your Alibaba Cloud account. To obtain the ID of your Alibaba Cloud account,
you can move the pointer over the profile picture in the upper-right corner of the
Alibaba Cloud Management Console.
In the left-side navigation pane, choose Application Monitoring > Applications. In the top navigation bar, select a region.
On the Applications page, click Add Application in the upper-right corner.
In the Backend Applications section of the Integration Center panel, click Java.
In the upper-right corner of the Integrate Java panel, select the region in which you want to install the Java application.
Obtain the license key in the STEP2 section.
Step 3: Edit the YAML file of the application
Run the following command to view the YAML file of the Deployment application:
kubectl get deployment {Name of the Deployment application} -o yaml
Note If you do not know the name of the Deployment application, run the following command to view all Deployment applications. You can find the
required Deployment application in the results. Then, view the YAML file of the application.
kubectl get deployments --all-namespace
Run the following command to edit the YAML file of the Deployment application:
kubectl edit deployment {Name of the Deployment application} -o yaml
In the YAML file, go to the spec > template > metadata > labels directory and add the following content:
ARMSApmAppName: xxx
ARMSApmLicenseKey: xxx
one-agent.jdk.version: "OpenJDK11" // If the application uses JDK 11, you must configure this parameter.
Notice
Replace xxx with your application name and license key. The application name cannot contain Chinese
characters.
Replace the at sign (@) in the license key with an underscore (_).
The following example shows a complete YAML file for creating a Deployment application
in an open source Kubernetes environment and enabling ARMS to monitor the application:
apiVersion: apps/v1beta1 # for versions before 1.8.0 use apps/v1beta1
kind: Deployment
metadata:
name: arms-springboot-demo
labels:
app: arms-springboot-demo
spec:
replicas: 2
selector:
matchLabels:
app: arms-springboot-demo
template:
metadata:
labels:
app: arms-springboot-demo
ARMSApmLicenseKey: "xxx_xxx"
ARMSApmAppName: "arms-k8s-demo"
one-agent.jdk.version: "OpenJDK11"
spec:
containers:
- resources:
limits:
cpu: 0.5
image: registry.cn-hangzhou.aliyuncs.com/arms-docker-repo/arms-springboot-demo:v0.1
imagePullPolicy: Always
name: arms-springboot-demo
env:
- name: MYSQL_SERVICE_HOST
value: "arms-demo-mysql"
- name: MYSQL_SERVICE_PORT
value: "3306"
---
apiVersion: apps/v1beta1 # for versions before 1.8.0 use apps/v1beta1
kind: Deployment
metadata:
name: arms-demo-mysql
labels:
app: mysql
spec:
replicas: 1
selector:
matchLabels:
app: mysql
template:
metadata:
labels:
app: mysql
spec:
containers:
- resources:
limits:
cpu: 0.5
image: registry.cn-hangzhou.aliyuncs.com/arms-docker-repo/arms-demo-mysql:v0.1
name: mysql
ports:
- containerPort: 3306
name: mysql
---
apiVersion: v1
kind: Service
metadata:
labels:
name: mysql
name: arms-demo-mysql
spec:
ports:
# the port that this service should serve on
- name: arms-mysql-svc
port: 3306
targetPort: 3306
# label keys and values that must match in order to receive traffic for this service
selector:
app: mysql
---
After the preceding configurations are saved, the application automatically restarts
and then the configurations take effect.
After 2 to 5 minutes, if your application is displayed on the Application Monitoring > Applications page in the ARMS console and specific monitoring data is reported, your application
is monitored by ARMS.
Uninstall the ARMS agent
If you no longer want to use ARMS to monitor your Java applications deployed in an
open-source Kubernetes environment, run the following command to uninstall arms-pilot: