必须集成第三方监控系统实现workbuddy运行状态可观测性,推荐通过四种方式对接prometheus:一、exporter暴露指标端点;二、sidecar容器注入采集逻辑;三、pushgateway临时上报批处理指标;四、servicemonitor声明式自动发现。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在安装WorkBuddy时需要实现运行状态的可观测性,则必须将第三方监控系统集成到其部署流程中。Prometheus作为主流开源监控方案,可通过多种方式与WorkBuddy对接。以下是具体接入方法:
一、通过Exporter暴露指标端点
WorkBuddy本身不内置指标暴露能力,需借助兼容OpenMetrics规范的Exporter组件,将其内部运行指标(如HTTP请求数、队列长度、JVM内存使用等)以/text/plain格式暴露为Prometheus可抓取的HTTP端点。
1、下载适用于WorkBuddy版本的官方或社区维护的Java应用Exporter(例如jmx_exporter或micrometer-registry-prometheus)。
2、将Exporter JAR包放置于WorkBuddy启动目录,并修改其配置文件,指定要采集的MBean路径或Micrometer MeterRegistry配置项。
3、在WorkBuddy的JVM启动参数中添加-javaagent选项,指向Exporter JAR并加载对应配置文件,例如:-javaagent:/path/to/jmx_exporter.jar=8080:/path/to/config.yaml。
4、重启WorkBuddy服务,验证端点是否生效:curl http://localhost:8080/metrics,确认返回内容包含# TYPE开头的指标行且无HTTP 404或500错误。
5、在Prometheus主配置文件prometheus.yml中,于scrape_configs下新增job,target填写WorkBuddy所在主机IP与Exporter端口,例如targets: ['192.168.1.100:8080']。
二、通过Sidecar容器注入指标采集逻辑
在Kubernetes环境中部署WorkBuddy时,可采用Sidecar模式将指标采集逻辑与主应用解耦,避免修改原始镜像或JVM参数,提升部署灵活性与安全性。
1、构建一个轻量级Prometheus exporter容器镜像,该镜像内嵌脚本定期调用WorkBuddy提供的健康检查API或JMX远程接口,并将结果转换为Prometheus格式输出至本地端口。
2、编写Deployment YAML,在同一Pod中定义两个容器:主容器为WorkBuddy镜像,Sidecar容器为上述Exporter镜像。
3、为Sidecar容器设置containerPort,并在Pod级别配置readinessProbe指向该端口,确保Prometheus仅在指标端点就绪后开始抓取。
4、在Prometheus配置中,将scrape目标设为Kubernetes服务发现模式,通过serviceMonitor或podMonitor CRD匹配带有特定label(如app: workbuddy)的Pod。
5、应用YAML并确认Prometheus Targets页面中对应实例状态为UP,且Labels字段包含job="workbuddy-sidecar"。
WorkBuddy 桌宠工厂 —— 给一张角色图、一个 codex.pet 链接、一条 codex-pets.net 下载 URL、或一份现成的精灵表,就能自动创建一只可联动 WorkBuddy 状态的桌面宠物。当用户说"创建桌宠"、"做一只桌宠"、"用这张图做桌宠"、"从 codex.pet 安装桌宠"、"导入 codex 桌宠 XX"、"装一下 codex-pets.net 上的 XX&quo
三、通过Pushgateway临时上报批处理指标
当WorkBuddy存在大量短生命周期任务(如定时调度Job),无法维持长期HTTP端点供Prometheus拉取时,可利用Pushgateway作为指标中转站,由任务执行完毕后主动推送瞬时指标。
1、独立部署Pushgateway服务,确保其监听端口(默认9091)对WorkBuddy所在网络可达。
2、在WorkBuddy的任务代码中引入Prometheus client库(如io.prometheus:simpleclient_pushgateway),构造Counter或Gauge对象。
3、任务结束前调用pushAdd()方法,传入Pushgateway地址、作业名称(如workbuddy_batch_job)及唯一实例标识(如UUID或时间戳)。
4、在Prometheus配置中添加static_configs条目,target指向Pushgateway地址,job_name设为pushgateway。
5、访问Pushgateway UI(http://pushgateway-host:9091),确认对应job下已显示最新推送的指标及其值,且timestamp为最近一分钟内。
注意:Pushgateway不适用于高基数或高频更新场景,需配合清理策略(如使用curl -X DELETE)防止指标堆积
四、通过ServiceMonitor声明式配置自动发现
在启用Prometheus Operator的集群中,无需手动编辑prometheus.yml,而是通过Kubernetes原生资源ServiceMonitor描述WorkBuddy服务的监控意图,由Operator自动同步至Prometheus实例。
1、确保集群中已安装Prometheus Operator,并确认其ClusterRoleBinding允许读取命名空间内的Service与Endpoints资源。
2、创建Service资源,将WorkBuddy Pod的指标端口(如9090)映射为ClusterIP类型服务,并添加标签prometheus.io/scrape: "true"。
3、编写ServiceMonitor YAML,spec.selector.matchLabels与Service标签一致,endpoints.port指定指标暴露端口,interval设置为抓取间隔(如30s)。
4、将ServiceMonitor资源应用至与Prometheus实例相同的命名空间(通常为monitoring),并确认其status.conditions中type为"Valid"且status为"True"。
5、进入Prometheus Web UI的Status > Service Discovery页面,查找对应ServiceMonitor名称下的Target列表,确认状态为UP且Labels包含service="workbuddy-metrics"。










