全部产品
Search

搜索本产品

    应用实时监控服务ARMS：容器服务ACK环境自动安装探针

    文档中心

    应用实时监控服务ARMS：容器服务ACK环境自动安装探针

    更新时间：Dec 20, 2024

    您只需安装ARMS应用监控组件ack-onepilot，即可监控部署在容器服务Kubernetes版中的Java应用，并查看应用拓扑、接口调用、异常事务和慢事务等相关监控数据。本文介绍如何为容器服务Kubernetes版Java应用安装探针。

    前提条件

    步骤一：安装ARMS探针接入助手（ack-onepilot）

    重要

    • ARMS探针接入助手（ack-onepilot）是用于接入各语言探针的重要组件，可以帮助ARMS用户在容器环境中自动准备好ARMS探针包并构建好探针的上报环境。ARMS探针接入助手（ack-onepilot）的基本原理请参见ack-onepilot组件基本原理说明。

    • ACK旧版应用监控组件arms-pilot已不再维护，您可以安装升级后的ack-onepilot组件用于监控您的应用，ack-onepilot完全兼容arms-pilot，您无需修改应用配置即可无缝接入ack-onepilot。更多信息，请参见如何安装ack-onepilot和卸载arms-pilot。

    1. 登录容器服务管理控制台。

    2. 在左侧导航栏单击集群，然后在集群列表页面单击目标集群名称。

    3. 在左侧导航栏选择运维管理 > 组件管理，然后在右上角通过关键字搜索ack-onepilot。

    4. 在ack-onepilot卡片上单击安装。

      说明

      ack-onepilot组件默认支持1000个pod规模，集群pod每超过1000个，ack-onepilot资源对应的CPU请增加0.5核、内存请增加512 MB。

    5. 在弹出的页面中可以配置相关的参数，建议使用默认值，单击确定。

      说明

      安装完成后，您可以在组件管理页面升级、配置或卸载ack-onepilot组件。

    步骤二：授予ARMS资源的访问权限

    • 如果需监控ASK（容器服务Serverless版）或对接了ECI的集群应用，请在云资源访问授权页面完成授权，然后重启ack-onepilot组件下的所有Pod。

    • 如果需监控ACK集群应用，但ACK集群中不存在ARMS Addon Token，请执行以下操作手动为集群授予ARMS资源的访问权限。如果已经存在ARMS Addon Token，请跳转至步骤三。

      查看集群是否存在ARMS Addon Token。

      1. 登录容器服务管理控制台，在集群列表页面，单击目标集群名称进入集群详情页。

      2. 在左侧导航栏选择配置管理 > 保密字典，然后在顶部选择命名空间为kube-system，查看addon.arms.token是否存在。

      说明

      集群存在ARMS Addon Token时，ARMS会进行免密授权。Kubernetes托管版集群默认存在ARMS Addon Token，但对于部分早期创建的Kubernetes托管版集群，可能会存在没有ARMS Addon Token的情况，因此，对于Kubernetes托管版集群，建议首先检查ARMS Addon Token是否存在。若不存在，需进行手动授权。

      手动添加权限策略。

      1. 登录容器服务管理控制台，在集群列表页面单击目标集群名称。

      2. 在集群信息 > 基本信息页签的集群资源区域，单击Worker RAM角色右侧的链接。

      3. 在权限管理页签单击新增授权。

      4. 在新增授权面板添加以下两个权限策略，然后单击确认新增授权。

        • AliyunTracingAnalysisFullAccess：可观测链路 OpenTelemetry 版的完整权限。

        • AliyunARMSFullAccess：ARMS的完整权限。

    • 如果需要监控专有版集群和注册集群应用，请确认对应的阿里云账号已包含AliyunARMSFullAccess和AliyunSTSAssumeRoleAccess权限。添加权限的操作，请参见为RAM用户授权。

      安装ack-onepilot组件后，还需要在ack-onepilot中填写有ARMS权限的阿里云账号AK/SK。

      1. 在左侧导航栏选择应用 > Helm页面，单击ack-onepilot组件右侧的更新。

      2. 将accessKey和accessKeySecret替换为当前账号的AccessKey，然后单击确定。

        说明

        获取AccessKey的操作，请参见创建AccessKey。

        image

      3. 重启应用Deployment。

    步骤三：为Java应用开启ARMS应用监控

    如需在创建新应用的同时开启ARMS应用监控，请完成以下操作。

    1. 在容器服务管理控制台左侧导航栏单击集群，在集群列表页面上的目标集群右侧操作列单击应用管理。

    2. 在无状态页面单击使用YAML创建资源。

    3. 选择示例模板，并在模板（YAML格式）中将以下labels添加到spec.template.metadata层级下。

      labels:
  armsPilotAutoEnable: "on"
  armsPilotCreateAppName: "<your-deployment-name>"    #请将<your-deployment-name>替换为您的应用名称。
  armsSecAutoEnable: "on"    #如果需要接入应用安全，则需要配置此参数。
      说明

      • 探针接入后，为了确保您的使用体验，在新版本探针发布后，当应用重启时，ack-onepilot将会自动将探针升级到最新版本，如果您不需要跟随ARMS探针的版本发布自动更新挂载的探针，可以自主控制探针版本。具体操作，请参见自主控制探针版本。

      • 应用安全详情，请参见什么是应用安全。

      • 应用安全计费信息，请参见计费说明。

      YAML Example

      创建一个无状态（Deployment）应用并开启ARMS应用监控的完整YAML示例模板如下：

      展开查看完整示例YAML文件（Java）

      apiVersion: v1
