OpenFlare

简体中文

English

简体中文

English

主题

故障排查 ​

你会学到：如何按症状排查 OpenFlare Server、数据库、登录、Agent、OpenResty 和配置发布问题。

排查时先确认问题发生在哪一层：浏览器、Server、数据库、Agent、OpenResty、源站或 DNS。OpenFlare 的配置不会直接在线写入所有节点，只有激活版本变化后，Agent 才会在 heartbeat 中发现并应用。

快速定位 ​

现象先看哪里
管理端打不开Server 容器或进程日志、端口监听
登录异常默认账号、Session Cookie、Server 日志
数据无法保存数据库连接、SQLite 文件权限、PostgreSQL 健康状态
Agent 离线Agent 日志、Token、Server 地址、网络连通性
发布后节点未更新激活版本、节点 heartbeat、应用记录
OpenResty 应用失败应用记录、Agent 日志、证书、上游地址、端口占用
访问分析无数据OpenResty 容器状态、观测端口、Agent 补报日志
静态资源总不命中缓存全局/站点缓存开关、策略扩展名、配置是否已发布、访问日志 cache_status、源站 Set-Cookie / Cache-Control

Server 无法启动 ​

  1. 查看日志：
bash
docker compose logs -n 200 openflare

源码运行时查看终端输出。

  1. 检查端口占用：
bash
lsof -i :3000
  1. 如果使用 PostgreSQL，确认数据库健康：
bash
docker compose ps postgres
docker compose logs -n 100 postgres
  1. 如果使用 SQLite，确认数据库文件目录可写：
bash
ls -ld "$(dirname /path/to/openflare.db)"

常见原因：

日志或现象处理
数据库连接失败检查 DB_HOST、DB_PORT、DB_USERNAME、DB_PASSWORD、DB_NAME、DB_SSL_MODE 是否一致
SQLite 无法创建文件检查 SQLITE_PATH 所在目录是否存在且可写
端口被占用修改 PORT 或 --port，或停止占用端口的进程

管理端打不开或空白 ​

  1. 确认 Server 正在监听：
bash
curl -I http://127.0.0.1:3000
  1. 检查浏览器访问地址是否与反向代理配置一致。

默认账号无法登录 ​

默认账号是 admin / 12345678。首次登录后如果已经修改密码，应使用修改后的密码。

排查步骤：

  1. 确认连接的是预期数据库，避免 SQLITE_PATH 或 DB_HOST / DB_NAME 指向了另一个环境。
  2. 查看 Server 日志中使用的是 sqlite 还是 postgres。
  3. 在浏览器开发者工具中确认管理端 API 请求已正确携带 Session Cookie。
  4. 清理浏览器缓存及 Cookie 后重新登录。

应急重置管理员密码 ​

忘记 admin 账户密码时，使用 reset-passwd 命令重置（支持 SQLite 与 PostgreSQL）：

bash
go run main.go reset-passwd --user admin --password your-new-password

若使用 SQLite，建议先停止 Server 进程再执行，避免数据库文件锁冲突。未指定 --password 时命令会生成随机密码并输出到终端。重置成功后请立即登录并修改密码。

Agent 无法注册或一直离线 ​

在 Agent 节点执行：

bash
curl -I http://your-server:3000

查看 Agent 日志：

bash
journalctl -u openflare-agent -n 200 --no-pager

检查配置文件：

bash
sed -n '1,160p' /opt/openflare-agent/agent.json

重点确认：

配置说明
server_url必须是 Agent 节点能访问的 Server 地址
agent_token / discovery_token至少填写一个
heartbeat_interval支持毫秒整数或 Go duration 字符串
request_timeout网络较慢时可适当增大

如果日志提示 Token 无效，重新在管理端准备 Token 并更新 agent.json，然后重启：

bash
systemctl restart openflare-agent

发布后节点没有应用新版本 ​

按顺序检查：

  1. 版本页面中是否已经激活目标版本。
  2. 节点是否在线，最近心跳时间是否更新。
  3. 应用记录中是否有目标版本的成功、警告或失败记录。
  4. 网站配置是否启用；未启用的网站不会参与发布渲染。
  5. Agent 日志是否出现拉取、校验、reload 或回滚信息。

查看 Agent 日志：

bash
journalctl -u openflare-agent -f

注意：某个目标 version + checksum 一旦应用失败并回退，Agent 会在本地状态中阻断该目标重复应用。修正配置后需要重新发布生成新的 checksum，或激活旧版本回滚。

