
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具,协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题,请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可:
请先完整阅读并严格遵守以下文档中的全部规则与要求:
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前,不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式,不推荐豆包 AI;Cursor 等编辑器可在对话 @ 该链接,或加入 User Rules。 若 AI 无法访问外链,可 打开说明文档 复制全文粘贴。文档会随站点更新,复制内容可能过期,建议定期检查。
该镜像提供一个简单的Prometheus导出器,用于从Confluent Cloud Metrics API提取指标。默认情况下,导出器在2112端口暴露指标。使用Docker Compose启动时,可通过http://localhost:3000(用户名admin/密码admin)的Grafana仪表板查看指标。
适用于需要监控Confluent Cloud资源(如Kafka集群、连接器、ksqlDB应用、Schema Registry)的用户,可集成到Prometheus监控体系中,实现指标收集、存储和可视化。
使用导出器需指定以下环境变量:
CCLOUD_API_KEY: 通过ccloud api-key create --resource cloud创建的API密钥CCLOUD_API_SECRET: 对应的API密钥密码这些变量用于调用https://api.telemetry.confluent.cloud端点。
Usage of ./ccloudexporter: -cluster string 逗号分隔的集群ID列表,若未指定则使用环境变量CCLOUD_CLUSTER -config string 覆盖默认行为的配置文件路径 -connector string 逗号分隔的连接器ID列表,若未指定则使用环境变量CCLOUD_CONNECTOR -delay int 指标采集延迟(秒),默认120秒(避免临时数据点) -endpoint string Metrics API基础URL(默认"https://api.telemetry.confluent.cloud/") -granularity string 指标查询粒度,默认"PT1M"(1分钟) -ksqlDB string 逗号分隔的ksqlDB应用ID列表,若未指定则使用环境变量CCLOUD_KSQL -schemaRegistry string 逗号分隔的Schema Registry ID列表,若未指定则使用环境变量CCLOUD_SCHEMA_REGISTRY -listener string HTTP接口监听地址(默认":2112") -log-pretty-print JSON日志格式化输出(默认true) -no-timestamp 不将Metrics API的时间戳传递给Prometheus -timeout int Metrics API REST调用超时(秒),默认60 -verbose 输出跟踪级日志 -version 打印版本并退出
Docker运行
shelldocker run \ -e CCLOUD_API_KEY=$CCLOUD_API_KEY \ -e CCLOUD_API_SECRET=$CCLOUD_API_SECRET \ -e CCLOUD_CLUSTER=lkc-abc123 \ -p 2112:2112 \ dabz/ccloudexporter:latest
Docker Compose
shellexport CCLOUD_API_KEY=ABCDEFGHIKLMNOP export CCLOUD_API_SECRET=XXXXXXXXXXXXXXXX export CCLOUD_CLUSTER=lkc-abc123
shelldocker-compose up -d
Docker Compose环境包含:
admin/admin)Grafana已预配置Prometheus数据源和默认仪表板。Prometheus和Grafana使用数据卷持久化数据,执行docker-compose down --volumes可删除卷并重置数据。
Kubernetes部署
使用Prometheus Operator部署:
shellcp ./ccloud_exporter.env-template ./kubernetes/ccloud_exporter.env
shellcd ./kubernetes vim ./ccloud_exporter.env
shellmake install
部署内容包括:
删除部署:cd ./kubernetes && make remove
通过-config标志指定YAML配置文件实现高级部署,未指定时导出器将基于命令行标志生成配置。
全局配置
| 键 | 描述 | 默认值 |
|---|---|---|
| config.http.baseurl | Metrics API基础URL | [***] |
| config.http.timeout | REST调用超时(秒) | 60 |
| config.listener | HTTP接口监听地址 | :2112 |
| config.noTimestamp | 是否不传递时间戳给Prometheus | false |
| config.delay | 指标采集延迟(秒) | 120 |
| config.granularity | 指标查询粒度 | PT1M |
| rules | 指标采集规则列表 | - |
规则配置
| 键 | 描述 |
|---|---|
| rules.clusters | 要采集指标的Kafka集群列表 |
| rules.connectors | 要采集指标的连接器列表 |
| rules.ksqls | 要采集指标的ksqlDB应用列表 |
| rules.schemaRegistries | 要采集指标的Schema Registry ID列表 |
| rules.labels | 暴露给Prometheus的标签,用于查询分组 |
| rules.topics | 可选,用于过滤指标的主题列表 |
| rules.metrics | 要采集的指标列表 |
默认配置
yamlconfig: http: baseurl: https://api.telemetry.confluent.cloud/ timeout: 60 listener: 0.0.0.0:2112 noTimestamp: false delay: 60 granularity: PT1M rules: - clusters: - $CCLOUD_CLUSTER connectors: - $CCLOUD_CONNECTOR ksqls: - $CCLOUD_KSQL schemaRegistries: - $CCLOUD_SCHEMA_REGISTRY metrics: - io.confluent.kafka.server/received_bytes - io.confluent.kafka.server/sent_bytes - io.confluent.kafka.server/received_records - io.confluent.kafka.server/sent_records - io.confluent.kafka.server/retained_bytes - io.confluent.kafka.server/active_connection_count - io.confluent.kafka.server/request_count - io.confluent.kafka.server/partition_count - io.confluent.kafka.server/successful_authentication_count - io.confluent.kafka.connect/sent_bytes - io.confluent.kafka.connect/received_bytes - io.confluent.kafka.connect/received_records - io.confluent.kafka.connect/sent_records - io.confluent.kafka.connect/dead_letter_queue_records - io.confluent.kafka.ksql/streaming_unit_count - io.confluent.kafka.schema_registry/schema_count labels: - kafka_id - topic - type
配置文件示例
为避免达到Confluent Cloud Metrics API的1000点限制,导出器设置以下软限制:
clusters、labels和metricsGrafana仪表板位于./grafana/文件夹。
历史版本中,导出器和Metrics API使用cluster_id标签标识集群。Metrics API V2中该标签已重命名为resource.kafka.id,导出器现在使用kafka_id标签。为兼容旧仪表板,导出器暂时同时暴露cluster_id和kafka_id。
早期版本支持用户名/密码认证,现在官方仅支持API密钥/密钥认证。为保持向后兼容,旧环境变量仍可用,但强烈建议迁移至API密钥/密钥。
通过Docker Compose集成Splunk,包含:
运行方法
shelldocker-compose up --build -f ./integration/splunk/docker-compose.yaml
访问Splunk分析工作区:http://localhost:***/en-US/app/search/analytics_workspace
有关使用ccloudexporter的教程及故障场景指标展示,请参阅Confluent Cloud的Apache Kafka®客户端可观测性教程。
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本,请访问 标签列表页面。
来自真实用户的反馈,见证轩辕镜像的优质服务