Vitess pmm-client 镜像文档

1. 镜像概述和主要用途

Vitess pmm-client 镜像是一个预配置的客户端工具，用于集成 Vitess 数据库集群与 Percona Monitoring and Management (PMM) 平台。该镜像提供了收集、处理和发送 Vitess 集群性能指标和查询数据到 PMM 服务器的功能，帮助用户实现对 Vitess 部署的全面监控和性能分析。

2. 核心功能和特性

• 自动发现 Vitess 集群组件（包括 vtgate、vttablet、etcd 等）
• 收集关键性能指标（查询延迟、吞吐量、连接数、缓存命中率等）
• 支持慢查询日志收集和分析
• 与 PMM 服务器无缝集成
• 预配置的监控模板和仪表板
• 轻量级资源占用
• 支持自定义监控配置

3. 使用场景和适用范围

适用场景

• Vitess 集群的实时性能监控
• 数据库性能问题诊断和优化
• 容量规划和资源利用分析
• 历史性能趋势分析
• SLA 合规性监控

适用范围

• 生产环境中的 Vitess 集群部署
• 开发和测试环境中的 Vitess 性能评估
• 混合云或多云环境中的 Vitess 监控
• 从小型到大型企业级 Vitess 部署

4. 使用方法和配置说明

4.1 前提条件

• 运行中的 PMM 服务器
• 可访问的 Vitess 集群
• Docker 引擎 1.12+ 或 Kubernetes 集群

4.2 基本使用（Docker Run）

docker run -d \
  --name vitess-pmm-client \
  --restart always \
  -e PMM_SERVER=your-pmm-server:443 \
  -e PMM_USER=admin \
  -e PMM_PASSWORD=your-password \
  -e VITESS_CTL=vtctl:15999 \
  -e VITESS_CLUSTER=my-vitess-cluster \
  --network vitess-network \
  vitess/pmm-client

4.3 Docker Compose 配置

version: '3'

services:
  vitess-pmm-client:
    image: vitess/pmm-client
    container_name: vitess-pmm-client
    restart: always
    environment:
      - PMM_SERVER=your-pmm-server:443
      - PMM_USER=admin
      - PMM_PASSWORD=your-password
      - PMM_INSECURE_SKIP_TLS_VERIFY=true
      - VITESS_CTL=vtctl:15999
      - VITESS_CLUSTER=my-vitess-cluster
      - COLLECTION_INTERVAL=10s
      - LOG_LEVEL=info
    networks:
      - vitess-network
    depends_on:
      - vtctl
      - vtgate

networks:
  vitess-network:
    external: true

4.4 Kubernetes 部署

apiVersion: apps/v1
kind: Deployment
metadata:
  name: vitess-pmm-client
  namespace: vitess
spec:
  replicas: 1
  selector:
    matchLabels:
      app: vitess-pmm-client
  template:
    metadata:
      labels:
        app: vitess-pmm-client
    spec:
      containers:
      - name: vitess-pmm-client
        image: vitess/pmm-client
        env:
        - name: PMM_SERVER
          value: "pmm-server.pmm:443"
        - name: PMM_USER
          valueFrom:
            secretKeyRef:
              name: pmm-credentials
              key: username
        - name: PMM_PASSWORD
          valueFrom:
            secretKeyRef:
              name: pmm-credentials
              key: password
        - name: VITESS_CTL
          value: "vtctl:15999"
        - name: VITESS_CLUSTER
          value: "my-vitess-cluster"

4.5 环境变量配置

4.6 自定义配置

如需自定义监控配置，可以通过挂载配置文件实现：

docker run -d \
  --name vitess-pmm-client \
  -v /path/to/custom/configs:/etc/pmm-client/custom-configs \
  -e PMM_SERVER=your-pmm-server:443 \
  -e PMM_USER=admin \
  -e PMM_PASSWORD=your-password \
  -e VITESS_CTL=vtctl:15999 \
  vitess/pmm-client

4.7 验证部署

检查客户端状态：

docker exec -it vitess-pmm-client pmm-admin status

查看日志：

docker logs -f vitess-pmm-client

5. 故障排除

5.1 常见问题

1. 无法连接到 PMM 服务器

   • 检查 PMM_SERVER 环境变量是否正确
   • 验证网络连接和防火墙设置
   • 确认 PMM 服务器是否正常运行

2. Vitess 集群未被发现

   • 验证 VITESS_CTL 环境变量配置
   • 检查 vtctl 服务是否可访问
   • 确认 Vitess 集群状态正常

3. 指标缺失

   • 检查日志中的错误信息
   • 验证 Vitess 用户权限
   • 确认收集间隔设置是否适当

5.2 日志位置

容器内日志路径：/var/log/pmm-client.log

可通过以下命令查看：

docker exec -it vitess-pmm-client tail -f /var/log/pmm-client.log

6. 版本信息

• 最新稳定版本: v2.34.0
• 支持的 Vitess 版本: 12.0+、13.0+、14.0+、15.0+
• 支持的 PMM 服务器版本: 2.28.0+

7. 维护和更新

建议定期更新镜像以获取最新功能和安全修复：

docker pull vitess/pmm-client
docker stop vitess-pmm-client
docker rm vitess-pmm-client
# 然后使用原始 run 命令重新启动容器