newrelic/k8s-apm-agent-health-sidecar

APM代理健康状态检索边车镜像

镜像概述

本镜像为Kubernetes环境下的边车（Sidecar）容器，专门用于实时检索和监控APM（应用性能监控）代理的健康状态。通过与主应用容器协同部署，可帮助运维团队及时掌握APM代理的运行状态，确保应用性能数据采集的连续性和可靠性。

核心功能和特性

• 健康状态检索：支持周期性查询APM代理的健康检查接口，获取运行状态指标
• K8s原生集成：作为边车容器与主应用共享网络命名空间，无需额外网络配置
• 轻量级设计：镜像体积小（<50MB），资源占用低（CPU<10m，内存<32Mi），不影响主应用性能
• 多代理兼容：适配主流APM代理（如Elastic APM、Datadog APM、New Relic APM等）的健康检查规范
• 状态输出接口：提供HTTP端点（默认:8080/health）暴露检索结果，支持Prometheus等监控系统采集

使用场景和适用范围

• K8s环境APM部署：在已集成APM代理的Kubernetes Pod中作为辅助容器部署
• 代理监控需求：需要实时确认APM代理是否正常运行、数据是否正常上报的场景
• 性能数据保障：确保APM代理故障时可及时触发告警，避免性能数据丢失
• DevOps/SRE工作流：融入监控告警体系，支持自动恢复或通知机制（如与K8s liveness/readiness探针结合）

使用方法和配置说明

部署准备

1. 确保Kubernetes集群版本≥1.18（支持边车容器标准部署）
2. APM代理已部署并暴露健康检查接口（通常为HTTP或gRPC协议）

配置参数

通过环境变量进行配置，支持以下参数：

Kubernetes部署示例

以下为在Deployment中集成边车容器的配置示例：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: app-with-apm
spec:
  replicas: 3
  template:
    spec:
      containers:
      - name: main-app
        image: your-main-app:latest
        ports:
        - containerPort: 8080
        # 主应用配置...
      - name: apm-health-sidecar
        image: [镜像名称]:[版本标签]
        env:
        - name: APM_AGENT_HOST
          value: "localhost"  # 与主应用共享网络时使用localhost
        - name: APM_AGENT_PORT
          value: "8200"       # APM代理实际健康检查端口
        - name: CHECK_INTERVAL
          value: "15"         # 每15秒检查一次
        ports:
        - containerPort: 8080  # 暴露状态输出端口
        resources:
          limits:
            cpu: 50m
            memory: 64Mi
          requests:
            cpu: 10m
            memory: 32Mi

本地测试命令

如需本地验证镜像功能，可使用以下Docker命令：

bash
docker run -d \
  -e APM_AGENT_HOST=apm-agent-service \
  -e APM_AGENT_PORT=8200 \
  -e CHECK_INTERVAL=5 \
  -p 8080:8080 \
  [镜像名称]:[版本标签]

访问http://localhost:8080/health可查看检索到的APM代理健康状态，返回格式示例：

json
{
  "status": "healthy",
  "agent": "elastic-apm",
  "last_check": "2023-11-01T12:34:56Z",
  "metrics": {
    "active_spans": 42,
    "error_rate": 0.02
  }
}

注意事项

• 确保APM代理已正确配置健康检查接口，且与边车容器的网络可达
• 根据APM代理类型调整HEALTH_CHECK_PATH参数（如Datadog APM默认使用/live）
• 生产环境建议配置资源限制，避免极端情况下影响主应用
• 可结合K8s liveness探针（livenessProbe）监控边车自身健康状态，配置示例：

  yaml
  livenessProbe:
    httpGet:
      path: /self-health
      port: 8080
    initialDelaySeconds: 10
    periodSeconds: 5