elastic/heartbeat

Heartbeat Docker镜像文档

概述

Heartbeat是Elastic Stack的一部分，是一款轻量级主动监控工具，通过定期发送探测请求（如HTTP、TCP、ICMP等）检查服务可用性和响应时间。本Docker镜像是由Elastic官方维护的容器化部署方案，旨在简化Heartbeat的安装与配置，适用于各类环境的服务监控场景。

核心功能和特性

• 主动探测机制：定期向目标服务发送请求，实时监控可用性与响应时间
• 多协议支持：兼容HTTP、HTTPS、TCP、ICMP（ping）、DNS等多种协议
• 灵活的监控配置：支持自定义探测频率、超时阈值、重试策略
• Elastic Stack深度集成：原生支持将监控数据发送至Elasticsearch，并可通过Kibana实现可视化与告警
• 轻量级设计：资源占用低，适合边缘节点及容器化环境部署
• 配置持久化：支持外部挂载配置文件，实现自定义监控规则管理

使用场景和适用范围

• 服务健康监控：监控Web服务、API端点、数据库等核心服务的运行状态
• 网络服务可用性：检查TCP端口、网络设备、DNS解析等基础网络服务
• SLA合规监控：跟踪服务响应时间是否满足SLA要求
• 分布式系统监控：在微服务架构中监控跨服务调用的可用性
• DevOps自动化：与CI/CD流程集成，验证部署后服务是否正常运行

使用方法和配置说明

镜像拉取

从Elastic官方镜像仓库拉取指定版本（以8.11.3为例）：

bash
docker pull ***-elastic.xuanyuan.run/beats/heartbeat:8.11.3

基本使用方法

1. 快速启动（默认配置）

bash
docker run -d \
  --name heartbeat \
  --user=root \  # 部分探测（如ICMP）需root权限
  docker.elastic.co/beats/heartbeat:8.11.3

注意：默认配置需配合Elasticsearch使用，未配置时可能无法正常输出数据。

2. 挂载自定义配置文件

推荐通过外部配置文件定义监控规则，示例：

bash
docker run -d \
  --name heartbeat \
  --user=root \
  -v /host/path/to/heartbeat.yml:/usr/share/heartbeat/heartbeat.yml:ro \  # 挂载本地配置文件
  -v /host/path/to/data:/usr/share/heartbeat/data \  # 持久化数据目录（可选）
  docker.elastic.co/beats/heartbeat:8.11.3

3. Docker Compose集成示例

yaml
version: '3'
services:
  heartbeat:
    image: ***-elastic.xuanyuan.run/beats/heartbeat:8.11.3
    user: root
    volumes:
      - ./heartbeat.yml:/usr/share/heartbeat/heartbeat.yml:ro
      - ./data:/usr/share/heartbeat/data
    environment:
      - ELASTICSEARCH_HOSTS=http://elasticsearch:9200
      - KIBANA_HOST=http://kibana:5601
      - ELASTICSEARCH_USERNAME=elastic
      - ELASTICSEARCH_PASSWORD=changeme
    depends_on:
      - elasticsearch
      - kibana

  elasticsearch:
    image: ***-elastic.xuanyuan.run/elasticsearch/elasticsearch:8.11.3
    environment:
      - discovery.type=single-node
      - xpack.security.enabled=true
      - ELASTIC_PASSWORD=changeme
    ports:
      - "9200:9200"

  kibana:
    image: ***-elastic.xuanyuan.run/kibana/kibana:8.11.3
    environment:
      - ELASTICSEARCH_HOSTS=http://elasticsearch:9200
      - ELASTICSEARCH_USERNAME=elastic
      - ELASTICSEARCH_PASSWORD=changeme
    ports:
      - "5601:5601"
    depends_on:
      - elasticsearch

配置说明

核心配置文件（heartbeat.yml）

需重点配置以下参数（完整配置可参考https://www.elastic.co/guide/en/beats/heartbeat/current/heartbeat-configuration.html）：

yaml
heartbeat.monitors:
- type: http  # 监控类型（http/tcp/icmp等）
  urls: ["http://example.com"]  # 目标URL
  schedule: '@every 10s'  # 探测频率
  timeout: 5s  # 超时时间

output.elasticsearch:
  hosts: ["http://elasticsearch:9200"]  # Elasticsearch地址
  username: "elastic"
  password: "changeme"

setup.kibana:
  host: "http://kibana:5601"  # Kibana地址，用于导入仪表盘

环境变量配置

支持通过环境变量覆盖配置文件参数，常用变量：

• ELASTICSEARCH_HOSTS：Elasticsearch服务地址（逗号分隔）
• ELASTICSEARCH_USERNAME/ELASTICSEARCH_PASSWORD：Elasticsearch认证信息
• KIBANA_HOST：Kibana服务地址
• BEAT_NAME：自定义Beat实例名称
• HEARTBEAT_MONITORS：JSON格式的监控规则配置（覆盖heartbeat.monitors）

注意事项

• 权限要求：ICMP（ping）探测需容器具备CAP_NET_RAW权限，可通过--cap-add=NET_RAW参数添加
• 配置验证：启动前可通过docker run --rm ***-elastic.xuanyuan.run/beats/heartbeat:8.11.3 test config -e验证配置文件
• 版本兼容性：建议与Elasticsearch、Kibana使用相同版本，避免兼容性问题
• 数据持久化：挂载/usr/share/heartbeat/data目录可保存监控状态数据，防止容器重启后丢失上下文

更多详细配置与最佳实践请参考官方文档：
https://www.elastic.co/guide/en/beats/heartbeat/current/running-on-docker.html
https://www.docker.elastic.co