您可以使用阿里云Prometheus监控部署在阿里云K8s集群中的GO应用的运行情况,在监控大盘上查看多种监控数据,还可配置监控报警。本教程介绍如何通过在Go应用中埋点来暴露应用的数据,使用Prometheus抓取数据,并借助Prometheus Grafana大盘来展示数据,最终实现通过Prometheus监控Go应用的目的。

前提条件

在开始本教程前,确保您已经完成了以下操作:

背景信息

本教程的操作流程如图所示。

How It Works

步骤一:通过埋点暴露Go应用的数据

  1. 将监控包导入Go应用。
    import (
        "fmt"
        "github.com/prometheus/client_golang/prometheus/promhttp"
        "net/http"
        "strconv"
    )
  2. 将监控接口绑定至promhttp.Handler()
    http.Handle(path, promhttp.Handler()) //初始化一个HTTP Handler

步骤二:将应用部署至阿里云容器服务K8s集群

  1. 逐行运行buildDockerImage.sh中的以下命令,构建名为promethues-arms-aliyun-go-demo的Docker镜像,并将镜像推送至阿里云Docker Registry。
    mvn clean install -DskipTests
    docker build -t <本地临时Docker镜像名称>:<本地临时Docker镜像版本号> . --no-cache
    sudo docker tag <本地临时Docker镜像名称>:<本地临时Docker镜像版本号> <Registry域名>/<命名空间>/<镜像名称>:<镜像版本号>
    sudo docker push <Registry域名>/<命名空间>/<镜像名称>:<镜像版本号>
    例如:
    mvn clean install -DskipTests
    docker build -t promethues-arms-aliyun-go-demo:v0.1 . --no-cache
    sudo docker tag promethues-arms-aliyun-go-demo:v0.1 registry.cn-hangzhou.aliyuncs.com/testnamespace/prometheus-arms-aliyun-go-demo-amd64:dev-v0.1
    sudo docker push registry.cn-hangzhou.aliyuncs.com/testnamespace/promethues-demo:v0.1
  2. 登录容器服务Kubernetes版控制台
  3. 在左侧导航栏选择集群,在集群列表页面上的目标集群右侧操作列单击应用管理
    K8s Cluster Console Button
  4. 工作负载页面单击无状态页签,在无状态页签中,单击使用模板创建
  5. 使用模板创建页签中,选择示例模板自定义,并在文本框中填写以下内容,然后单击创建,将步骤1中创建的Docker镜像部署至容器服务K8s集群中。
    apiVersion: extensions/v1beta1
    kind: Deployment
    metadata:
      name: promethues-arms-aliyun-go-demo
    spec:
      replicas: 2
      template:
        metadata:
          labels:
            app: promethues-arms-aliyun-go-demo
        spec:
          containers:
          - name: promethues-arms-aliyun-go-demo
            imagePullPolicy: Always
            image: registry.cn-hangzhou.aliyuncs.com/fuling/prometheus-arms-aliyun-go-demo-amd64:dev-v0.1
            ports:
            - containerPort: 8077
              name: arms-go-demo
  6. 在左侧导航栏选择服务,在页面右上角单击使用YAML创建资源
  7. 工作负载对应页签中填写以下内容,然后单击创建
    apiVersion: v1
    kind: Service
    metadata:
      labels:
        app: promethues-arms-aliyun-go-demo
      name: promethues-arms-aliyun-go-demo
    spec:
      ports:
      - name: arms-go-demo
        port: 8077
        protocol: TCP
        targetPort: 8077
      type: NodePort
      selector:
        app: promethues-arms-aliyun-go-demo

