oceanbase/obagent

obagent 镜像文档

镜像概述和主要用途

obagent 镜像提供查询 OceanBase 指标信息的能力，通常作为 observer 组件的 sidecar 容器部署。通过部署 Prometheus 服务器从所有 obagent 实例拉取数据，可实现对 OceanBase 集群的监控。该镜像需与 ob-operator 配合使用，通过 ob-operator 实现自动化部署和管理。

核心功能和特性

• 指标查询能力：支持查询 OceanBase 集群的各类监控指标信息。
• Sidecar 部署模式：作为 observer 的 sidecar 容器运行，与 OceanBase 集群组件紧密集成。
• Prometheus 集成：兼容 Prometheus 数据拉取机制，支持 Prometheus 服务器从 obagent 实例采集监控数据。
• ob-operator 协同：与 ob-operator 无缝协作，通过配置 obcluster 资源实现自动化部署。

使用场景和适用范围

• OceanBase 集群监控：适用于需要对 OceanBase 集群进行指标监控的场景。
• ob-operator 管理环境：主要用于由 ob-operator 管理的 OceanBase 集群，依赖 ob-operator 完成部署配置。

使用方法和配置说明

前提条件

• 已部署 ob-operator，用于管理 OceanBase 集群资源。
• 已创建 obcluster 自定义资源，用于定义 OceanBase 集群配置。

配置步骤

1. 配置 obcluster 资源
   在 obcluster 资源的 spec 部分添加监控配置，指定启用 obagent 监控：

   yaml
   apiVersion: oceanbase.oceanbase.com/v1alpha1
   kind: OBCluster
   metadata:
     name: example-obcluster
   spec:
     # 其他集群配置（如集群规模、资源限制等）
     monitor:
       enabled: true  # 启用监控功能
       agent:
         image: obagent:latest  # 指定 obagent 镜像版本
   

2. 部署与管理
   配置完成后，ob-operator 将自动在每个 observer Pod 中部署 obagent 作为 sidecar 容器，并完成相关参数配置，确保 Prometheus 可从 obagent 实例拉取指标数据。

注意事项

• 需确保 obagent 镜像版本与 ob-operator 及 OceanBase 集群版本兼容。
• Prometheus 服务器需正确配置服务发现规则，以从所有 obagent 实例（通常通过 Kubernetes Service 暴露）拉取指标数据。