# 配置 Prometheus 监控 EMQX 集群

# 任务目标

如何通过 Prometheus 监控 EMQX 集群。

# 部署 Prometheus

Prometheus 部署文档可以参考：Prometheus (opens new window)

# 部署 EMQX 集群

EMQX 支持通过 http 接口对外暴露指标，集群下所有统计指标数据可以参考文档：HTTP API (opens new window)

apiVersion: apps.emqx.io/v2alpha1
kind: EMQX
metadata:
  name: emqx
spec:
  image: emqx/emqx:5.0.14
  imagePullPolicy: IfNotPresent    
  coreTemplate:
    spec:
      replicas: 3
      ports:
        - name: http-dashboard
          containerPort: 18083
  replicantTemplate:
    spec:
      replicas: 1
      ports:
        - name: http-dashboard
          containerPort: 18083

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

EMQX 支持通过 http 接口对外暴露指标，集群下所有统计指标数据可以参考文档：HTTP API (opens new window)

apiVersion: apps.emqx.io/v1beta4
kind: EmqxEnterprise
metadata:
  name: emqx-ee
spec:
  replicas: 3
  template:
    spec:
      emqxContainer:
        image: 
          repository: emqx/emqx-ee
          version: 4.4.14
        ports:
          - name: http-management
            containerPort: 8081

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

EMQX 支持通过 http 接口对外暴露指标，集群下所有统计指标数据可以参考文档：HTTP API (opens new window)

apiVersion: apps.emqx.io/v1beta3
kind: EmqxEnterprise
metadata:
  name: emqx-ee
spec:
  replicas: 3
  emqxTemplate:
      image: emqx/emqx-ee:4.4.14

1
2
3
4
5
6
7
8

将上述内容保存为：emqx.yaml 并部署 EMQX 集群

输出类似于：

emqx.apps.emqx.io/emqx created

检查 EMQX 集群是否就绪

kubectl get emqx emqx -o json | jq ".status.emqxNodes"

输出类似于：

