tykio/tyk-pump-docker-pub

Tyk Pump 官方Docker镜像

镜像概述和主要用途

Tyk Pump官方Docker镜像是Tyk API网关生态系统的核心组件，用于收集、处理Tyk API网关生成的API访问指标和性能数据，并将其导出到Prometheus、InfluxDB、Elasticsearch等多种监控和数据分析后端。该镜像提供容器化部署方式，确保与Tyk Gateway无缝集成，是构建Tyk API监控体系的关键工具。

核心功能和特性

• 多后端支持：兼容Prometheus、InfluxDB、Elasticsearch、MongoDB、Graphite等主流监控和存储系统，满足多样化数据导出需求。
• 无缝集成：与Tyk Gateway深度整合，可直接从Gateway的数据库（MongoDB/Redis）或实时流中采集指标数据。
• 灵活配置：支持通过配置文件或环境变量自定义指标采集频率、数据过滤规则及目标后端参数。
• 轻量级设计：基于精简基础镜像构建，资源占用低，适合在Kubernetes、Docker Compose等容器化环境中高效运行。
• 官方维护：由Tyk团队官方维护，确保与Tyk Gateway版本兼容及安全更新。

使用场景和适用范围

• API性能监控：实时采集API请求量、响应时间、错误率、带宽消耗等核心指标，监控Gateway运行状态。
• 监控系统集成：将API指标导入现有监控平台（如Prometheus+Grafana），实现统一监控视图与告警。
• 数据分析与报告：导出历史API使用数据至数据分析平台，生成API调用趋势、用户行为分析等业务报告。
• 合规审计：留存API访问日志，满足合规性要求，支持事后审计与问题追溯。

详细使用方法和配置说明

前提条件

• 已部署Tyk Gateway（建议与Pump版本匹配）。
• 目标监控后端（如Prometheus）已部署并可访问。

基础部署方式

1. 快速启动（默认配置）

bash
docker run -d --name tyk-pump \
  -p 9090:9090 \
  -e TYK_PMP_ANALYTICS_MONGO_URI=mongodb://mongo:27017/tyk_analytics \
  docker.xuanyuan.run/tykio/tyk-pump:latest

2. 自定义配置文件部署

通过挂载本地配置文件实现精细化配置：

bash
docker run -d --name tyk-pump \
  -p 9090:9090 \
  -v /path/to/local/pump.conf:/etc/tyk-pump/pump.conf \
  docker.xuanyuan.run/tykio/tyk-pump:latest

3. Docker Compose示例

yaml
version: '3'

services:
  tyk-pump:
    image: docker.xuanyuan.run/tykio/tyk-pump:latest
    container_name: tyk-pump
    restart: always
    ports:
      - "9090:9090"  # Prometheus导出端口
    environment:
      - TYK_PMP_LOG_LEVEL=info  # 日志级别：debug/info/warn/error
    volumes:
      - ./pump.conf:/etc/tyk-pump/pump.conf  # 挂载自定义配置文件
    depends_on:
      - mongo
      - tyk-gateway

  mongo:
    image: docker.xuanyuan.run/mongo:4.4
    container_name: tyk-mongo
    ports:
      - "27017:27017"
    volumes:
      - mongo-data:/data/db

  tyk-gateway:
    image: docker.xuanyuan.run/tykio/tyk-gateway:latest
    container_name: tyk-gateway
    # Tyk Gateway配置（略）

volumes:
  mongo-data:

核心配置说明

配置文件结构（pump.conf）

json
{
  "analytics_config": {  // 数据源配置
    "type": "mongo",  // 数据源类型：mongo或redis
    "mongo_url": "mongodb://mongo:27017/tyk_analytics",  // Gateway数据库地址
    "collection_name": "tyk_analytics"  // 指标数据集合名
  },
  "purge_delay": 30,  // 数据在内存中保留时间（秒）
  "pumps": {  // 导出后端配置
    "prometheus": {
      "enabled": true,
      "meta": {
        "listen_address": ":9090",  // Prometheus暴露端口
        "path": "/metrics"  // 指标访问路径
      }
    },
    "influxdb": {
      "enabled": false,
      "meta": {
        "address": "influxdb:8086",
        "database": "tyk_analytics",
        "username": "admin",
        "password": "secret"
      }
    }
  }
}

环境变量说明

常用环境变量（覆盖配置文件参数）：

生产环境注意事项

• 版本匹配：确保Pump与Gateway版本一致（如Gateway v5.0需搭配Pump v5.0），避免兼容性问题。
• 配置持久化：通过挂载卷（如-v ./pump.conf:/etc/tyk-pump/pump.conf）管理配置文件，便于修改和版本控制。
• 资源限制：根据数据量设置CPU/内存限制，避免影响指标采集稳定性。
• 监控Pump自身：建议监控Pump容器的运行状态及指标导出接口可用性。