couchbase/exporter

Couchbase Prometheus Exporter 技术文档

1. 镜像概述和主要用途

Couchbase Prometheus Exporter 是一个用于与 Prometheus 集成的组件，提供对 Couchbase Server 指标的原生收集和暴露能力。作为 Couchbase Autonomous Operator 的一部分，它通过 sidecar 容器模式部署在 Kubernetes 环境中，实现与 Prometheus 监控平台的无缝对接，满足 Couchbase 集群的指标采集需求。

2. 核心功能和特性

2.1 原生 Prometheus 集成

提供与 Prometheus 的原生集成能力，支持标准 Prometheus 指标格式，可直接被 Prometheus Server 发现和采集。

2.2 Sidecar 容器部署

通过 Couchbase Autonomous Operator 注入为 sidecar 容器，与 Couchbase Server 容器共存在同一 Pod 中，实现近距离指标采集，降低网络开销。

2.3 与 CouchbaseCluster 配置联动

支持通过 CouchbaseCluster 自定义资源（CR）配置启用和管理，无需手动部署，由 Autonomous Operator 自动维护生命周期。

2.4 指标全面覆盖

收集并暴露 Couchbase Server 核心指标，包括集群健康状态、节点性能、桶（Bucket）统计信息、操作延迟等关键监控数据。

3. 使用场景和适用范围

3.1 使用场景

• Kubernetes 环境中 Couchbase 集群的监控指标采集
• 基于 Prometheus + Grafana 构建 Couchbase 可视化监控面板
• 实现 Couchbase 集群性能瓶颈分析、异常告警和趋势预测

3.2 适用范围

• 仅支持与 Couchbase Autonomous Operator 企业版配合使用
• 适用于 Kubernetes 集群中部署的 Couchbase Server 集群
• 支持预生产环境（开发、测试）和生产环境（需符合许可要求）

4. 使用方法和配置说明

4.1 前置条件

• 已部署 Couchbase Autonomous Operator 企业版
• 已部署 Prometheus Server（建议使用官方推荐版本）
• 熟悉 Kubernetes 自定义资源（CR）配置

4.2 启用指标收集

通过修改 CouchbaseCluster CR 配置，指定 Prometheus Exporter 镜像并启用指标收集。示例配置片段如下：

yaml
apiVersion: couchbase.com/v2
kind: CouchbaseCluster
metadata:
  name: my-couchbase-cluster
spec:
  monitoring:
    prometheus:
      enabled: true
      image: couchbase/exporter:latest  # 替换为实际使用的 Exporter 镜像版本

4.3 配置参数说明

4.4 详细配置参考

完整配置说明及进阶用法请参见官方文档：
Couchbase Prometheus 集成指南

5. 许可信息

5.1 使用限制

Couchbase Prometheus Exporter 仅可与 Couchbase Autonomous Operator 企业版配合使用，不支持独立部署或与其他 Operator 版本搭配。

5.2 许可条款

• 免费用于无限的预生产环境（开发、测试），无需额外授权
• 生产环境使用需遵守 Couchbase 许可协议，详情参见 Couchbase ***协议 中的“License Agreement”
• 技术支持仅通过 Couchbase 官方论坛提供，预生产环境无商业支持服务