部署文档

版本号	修改	修改时间	备注
v1.0.0	王小琱	2024.12.20	首版

1. 项目简介

exchange-market-agg-backend 是一个基于 Go 语言开发的微服务，主要用于聚合市场行情、K线数据处理与推送，支持多种交易对和周期，适用于交易所、金融等对市场数据有高性能需求的业务场景。系统支持对接 MySQL 数据库、RabbitMQ 消息队列、Redis 缓存等基础设施。

2. 环境要求

• Go 版本：1.21 及以上
• Docker：20.10 及以上
• 数据库：MySQL 8.x（或兼容版本）
• 消息队列：RabbitMQ 3.x（或兼容版本）
• 缓存：Redis 6.x（或兼容版本）

3. 部署方式

3.1 本地部署

3.1.1 下载代码

git clone https://gitlab.atom8.io/hkbitex/exchange-market-agg-backend.git
cd exchange-market-agg-backend

3.1.2 安装依赖

# 安装 protoc 工具
make init

# 更新依赖
make tidy

3.1.3 编译代码

make build

3.1.4 配置说明

环境变量	类型	是否必填	说明
APP_LOG_LEVEL	string	可选，默认info	日志级别（trace、debug、info、warn、error、fatal）
SERVER_HOST	string	必填	服务监听地址（如 0.0.0.0:8080）
METRICS_SWITCH	string	必填	metrics 开关，on：启用，off：关闭
METRICS_HOST	string	必填	metrics 服务监听地址（如 0.0.0.0:18080）
MYSQL_READ	string	必填	MySQL 读库 DSN，例如：user:password@tcp(host:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local
MYSQL_WRITE	string	必填	MySQL 写库 DSN（同上）
RABBITMQ_URIS	string	必填	RabbitMQ URI，多个用英文逗号分隔
REDIS_URI	string	必填	Redis 连接 URI
REDIS_PASSWORD	string	可选	Redis 密码
REDIS_DB	string	必填	Redis 数据库编号
RPC_SERVER_CURRENCY	string	必填	货币服务 RPC 地址
RPC_SERVER_ORDER	string	必填	订单服务 RPC 地址
RPC_SERVER_ORDER_MGR	string	必填	订单管理服务 RPC 地址
RABBITMQ_DEFAULT_EXCHANGE	string	必填	RabbitMQ 默认 Exchange 名称
RABBITMQ_DEAL_EXCHANGE	string	必填	RabbitMQ 成交 Exchange 名称
RABBITMQ_BOOK_EXCHANGE	string	必填	RabbitMQ 盘口 Exchange 名称

3.1.5 启动服务

创建 Systemd 文件 /etc/systemd/system/market-agg.service：

[Unit]
Description=exchange-market-agg-backend
After=network.target

[Service]
WorkingDirectory=/app/market-agg
Type=simple
User=root
ExecStart=/app/market-agg/market-agg
StandardOutput=append:/app/market-agg/logs/output.log
StandardError=append:/app/market-agg/logs/error.log
Restart=on-failure
EnvironmentFile=/app/market-agg/.env

[Install]
WantedBy=multi-user.target

重载并启动服务：

# 创建必要的目录
mkdir -p /app/market-agg/logs

# 复制配置文件
cp .env.default /app/market-agg/.env
cp market-agg /app/market-agg/

# 启动服务
systemctl daemon-reload
systemctl start market-agg
systemctl enable market-agg

# 检查服务状态
systemctl status market-agg

3.2 Docker部署（推荐生产环境）

3.2.1 下载代码

git clone https://gitlab.atom8.io/hkbitex/exchange-market-agg-backend.git
cd exchange-market-agg-backend

3.2.2 编译代码

make docker

3.2.3 环境变量

在项目根目录创建 .env 文件（内容同上），或直接通过 Docker -e 方式传入。

3.2.4 启动服务

docker run -d \
  --name exchange-market-agg-backend \
  --env-file .env \
  -p 8080:8080 \
  registry.example.com/exchange-market-agg-backend:latest

4. 数据库配置

• 配置黑/白名单IP（可选）
• 配置禁止国家列表（可选）

5. 日志配置

5.1 日志位置

• 默认日志输出：/app/market-agg/logs/
• 日志文件：
  • output.log：标准输出日志
  • error.log：错误日志

5.2 日志级别

• 可通过 .env 配置（如 info、debug、error等）
• 建议生产环境使用 info 级别

6. 监控配置

• Metrics 端点（Prometheus 可用）： http://127.0.0.1:18080/metrics

• 建议接入 Grafana 进行可视化监控

7. 其他说明

• 如需对接外部服务（如行情源、推送服务等），请参考各自的接入文档。
• 如有问题，请联系负责人。