如果这是 Agent 首次应用配置，且本地没有历史 nginx.conf 可回滚，失败目标仍会被阻断，但 Agent 会尝试进入安全兜底运行态。此时应用记录和 Agent 日志会包含 fallback runtime started，OpenResty 对外只监听 80 端口并统一返回 503 与 OpenFlare: No Valid Configuration，同时保留本地 stub_status 健康检查入口。修正配置并重新发布新版本后，Agent 会覆盖兜底配置并恢复正常代理。

OpenResty 应用失败 ​

常见原因：

原因排查
域名或 server 块冲突检查同一域名是否被多个网站配置使用
上游地址不合法确认所有上游都是 http:// 或 https://
多上游格式不符合约束多上游必须是纯 scheme://host[:port]
证书缺失或路径错误检查域名是否绑定证书，以及 Agent 证书目录是否可写
端口被占用检查本机 80、443 端口

OpenResty 配置校验：

bash
openresty -t -c /path/to/openflare/data/etc/nginx/nginx.conf

OpenResty 运行状态：

bash
ps aux | grep openresty

Agent 周期性健康检查通过本地 http://127.0.0.1:<openresty_observability_port>/openflare/stub_status 判断 OpenResty 是否存活，不会反复执行 openresty -t。如果节点被标记为 unhealthy，优先确认该本地观测端口是否正在监听；如果只在应用配置时出现 host not found in upstream，说明失败来自配置校验或 reload，而不是周期性健康探针。

实际二进制路径和主配置路径以 agent.json 中的 openresty_path 与 main_config_path 为准。

HTTPS 不生效 ​

  1. 确认证书已经上传或托管。
  2. 确认网站配置中对应域名已经绑定证书。
  3. 确认发布并激活了新版本。
  4. 查看应用记录是否成功。
  5. 用 curl 查看证书和状态码：
bash
curl -Iv https://your-domain

没有绑定证书的域名不会被自动加入 HTTPS 配置，这是预期行为。

访问分析没有数据 ​

  1. 确认节点已经成功应用包含观测 Lua 资源的配置。
  2. 确认 OpenResty 正在运行。
  3. 查看 Agent 日志是否有观测采集或补报失败信息。
  4. 检查 openresty_observability_port 是否被占用，默认是 18081。
  5. 确认 Server 侧没有因数据库清理策略删除对应时间窗口数据。

边缘缓存命中率异常 ​

访问日志中缓存三态：命中（HIT/STALE/REVALIDATED/UPDATING）、回源（MISS/EXPIRED）、未缓存（BYPASS 或空，请求时未进入可缓存路径或响应未入库）。设计说明见 边缘缓存策略设计。

检查清单 ​

  1. 性能设置 中全局 OpenResty 缓存已开启。
  2. 站点 缓存 已启用，策略与路径匹配（「标准静态资源」只覆盖内置扩展名，不含 HTML/JSON；.js.map 的扩展名是 map，在默认表内）。
  3. 已 发布并激活 配置版本，对应节点应用记录成功（改缓存规则不发布则节点仍用旧旁路逻辑）。
  4. 请求方法为 GET（非 GET 一律不缓存）。
  5. 源站未对目标 URL 返回 Set-Cookie（有则不会写入边缘）。
  6. 源站未声明 Cache-Control: private / no-store（共享缓存不会存）。
  7. 浏览器 DevTools「禁用缓存」只影响浏览器；边缘是否 HIT 看访问日志 cache_status，不要只看 Network 面板。

常见误解 ​

现象说明
登录后全是「未缓存」且从未发布新版本旧配置曾因会话 Cookie 旁路；升级后须重新发布节点配置
static 下 /api/foo 或 /index.html 未缓存预期行为（扩展名不在默认可缓存表）
策略为 all 后 HTML 被串用户源站未禁止共享缓存；改回 static 或给动态响应加 private/no-store
带 ?v= 的 URL 命中率低默认缓存键含完整 $request_uri，query 不同即不同对象
第一次 MISS、第二次仍 MISS查源站是否每次 Set-Cookie、是否 private，或节点磁盘/缓存 inactive 过短

期望行为（对齐 Cloudflare 默认） ​

  • 带登录 Cookie 的用户访问 /_app/**/*.js 等静态资源：可以 HIT。
  • 响应带 Set-Cookie 或 private：不入库。
  • 无源站缓存头的可缓存状态码：使用默认 Edge TTL（如 200 约 120 分钟）。

基于 Apache License 2.0 发布

Copyright © OpenFlare contributors