kind: Namespace
metadata:
  name: arms-demo
---
apiVersion: apps/v1 # for versions before 1.8.0 use apps/v1beta1
kind: Deployment
metadata:
  name: arms-springboot-demo
  namespace: arms-demo
  labels:
    app: arms-springboot-demo
spec:
  replicas: 2
  selector:
    matchLabels:
      app: arms-springboot-demo
  template:
    metadata:
      labels:
        app: arms-springboot-demo
        armsPilotAutoEnable: "on"
        armsPilotCreateAppName: "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: SELF_INVOKE_SWITCH
              value: "true"
            - name: COMPONENT_HOST
              value: "arms-demo-component"
            - name: COMPONENT_PORT
              value: "6666"
            - name: MYSQL_SERVICE_HOST
              value: "arms-demo-mysql"
            - name: MYSQL_SERVICE_PORT
              value: "3306"
---
apiVersion: apps/v1 
kind: Deployment
metadata:
  name: arms-springboot-demo-subcomponent
  namespace: arms-demo
  labels:
    app: arms-springboot-demo-subcomponent
spec:
  replicas: 2
  selector:
    matchLabels:
      app: arms-springboot-demo-subcomponent
  template:
    metadata:
      labels:
        app: arms-springboot-demo-subcomponent
        armsPilotAutoEnable: "on"
        armsPilotCreateAppName: "arms-k8s-demo-subcomponent"
    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-subcomponent
          env:
            - name: SELF_INVOKE_SWITCH
              value: "false"
            - name: MYSQL_SERVICE_HOST
              value: "arms-demo-mysql"
            - name: MYSQL_SERVICE_PORT
              value: "3306"
---
apiVersion: v1
kind: Service
metadata:
  labels:
    name: arms-demo-component
  name: arms-demo-component
  namespace: arms-demo
spec:
  ports:
    # the port that this service should serve on
    - name: arms-demo-component-svc
      port: 6666
      targetPort: 8888
  # label keys and values that must match in order to receive traffic for this service
  selector:
    app: arms-springboot-demo-subcomponent
---
apiVersion: apps/v1 # for versions before 1.8.0 use apps/v1beta1
kind: Deployment
metadata:
  name: arms-demo-mysql
  namespace: arms-demo
  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
  namespace: arms-demo
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
---

    执行结果

    在无状态页面上，目标应用的操作列将出现ARMS控制台按钮。

    ARMS Console Button

    常见问题