You can use Application Real-Time Monitoring Service (ARMS) to monitor applications that are deployed in 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 a Kubernetes environment.
This topic does not apply to Alibaba Cloud Container Service for Kubernetes (ACK) clusters. For information about how to install an ARMS agent in an ACK cluster, see Automatically install an ARMS agent in ACK.
Prerequisites
The kube-apiserver version of the Kubernetes cluster is 1.10 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 version of the JDK is supported by Application Monitoring. For more information, see Java components and frameworks supported by ARMS.
(Recommend) Method 1: Enable ARMS by using a registered Kubernetes cluster
Register a Kubernetes cluster in ACK One. For more information, see Create a registered cluster in the ACK console.
Install the ack-onepilot component for the registered Kubernetes cluster. For more information, see Enable ARMS for a registered cluster.
Method 2: Directly enable ARMS
Step 1: Install Helm V3
Step 2: Install the ARMS agent
ARMS can monitor only the following two types of applications: Deployment and StatefulSet. To enable ARMS to monitor the Deployment application, perform the following steps:
Run the following
wget
command to download the ack-onepilot installation package:wget 'https://aliacs-app-catalog.oss-cn-hangzhou.aliyuncs.com/charts-incubator/ack-onepilot-3.0.19.tgz'
Run the following command to decompress the ack-onepilot installation package:
tar xvf ack-onepilot-3.0.19.tgz
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__.aliyuncs.com/acs/ cluster_id: __ACK_CLUSTER_ID__ accessKey: __ACCESSKEY__ accessKeySecret: __ACCESSKEY_SECRET__ uid: "__ACK_UID__" region_id: __ACK_REGION_ID__
image
: the image address of the ack-onepilot component.NoteIn 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/acs/
__ACK_REGION_ID__
: the region ID. For more information about the regions that support Application Monitoring, see Regions where Application Monitoring is supported.__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, see Obtain an AccessKey pair.ImportantYou 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.
Install the ack-onepilot component.
Run the following command without opening the ack-onepilot installation package:
helm3 upgrade --install ack-onepilot ack-onepilot --namespace ack-onepilot --create-namespace
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 {Deployment application name} -o yaml
NoteIf you do not know the
Deployment application name
, 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 directory and add the following content:
labels: armsPilotAutoEnable: "on" armsPilotCreateAppName: "<your-deployment-name>" # Replace <your-deployment-name> with the actual application name. armsSecAutoEnable: "on" # If you want to connect the application to Application Security, you must configure this parameter.
NoteFor information about Application Security, see What is Application Security?
For information about the billing of Application Security, see Billing rules.
The following example shows a complete YAML file for creating a Deployment application in a Kubernetes environment and enabling ARMS to monitor the application:
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 ARMS console and specific monitoring data is reported, your application is monitored by ARMS.
page in the