跳到主要内容
版本:dev

通过 Docker Compose 方式安装 HertzBeat

提示

推荐使用 Docker Compose 方式一键部署 HertzBeat 及其依赖服务。

备注

需您的环境中已经拥有 Docker 环境 和 Docker Compose 环境 ,若未安装请参考 Docker官网文档 执行命令 docker compose version 检查是否拥有 Docker Compose 环境。

  1. 下载启动脚本包

    下载地址 下载安装脚本包 apache-hertzbeat-xxx-docker-compose.tar.gz

  2. 选择使用 HertzBeat + PostgreSQL + VictoriaMetrics 方案

    提示
    • apache-hertzbeat-${version}-docker-compose.tar.gz 解压后包含多个部署方案,这里我们推荐选择 hertzbeat-postgresql-victoria-metrics 方案。
    • 其它部署方式请详细阅读各个部署方案的 README.md 文件, MySQL 方案需要自行准备 MySQL 驱动包。
    • 解压脚本包
    tar zxvf apache-hertzbeat-${version}-docker-compose.tar.gz
    • 进入解压目录, 选择 HertzBeat + PostgreSQL + VictoriaMetrics 一键部署
    cd apache-hertzbeat-${version}-docker-compose
    cd hertzbeat-postgresql-victoria-metrics
    • 创建 .env 文件并设置数据库密码

    POSTGRES_PASSWORD 为必填项,未设置时 docker compose up 会直接报错退出。

    cp .env.example .env
    # 编辑 .env,将 POSTGRES_PASSWORD 设置为你自己的强密码
    • 一键启动

    hertzbeat-postgresql-victoria-metrics 目录下执行以下命令

    docker-compose up -d
    • 查看服务状态

    查看各个容器的运行状态,up 为正常运行状态

    docker-compose ps
  3. 开始探索 HertzBeat 浏览器访问 http://localhost:1157/ 即可开始探索使用,默认账户密码 admin/hertzbeat。

    备注

    快速启动方案默认将所有宿主机端口绑定到 127.0.0.1,因此 Web 页面只能在运行 Docker 的本机访问。如需从其他主机访问,请在 .env 中把 HERTZBEAT_BIND_ADDRESS 设置为其他主机可达的地址(建议通过 TLS 反向代理开放,而不是直接使用 0.0.0.0 这类通配地址),然后执行 docker compose config 检查最终端口映射,再重新执行 docker compose up -d。该变量同时会开放 1158 供远程 Collector 连接;14317(OTLP/gRPC)由独立的 HERTZBEAT_OTLP_BIND_ADDRESS 控制。详见部署方案目录下的 README.md

HAVE FUN


部署常见问题

最多的问题就是容器网络问题,请先提前排查