步骤三:配置Prometheus监控以抓取Go应用的数据

  1. 登录容器服务Kubernetes版控制台
  2. 为目标容器服务K8s集群开启阿里云Prometheus监控。具体操作,请参见开始使用Prometheus监控
  3. 登录Prometheus控制台
  4. Prometheus监控页面左上角选择容器服务K8s集群所在的地域,并在目标集群右侧的操作列单击设置
  5. 设置页面单击服务发现页签,在服务发现页签上单击添加ServiceMonitor,在添加ServiceMonitor对话框中填写以下内容,然后单击确定
    apiVersion: monitoring.coreos.com/v1
    kind: ServiceMonitor
    metadata:
      # 填写一个唯一名称
      name: promethues-arms-aliyun-go-demo
      # 填写目标命名空间
      namespace: default
    spec:
      endpoints:
      - interval: 30s
        # 填写Prometheus Exporter对应的Port的Name字段的值
        port: arms-go-demo
        # 填写Prometheus Exporter对应的Path的值
        path: /metrics
      namespaceSelector:
        any: true
        # Demo的命名空间
      selector:
        matchLabels:
          app: promethues-arms-aliyun-go-demo

步骤四:通过Grafana大盘展示Go应用的数据

最后需要在Prometheus控制台导入Grafana大盘模板并指定Prometheus数据源所在的容器服务K8s集群。

  1. 打开Prometheus Grafana大盘概览页
  2. 在左侧导航栏中选择+ > Import,并在Grafana.com Dashboard文本框输入6671,然后单击Load
    Import Grafana Dashboard
  3. Import页面输入以下信息,然后单击Import
    Import Grafana Dashboard with Options
    1. Name文本框中输入自定义的大盘名称。
    2. Folder列表中,选择您的阿里云容器服务K8s集群。
    3. prometheus-apl下拉框中选择您的阿里云容器服务K8s集群。
    配置完毕后的Prometheus Grafana Go大盘如图所示。ARMS Prometheus Grafana Go

步骤五:创建Prometheus监控报警

  1. 登录Prometheus控制台
  2. 在顶部菜单栏选择目标地域,然后单击目标K8s集群名称。
  3. 在左侧导航栏中选择报警配置Beta,然后在右上角单击创建报警
  4. 创建报警对话框中输入以下信息,完成后单击确认
    说明 时间设置功能暂不支持。
    1. 填写规则名称,例如:网络接收压力报警。
    2. 输入报警规则表达式,表达式需要使用PromQL语句。例如:(sum(rate(kube_state_metrics_list_total{job="kube-state-metrics",result="error"}[5m])) / sum(rate(kube_state_metrics_list_total{job="kube-state-metrics"}[5m]))) > 0.01
      注意 PromQL语句中包含的$符号会导致报错,您需要删除包含$符号的语句中=左右两边的参数及=。例如:将sum (rate (container_network_receive_bytes_total{instance=~"^$HostIp.*"}[1m]))修改为sum (rate (container_network_receive_bytes_total[1m]))
    3. 标签区域单击创建标签可以设置报警标签,设置的标签可用作分派规则的选项。
    4. 注释区域可以编辑告警信息发送模板。单击创建注释,设置message,设置 {{变量名}}告警信息。设置完成后的格式为:message:{{变量名}}告警信息,例如:message:{{$labels.pod_name}}重启。

      您可以自定义变量名,也可以选择已有的标签作为变量名。已有的标签包括:

      • 报警规则表达式指标中携带的标签。
      • 通过报警规则创建的标签,请参见创建报警
      • ARMS系统自带的默认标签,默认标签说明如下。
        标签 说明
        alertname 告警名称,格式为:告警名称_集群名称。
        _aliyun_arms_alert_level 告警等级。
        _aliyun_arms_alert_type 告警类型。
        _aliyun_arms_alert_rule_id 告警规则对应的ID。
        _aliyun_arms_region_id 地域ID。
        _aliyun_arms_userid 用户ID。
        _aliyun_arms_involvedObject_type 关联对象子类型,如ManagedKubernetes,ServerlessKubernetes。
        _aliyun_arms_involvedObject_kind 关联对象分类,如app,cluster。
        _aliyun_arms_involvedObject_id 关联对象ID。
        _aliyun_arms_involvedObject_name 关联对象名称。
    Prometheus-Create alarm

后续步骤

Prometheus Grafana Go大盘配置完毕后,您可以查看Prometheus监控指标和进一步自定义大盘,详情请参见以下文档。

大盘列表

通过阿里云Prometheus自定义Grafana大盘