Application Real-Time Monitoring Service:Use Application Monitoring eBPF Edition to monitor an application in a Kubernetes environment

Prerequisites

• The version of the Kubernetes cluster is 1.20 or later.

• The cluster is accessible over the Internet, or a network connection is established between an Alibaba Cloud virtual private cloud (VPC) and the cluster by using a Cloud Enterprise Network (CEN) instance.

• The x86 architecture is used, and the kernel version is 4.19 or later. For more environment requirements, see Requirements and limitations on operating systems of Application Monitoring eBPF Edition.

Step 1: Install Helm v3

For information about how to install Helm v3, see Helm documentation.

Step 2: Install the ack-arms-cmonitor agent

Application Monitoring eBPF Edition can monitor only the following types of applications: Deployment and StatefulSet. Connecting a Deployment application and a StatefulSet application requires the same steps. To enable Application Monitoring eBPF Edition to monitor a Deployment application, perform the following steps:

1. Run the following wget command to download the ack-arms-cmonitor installation package:

   wget 'https://aliacs-app-catalog.oss-cn-hangzhou.aliyuncs.com/charts-incubator/ack-arms-cmonitor-4.1.2.tgz'

2. Run the following command to decompress the ack-arms-cmonitor installation package:

   tar xvf ack-arms-cmonitor-4.1.2.tgz

3. Change the environment variable IS_PUBLIC in the otel-collector-deployment.yaml file to public.

4. Edit the values.yaml file in the installation package. Modify the following parameters based on your business requirements and save the file.

   registry: registry-__ACK_REGION_ID__-vpc.ack.aliyuncs.com
   cluster_id: __ACK_CLUSTER_ID__
   accessKey: __ACCESSKEY__
   accessKeySecret: __ACCESSKEY_SECRET__
   uid: "__ACK_UID__"
   region_id: __ACK_REGION_ID__

   • registry: the image address.

     Note

     In the preceding example, the image address is used for virtual private clouds (VPCs). If your application is deployed on the Internet, use the following image address:

     registry-__ACK_REGION_ID__.ack.aliyuncs.com

   • __ACK_REGION_ID__: the region ID. For more information about the regions that support Application Monitoring eBPF Edition, see Supported regions.

   • __ACK_CLUSTER_ID__: the unique 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 about how to obtain the AccessKey ID and AccessKey secret of your Alibaba Cloud account, see Obtain an AccessKey pair.

     Important

     You must make sure that the AliyunARMSFullAccess and AliyunSTSAssumeRoleAccess policies are attached to your Alibaba Cloud account.

   • __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.

5. Install the ack-arms-cmonitor agent.

   Run the following command without opening the ack-arms-cmonitor installation package:

   helm3 upgrade --install ack-arms-cmonitor ack-arms-cmonitor --namespace arms-prom --create-namespace

Step 3: Edit the YAML file of the application

1. Run the following command to view the YAML file of the Deployment application:

   kubectl get deployment {Deployment application name} -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

2. Run the following command to edit the YAML file of the Deployment application:

   kubectl edit deployment {Deployment application name} -o yaml

3. In the YAML file, add the following content to the spec.template.metadata parameter.

   labels:
     armseBPFAutoEnable: "on"
     armseBPFCreateAppName: "<your-deployment-name>" # Replace <your-deployment-name> with the application name.

   The following example shows a complete YAML file for creating a Deployment application in a Kubernetes environment and enabling Application Monitoring eBPF Edition to monitor the application:

   Show details of the YAML file

   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
           armseBPFAutoEnable: "on"
           armseBPFCreateAppName: "arms-k8s-demo"
       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
   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
   ---

4. After the preceding configurations are saved, the application automatically restarts and then the configurations take effect.

   After 2 to 5 minutes, if your application appears on the Application Monitoring eBPF > Application List page in the ARMS console and specific monitoring data is reported, your application is monitored by Application Monitoring eBPF Edition.

References

After you connect an application deployed in a Kubernetes environment to Application Monitoring eBPF Edition, you can view the metrics, upstream and downstream dependencies, and topology of the application. For more information, see Application details.