[
  {
    "node": "emqx@10.244.2.13",
    "node_status": "running",
    "otp_release": "24.3.4.2-1/12.3.2.2",
    "role": "replicant",
    "version": "5.0.12"
  },
  {
    "node": "emqx@emqx-core-0.emqx-headless.default.svc.cluster.local",
    "node_status": "running",
    "otp_release": "24.3.4.2-1/12.3.2.2",
    "role": "core",
    "version": "5.0.12"
  },
  {
    "node": "emqx@emqx-core-1.emqx-headless.default.svc.cluster.local",
    "node_status": "running",
    "otp_release": "24.3.4.2-1/12.3.2.2",
    "role": "core",
    "version": "5.0.12"
  },
  {
    "node": "emqx@emqx-core-2.emqx-headless.default.svc.cluster.local",
    "node_status": "running",
    "otp_release": "24.3.4.2-1/12.3.2.2",
    "role": "core",
    "version": "5.0.12"
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

说明： node 表示 EMQX 节点在集群的唯一标识。node_status 表示 EMQX 节点的状态。otp_release 表示 EMQX 使用的 Erlang 的版本。role 表示 EMQX 节点角色类型。version 表示 EMQX 版本。EMQX Operator 默认创建包含三个 core 节点和三个 replicant 节点的 EMQX 集群，所以当集群运行正常时，可以看到三个运行的 core 节点和三个 replicant 节点信息。如果你配置了 .spec.coreTemplate.spec.replicas 字段，当集群运行正常时，输出结果中显示的运行 core 节点数量应和这个 replicas 的值相等。如果你配置了 .spec.replicantTemplate.spec.replicas 字段，当集群运行正常时，输出结果中显示的运行 replicant 节点数量应和这个 replicas 的值相等。

kubectl get emqxenterprise emqx-ee -o json | jq ".status.emqxNodes"

输出类似于：

[
  {
    "node": "emqx-ee@emqx-ee-0.emqx-ee-headless.default.svc.cluster.local",
    "node_status": "Running",
    "otp_release": "24.3.4.2/12.3.2.2",
    "version": "4.4.14"
  },
  {
    "node": "emqx-ee@emqx-ee-1.emqx-ee-headless.default.svc.cluster.local",
    "node_status": "Running",
    "otp_release": "24.3.4.2/12.3.2.2",
    "version": "4.4.14"
  },
  {
    "node": "emqx-ee@emqx-ee-2.emqx-ee-headless.default.svc.cluster.local",
    "node_status": "Running",
    "otp_release": "24.3.4.2/12.3.2.2",
    "version": "4.4.14"
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

说明： node 表示 EMQX 节点在集群的唯一标识。node_status 表示 EMQX 节点的状态。otp_release 表示 EMQX 使用的 Erlang 的版本。version 表示 EMQX 版本。EMQX Operator 默认会拉起三个节点的 EMQX 集群，所以当集群运行正常时，可以看到三个运行的节点信息。如果你配置了 .spec.replicas 字段，当集群运行正常时，输出结果中显示的运行节点数量应和 replicas 的值相等。

kubectl get emqxenterprise emqx-ee -o json | jq ".status.emqxNodes"

输出类似于：

[
  {
    "node": "emqx-ee@emqx-ee-0.emqx-ee-headless.default.svc.cluster.local",
    "node_status": "Running",
    "otp_release": "24.3.4.2/12.3.2.2",
    "version": "4.4.14"
  },
  {
    "node": "emqx-ee@emqx-ee-1.emqx-ee-headless.default.svc.cluster.local",
    "node_status": "Running",
    "otp_release": "24.3.4.2/12.3.2.2",
    "version": "4.4.14"
  },
  {
    "node": "emqx-ee@emqx-ee-2.emqx-ee-headless.default.svc.cluster.local",
    "node_status": "Running",
    "otp_release": "24.3.4.2/12.3.2.2",
    "version": "4.4.14"
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 配置 Prometheus Monitor

PodMonitor 自定义资源定义 (CRD) 允许以声明方式定义应如何监视一组动态服务。使用标签选择来定义选择哪些服务以使用所需配置进行监视，其文档可以参考：PodMonitor (opens new window)

apiVersion: monitoring.coreos.com/v1
kind: PodMonitor
metadata:
  name: emqx
  namespace: default
  labels:
    app.kubernetes.io/name: emqx
spec:
  jobLabel: emqx-scraping
  namespaceSelector:
    matchNames:
    - default
  podMetricsEndpoints:
  - basicAuth:
      password:
        key: password
        name: emqx-basic-auth
      username:
        key: username
        name: emqx-basic-auth
    interval: 10s
    params:
      type:
      - prometheus
    path: /api/v5/prometheus/stats
    port: http-dashboard
    scheme: http
  selector:
    matchLabels:
      apps.emqx.io/instance: emqx

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

说明： path 表示指标采集接口路径，在 EMQX 5 里面路径为：/api/v5/prometheus/stats。selector.matchLabels 表示匹配 Pod 的 label： apps.emqx.io/instance: emqx。

apiVersion: monitoring.coreos.com/v1
kind: PodMonitor
metadata:
  name: emqx
  namespace: default
  labels:
    app.kubernetes.io/name: emqx
spec:
  jobLabel: emqx-scraping
  namespaceSelector:
    matchNames:
    - default
  podMetricsEndpoints:
  - basicAuth:
      password:
        key: password
        name: emqx-basic-auth
      username:
        key: username
        name: emqx-basic-auth
    interval: 10s
    params:
      type:
      - prometheus
    path: /api/v4/emqx_prometheus
    port: http-management
    scheme: http
  selector:
    matchLabels:
      apps.emqx.io/instance: emqx-ee

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

说明： path 表示指标采集接口路径，在 EMQX 4 里面路径为：/api/v4/emqx_prometheus。selector.matchLabels 表示匹配 Pod 的 label： apps.emqx.io/instance: emqx-ee。

ServiceMonitor 自定义资源定义 (CRD) 允许以声明方式定义应如何监视一组动态服务。使用标签选择来定义选择哪些服务以使用所需配置进行监视，其文档可以参考：ServiceMonitor (opens new window)

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: emqx
  namespace: default
  labels:
    app.kubernetes.io/name: emqx
spec:
  jobLabel: emqx-scraping
  namespaceSelector:
    matchNames:
    - default
  ServiceMetricsEndpoints:
  - basicAuth:
      password:
        key: password
        name: emqx-basic-auth
      username:
        key: username
        name: emqx-basic-auth
    interval: 10s
    params:
      type:
      - prometheus
    path: /api/v4/emqx_prometheus
    port: http-management-8081
    scheme: http
  selector:
    matchLabels:
      apps.emqx.io/instance: emqx-ee

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

说明： path 表示指标采集接口路径，在 EMQX 4 里面路径为：/api/v4/emqx_prometheus。selector.matchLabels 表示匹配 Service 的 label： apps.emqx.io/instance: emqx-ee。

将上述内容保存为：monitor.yaml 并执行如下命令：

kubectl apply -f monitor.yaml

使用 basicAuth 为 Monitor 提供访问 EMQX 接口需要密码账号信息

apiVersion: v1
kind: Secret
metadata:
  name: emqx-basic-auth
  namespace: default
type: kubernetes.io/basic-auth
stringData:
  username: admin
  password: public

1
2
3
4
5
6
7
8
9

将上述内容保存为：secret.yaml 并创建 Secret

kubectl apply -f secret.yaml

# 访问 Prometheus 查看 EMQX 集群的指标

打开 Prometheus 的界面，切换到 Graph 页面，输入 emqx 显示如下图所示：

切换到 Status → Targets 页面，显示如下图，可以看到集群中所有被监控的 EMQX Pod 信息：

← 配置 EMQX Service 常见问题 →