hertz

README

hertz

Hertz 运行时集成——日志桥接、生命周期、SSE/health/metrics、适配器、OTel

🌐 项目主页：https://oekit.github.io/ · 名称由来：Open Easy Kit（开源 · 易用 · 工具集合） 🤖 AI Agent：本仓规范与硬规则见 AGENTS.md；机器可读索引见 llms.txt（接口签名以源码为准）。

安装

go get github.com/oekit/hertz@v0.8.0

这个仓库做什么

为 CloudWeGo Hertz 提供生产级运行时集成：hlog→logx 日志桥接、RunServer 接 bootstrap 优雅退出（AddShutdownHook 支持关停前刷数据）、server.WithExitWaitTime 排空调优。 本仓自 v0.5.1 起算：历史与旧版本号已全部清空，包布局收成「模块根 + 一级子包」。

组成

包	import 路径	做什么
hertz（模块根包）	github.com/oekit/hertz	RunServer 生命周期、hlog→logx 桥接、Shutdown Hook
health	github.com/oekit/hertz/health	K8s 探针（/ping、/health、/buildVersion）；Degraded 软依赖降级；HealthResponse 导出面（消费方直接解码 data.status / data.checks，不必手写信封结构体）；空路径跳过注册；Redis checker 在 health/redischeck（核心包零 go-redis）
sse	github.com/oekit/hertz/sse	Server-Sent Events 封装（官方 protocol/sse + LastEventID 续传）
metrics	github.com/oekit/hertz/metrics	Prometheus /metrics 暴露（gzip/OpenMetrics 协商）
render / adaptor	github.com/oekit/hertz/render 等	业务 Render 实现、net/http 互转
crudh / validatorh / versionh	github.com/oekit/hertz/crudh 等	泛型 CRUD Handler、参数绑定校验、版本端点
governance	github.com/oekit/hertz/governance	动态限流/超时中间件（包名 govhertz）
registry / nns	github.com/oekit/hertz/registry 等	ekit registry / NNS → Hertz 注册发现适配
hertzotel / hertztracer	github.com/oekit/hertz/hertzotel 等	OpenTelemetry / OpenTracing 链路

快速使用

import (
    ekithertz "github.com/oekit/hertz"
    "github.com/cloudwego/hertz/pkg/app/server"
)

h := server.New(server.WithHostPorts(":8080"))
h.GET("/ping", func(ctx context.Context, c *app.RequestContext) { c.String(200, "pong") })
ekithertz.RunServer(app, "my-http", h) // 接 bootstrap 生命周期，优雅退出

矩阵总览（24 活跃模块，自动生成）

模块	内容	矩阵内依赖
pkg	微工具集 23 合 1（errors/bloomx/contextx/container/stringx/slicex/enumx/convert/encoding/jsonrepair/httpjson/mathx/pathx/pagination/ptrx/timex/cache/bufiox/strmap/singleflighttest/urlguard/cli/pack；v0.10.0 起 uidgen/validator 拆至 kitx）；errors（v0.12.0 起）New/As/Is/Unwrap 与 stdlib 同型透传——下游哨兵/As 判定单 import 即可，类型同一性红线可完整执行；cache（v0.4.0 起）含缓存接口 CacheAside + BatchGetter 批量能力（MGet）+ LocalCache/SingleFlightCache + cachetest 契约（Run 真实时间 + RunWithClock 假时钟确定性 TTL 边界）+ Checker；LocalCache 时钟可注入（LocalConfig.Now——TTL/NullTTL 全路径确定性测试，v0.13.0 起）；v0.16.0 起 LocalCache 可选形状——NoBackgroundSweep 关闭后台清扫 goroutine（嵌入式/短命进程，公开 Sweep 手动清扫口）、CloneOnRead 读命中返回副本（调用方可改写不污染缓存）、EvictPolicy 可选 LRU（默认 FIFO 不变）、GetEx 区分未命中与值为 nil（新增能力以可选接口 Sweeper/HitGetter 外置，不破坏其它后端）；container（v0.9.0 起，收编原 collectionx）泛型容器 Set/Ring/Queue/SafeMap + Map（sync.Map 背书）/Slice（并发安全）；mathx/jsonrepair（v0.11.0）Unstable 单边向上抖动 Upward / 宽松解析 UnmarshalLenient / 抽对象与抽数组对称原语 ExtractObject·ExtractArray（v0.18.0 起——多段数组与散文含 '{' 的数组文本不再整段作废，取首个口径与对象面一致）；timex/stringx（v0.7.0 起）时间段边界 BeginningOf/EndOf 七对（分/时/日/周/月/季/年，周起始显式参数）+ trie 多模式替换器 Replacer（最长匹配）/ NewMask 敏感词遮罩；stringx Masker（v0.16.0 起）正则脱敏——按形态分类打码（形态标签进掩码供审计读）+ 保留首尾各 ≤4 字符定位线索且不可复原（保留位封顶不随长度变化），规则表由调用方完全提供；singleflighttest（v0.8.0 起）singleflight 共享契约测试套件（internal 与 concurrency 双侧引用）；urlguard（v0.15.0 起）出站 SSRF 防护原语——CheckURL 字面量校验（私网/loopback/链路本地含云元数据 169.254.169.254/CGNAT/ULA/组播保留、.internal·.local·localhost 域名、scheme 白名单、IPv4-mapped IPv6 归一）+ DialFunc 拨号层预解析校验与实际 RemoteAddr 端点核对闭合 TOCTOU（Happy-Eyeballs 覆盖），构造态豁免 WithAllowPrivate/WithAllowCIDRs/WithAllowDomains，与 httpx WithDialFunc 一行组合（httpx#11）；cli（v0.16.0 起）框架无关可单测的子命令分发原语——App/Command + 退出码 0/1/2 写死在包里、usage 按 Summary 自动生成、不读 os.Args 不调 os.Exit（输出流全由调用方给）；pack（v0.16.0 起）迁移包容器原语——zip + manifest（格式版本/条数/每文件 SHA-256）+ JSONL 流式读写 + Inspect 体检一次列全问题并区分包损坏与版本不认识	—
concurrency	并发与流控原语（async/gopool/group/singleflight/progress/syncx/ratelimit/retry）+ window 滑动窗口 / breaker 自适应熔断（规范哨兵 ErrCircuitOpen）/ shedding CPU 自适应降载 / batch 攒批执行器（满条数/满字节/窗口去重）/ timewheel 单级时间轮；v0.5.0 起 retry 指数退避+抖动（MaxDelay 封顶/溢出饱和）、loop 周期原语（忙时丢 tick/单轮 panic 收编/FirstDelay 可打断）、async labeled RunSafe（panic 按任务标签上报）、syncx.FanInErr 逐槽错误（panic 槽显式标记）、KeyedLimiter 增强（容量护栏/RetryAfter/速率热更）并接入 pkg/singleflighttest 契约测试；v0.8.0 起 singleflight DoShared 折叠可观测（Result.Waiters）、async panic 统一收编 typed *PanicError（errors.As 可辨、携带栈）+ 实例级 Runner panic 路由、retry DelayHint（服务端 Retry-After 建议优先）+ JitterRatio 比例抖动 + retry/httpx Retryable 可重试性判定；v0.9.0 起 breaker 显式三态状态机 closed/open/half-open——冷却（WithProbeTimeout 缺省 1m）期满首个放行即半开探测、探测成功关闸清窗/失败重开、失联超时自动回收 + AbandonGen 显式放弃，GenBreaker 代绑定（AllowGen/SuccessGen/FailureGen/AbandonGen：代仅在探测放行自增、陈旧代回报整体作废、开放期失败不后移冷却）；v0.10.0 起 WithCooldown 独立业务冷却期（缺省回落 probeTimeout）+ WithConsecutiveFailures 连续失败计数触发（与速率型并联，补低 QPS 信号，对齐 Envoy consecutive_5xx）；v0.11.0 起 ratelimit Lockout 防爆破锁（fail2ban 形态：滑窗失败计数→阈值锁定拒绝 LockDuration→成功 Reset 清零/到期自解，CheckLocked 返回剩余时长）；v0.12.0 起 retry/httpx RetryableWithHeaders（403 + Retry-After/X-RateLimit-Remaining 头感知可重试判定，HeaderSource 零依赖抽象）、syncx FanInLimit 受限并发扇出（固定 worker 防下游过载）+ FanInLimitCtx（v0.14.0，ctx 感知：ctx 已取消未启动项 fn 一次不调、剩余槽快速排空 Canceled、在飞项照常落槽）、ratelimit WithTokenClock 时钟注入；v0.13.0 起 breaker 熔断期收敛到探测级（forcePass 强制探活 + 冷却期满半开探测，其余拒绝——SRE 公式退役为 closed→open 触发器，WithConsecutiveFailures 触发后流量真停）+ State()/State 枚举可观测出口；v0.16.0 起 ratelimit NewKeyedLimiterByFunc[K]——factory func(K) Limiter 按 key 定配额（一个管理器按接口维度分档位，NewKeyedLimiterOf 零破坏随迁；未登记 key 拿 factory 兜底档的坑已在 doc 点名，#31）；v0.17.0 起 KeyedLimiter.Create 护栏内原子登记（表满先回收空闲与 Allow 同路、仍满拒绝计 OverCapHits、已存在不覆盖——热更走 Replace；解决 ByFunc factory 库锁内调用致消费方锁序倒置，#33）；v0.18.0 起 retry.DoValue 泛型伴生——带返回值的重试（DoValue[T](ctx, cfg, fn func(attempt int) (T, error))；Do 改为委托给 DoValue——退避序列/抖动/MaxDelay 封顶/DelayHint 优先/Retryable 门控/ctx 取消只有一份实现，杜绝「同一个仓里两份实现」；失败返回零值与最后一次错误）	pkg
logx	统一日志门面（多后端可替换 + caller 归属；Sink 已迁嵌套模块 logx/sink，根包纯 stdlib）；WithFilter 脱敏/丢弃包装（FilterKey 命中键替换 ***/FilterFunc 丢整条，子 logger 保持规则）、Slogger/SlogHandler 正向桥（三方 slog 直接消费 logx 生态）、TraceHandler 任意 slog.Handler 自动注入 trace_id、NewAuditLogger 审计留痕（级别锁 Info，不受 LOG_LEVEL 降级）、LevelEnabler 热路径提前判级、ParseLogLevel 返回 (Level, error) + ParseLogLevelOr 配错退默认（v0.7.0）；优雅关停正身在 core/lifecycle.Manager（logx/shutdown 仅余 Deprecated 别名）；桥接子包 hlog/hertzlog/kitexlog 为嵌套模块按需引入	core
core	应用基建件——governance 治理 schema、config 配置加载（LoadBootstrap/LoadDotEnv/Get* 系、default/env/range/options tag 校验、OverlaySource 多源叠加热更、ApplyEnvOverlay env 优先 12-factor 形态）、transport 协议无关传输上下文（Transporter/Header/Server·Client ctx 存取，仅标准库）、chain 中间件链（Handler/Middleware/Chain/Recovery/Timeout，与 nns-endpoint.Endpoint 同形）、lifecycle 契约 + Manager 优雅关停（自 logx/shutdown 迁入，日志 *slog.Logger——core 不再依赖 logx）、network IP 工具、version；v0.9.0 起 config FieldSet 显式提供集合（yaml 显式 port:0 不再被 default/env 覆盖——LoadBootstrap 默认接线，免全量指针化）+ require tag（必须 yaml/env 提供，缺失列全并附 env 提示）+ v0.9.1 修 yaml:,inline 字段在 FieldSet 下漏标记（inline 叶子显式零值曾被 default 覆盖）；v0.9.2 env 卫生改纯静态（仅格式/重名，移除依赖进程环境的拼写冒烟检查——误报 PATH/HOME、漏无人设置的真拼错，core#8），命名一致性走 LintEnvNaming 诊断 / WithEnvNamingLint 可选 fail-closed / ignorederived="true" 豁免；v0.10.0 起 config 严格模式——LoadBootstrap[T](envFlag string, opts ...LoadOption) 传 config.WithStrict() 开启：未知键拒载（不再静默忽略），错误带嵌套路径 + 该层合法键清单 + 近似拼写建议（UnknownKeyError）；默认行为不变，严格模式显式开启；v0.11.0 起 config 加载入口按来源拆开——LoadFile（任意路径：CLI -config 路径、容器内固定挂载位）+ Unmarshal（字节源：API 下发 / 模板渲染 / 测试夹具），与 LoadBootstrap（etc/ 约定）共享同一条解码线，因此严格模式诊断面（嵌套路径 / 合法键清单 / 拼写建议）与来源无关；LoadBootstrap 行为与错误文案逐字不变	—
kitx	标识与校验——uidgen（Snowflake 全局单例+Extract 元数据、手写 RFC 4122 v4 UUID 零第三方依赖、RandomHex/RandomString 拒绝采样随机串）+ validator（go-playground/validator v10 接口化门面：struct tag 校验/自定义规则注册/ValidationError Unwrap 为 BizError 400 对接 middleware.Fail）+ hash（v0.2.0 起非密码学哈希助手 Md5Hex/Md5Bytes——缓存键/幂等键/短唯一 code，格式稳定承诺，pkg 2026-09-15 治理移除弱哈希后 kitx 侧收编 pkg#10），自 pkg v0.10.0 拆出	pkg
metrics	Prometheus 门面 + 弹性指标族	core
tracing	OpenTelemetry 追踪 + trace_id 真相源（v0.3.0 起 OTLP 双协议导出：gRPC 缺省 / HTTP，Config.Protocol + Headers，切换协议不丢传播器/指标/旧 provider 关闭）	logx
registry	注册发现核心（provider 无关 SPI：Registrar/Discoverer/Subscriber/ConfigStore + 实例模型 + netutil）+ sdbridge + registrymocks——根仓零第三方依赖；Nacos 实现与 Nacos 配置源已拆成嵌套模块（v0.5.0 起：registry/nacosimpl、registry/nacos——nacos-sdk-go 重依赖隔离在此，实测单独引入即拖 63 个第三方模块，不隔离时只要 SPI 接口的消费方也会被连带拖入）	core
data	数据访问门面——复刻 ekit data/ 能力面：cache/rediscache/crud/distlock/gormx/redisx/timertask/cachetest 八子包 re-export（类型同一，实现住 pkg 与各子仓）+ cached 缓存读写编排（写后失效/事务提交后失效/查询缓存版本号失效/GetByIDs 批量点读 MGet 快路径/bloom 防穿透）+ twolevel 两级缓存与跨实例失效广播（v0.7.0 起本仓唯二非 re-export 实现）；v0.15.0 起壳跟随源仓演进——cache 壳补 LocalCache 可选形状（EvictPolicy/Sweeper/HitGetter）、cachetest 壳补 5 个契约套件入口（套件 8 → 13 场景）、timertask 壳的 Redis 形态随源仓 v0.2.0 迁至嵌套模块 timertask/redis（壳不再转发 RedisBackend/ShardManager，Redis 形态直接依赖该嵌套模块）；all/ 聚合模块已废弃 retract	concurrency、gormx、logx、pkg、redisx、timertask
gormx	SQL/GORM 全家——连接池增强、框架无关 CRUD Service、仓储（原 oekit/gorm，v0.3.0 更名）	logx、pkg
redisx	Redis 全家——客户端封装（根包）、分布式缓存 cache/、分布式锁 distlock（Locker 同形可互换；Renew 手动续期（false=锁丢失，不进 Locker 接口保 etcdx 互换）+ WithAutoRenew 覆盖 TryLock 自动续期（v0.8.0 feat!：此前组合不续期）；Semaphore ZSET 槽位信号量（v0.8.0：Acquire 同 identifier 幂等刷新 + Lua 内原子清过期槽崩溃自愈、Renew 仅未过期槽可续、Cleanup 返条数、无 Redis 降级 fail-fast））、分布式限流 ratelimit（Lua 三态 + 故障本地兜底）；v0.9.0 起 distlock Lockout 分布式防爆破锁（Redis 侧 fail2ban：滑窗失败计数→阈值锁定 Penalty→Reset 清零，与 concurrency/ratelimit.Lockout 进程内孪生——多实例共享计数是存在理由；惩罚只按首次触发计算、nil client fail-fast 不降级，#6）	concurrency、logx、pkg
etcdx	etcd 全家——客户端封装（根包：生产默认值/Health 探活/Close(ctx) 幂等）、registry 注册发现实现（SPI 对接 registry/nacos 链路：Lease KeepAlive 注册 + 丢约指数退避自动重注册、prefix Watch 订阅推送、ConfigStore KV 配置监听）、distlock 分布式锁（Session+concurrency.Mutex 公平排队，接口与 redisx/distlock.Locker 同形可互换，可选无 etcd 降级放行）	concurrency、logx、registry
httpx	HTTP 客户端 + 负载均衡——服务发现/熔断（规范哨兵 ErrCircuitOpen）/重试/指标/OTel 透传；loadbalance Selector 形态（RoundRobin/Random/Weighted/一致性哈希权重感知虚拟副本/p2c 自适应——EWMA 经 DoneFunc 回写建立、Err 计 1s 惩罚；WithFilter 按元数据过滤；v0.4.0 起 Balancer 全家族删除无兼容路径）；codec 注册制编解码器（json 内置 + form 表单，DoCodec 请求按 codec 序列化、响应按 Content-Type 反查回退请求 codec）；v0.6.0 起 net/http 桥接层 NewRoundTripper/StdClient——存量标准库外呼一行 Transport 接入熔断/重试/指标/链路（重试缺省关显式开、非 2xx 非错误、hop-by-hop 隔离，#8）；v0.8.0 起 SafeDialFunc/WithSafeDial 出站 SSRF 防护胶水（判定单源 pkg/urlguard v0.15.0：解析 IP 全量预检 + 实际 RemoteAddr 端点核对闭合重解析 TOCTOU、Happy-Eyeballs 覆盖，构造态豁免；v0.7.0 内置的独立 httpx/urlguard 实现收敛删除，#11）	concurrency、logx、metrics、pkg、registry、tracing
network	轻量网络客户端——WebSocket/NATS/MQ 抽象、连接与流工具	concurrency、logx、tracing
timertask	分片定时任务（FNV-1a、心跳续约）；v0.1.5 起可选可靠投递 DeliveryAtLeastOnce（租约 + Ack + 可见性超时；过期租约回扫重投/死信、停机 best-effort 收租，v0.1.7 接入生命周期真正生效）；v0.2.0 起 Redis 后端迁至嵌套模块 timertask/redis（根包不再引 go-redis/logx/concurrency，require 仅 pkg——import timertask 与 import timertask/local 的模块依赖面均无 redis，纯 stdlib 嵌入式场景可用）+ 新增 local 子包 cron 调度器 Scheduler（表达式复用 pkg/timex/cron 不另写一份；并发度/CatchUp 补跑/退出语义明确，FakeClock 假时钟驱动、触发点序列可确定性断言）	pkg
middleware	Hertz 标准中间件栈（模块根 mw，双层目录已收平）+ contrib 桥接 + hmw + SheddingMiddleware 自适应降载 + chainmw 子包（transport 感知框架无关中间件，基于 core/chain+transport：Recovery 带 panic 隔离上报钩子 WithRecoveryReporter、AccessLog skip+redact+自定义字段、MetadataPropagate——kitex 经 kitex/chainmw.ToKitex 复用同一实现，根包 Recovery/AccessLog 已薄壳化复用 chainmw 内核、下游 handler 可经 transport.FromServerContext 读协议无关传输信息）；v0.6.0 起 accesslog 凭证路径脱敏（WithAccessLogRedactPathPrefixes）、ratelimit 默认 KeyFunc 去端口（连接桶→地址桶）；v0.11.0 起 WithAccessLogSink 落库 sink（AccessRecord{Method,Path,Status,Latency,ClientIP,UserAgent,TraceID} 与日志同源、c 同传可读业务键、error/panic 只记 Warn 不影响主链路、SkipPaths 命中不触发）+ chainmw.WithSink 内核同构（kitex 随 ToKitex 获得）+ StackConfig.DisableResponseWrap 响应自管一键形态（TraceID→Recovery→AccessLog）与 AccessLogOptions 透传 + doc/README「适用边界」段（响应契约统一 vs handler 自管的推荐组合，#18）；v0.12.0 起 AccessLog panic 恢复点产出记录（AccessRecord.Panic 标记 + Err 摘要，Hertz status 按 Recovery 缺省 500）后按原值重抛——panic 请求不再零访问记录，sink/kitex 桥接同步留痕，#20；v0.13.0 起 accesslog 内建日志可关闭/改道（WithAccessLogSilent 只采不写、WithAccessLogLogger 注入宿主 logger 避免双写；静默下 skip/redact/sink/panic 记录照常），内核 chainmw.WithSilent 同构（kitex 随 ToKitex 获得），#38	concurrency、core、logx、metrics、pkg、registry、tracing
k8s	Kubernetes 客户端封装——RESTConfig/Clientset/DynamicClient 构建（显式 kubeconfig → in-cluster 自动 → KUBECONFIG/~/.kube/config 逐级回退，QPS/Burst 限流默认 50/100）+ leaderelection 子包 Lease 选主简化封装（OnStartedLeading/OnStoppedLeading/OnNewLeader 回调，主备单活，仅要求 Lease CRUD 权限）	logx
nns	NNS 服务治理客户端——provider 无关发现/配置/实例缓存	concurrency、core、logx、registry
nns-endpoint	NNS 端点工厂——per-service 熔断、换实例重试、gRPC 池	httpx、logx、metrics、nns、registry
bootstrap	应用生命周期引导——New(WithServiceName/WithShutdownTimeout/WithBeforeServe) + Run(fn) + healthz；App.Ready/ReadyChan/IsReady 就绪门（幂等并发安全）——嵌套 bootstrap/nacos 自 v0.3.0 起 NNS 注册延迟到 Ready 之后（server 就绪 → userFn 触发 Ready → 才进注册中心）、关停序 nns 反注册先于 server 关闭；Metrics/Tracing 在嵌套模块 bootstrap/obs	concurrency、core、logx
hertz	Hertz 运行时集成（模块根扁平化）——日志桥接、生命周期、SSE/health/metrics、适配器、OTel、crudh/validatorh（基于 kitx/validator）/versionh（原 handler 微库收编）；RunServer 变参就绪门 WithOnReady（全部 HostPort TCP 探活可建连后回调，探活超时按启动失败优雅关机；缺省超时 5s 经 WithReadyProbeTimeout 调整——探活目标是 server 自动取到的全部 HostPort，无探活地址覆盖选项（kitex 侧才有 WithReadyAddr）），配合 bootstrap Ready 实现 NNS 延迟注册；transportx（hertz→core/transport 同构适配器）+ chainmw 桥接	bootstrap、concurrency、core、gormx、kitx、logx、metrics、middleware、nns、pkg、registry、tracing
kitex	Kitex 生态——日志桥接、治理热更、生命周期、BizError 桥接、kitexotel、istio（xDS 动态熔断，原 istio 微库收编）；RunServer 变参就绪门（WithOnReady/WithReadyAddr/WithReadyProbeTimeout）+ chainmw.ToKitex（core/chain.Middleware → kitex 中间件，与 hertz 共享 middleware/chainmw 实现）+ transportx	bootstrap、concurrency、core、logx、metrics、nns、pkg、registry
workflow	组合式流程编排——串行/并行/异步/条件分支 + Hook AOP	concurrency、logx
kitex-examples	Kitex echo 示例——client/server + IDL + 治理配置	bootstrap、core、kitex、logx、tracing

Documentation

Overview

Package hertz 为 Hertz HTTP 框架提供 ekit 生态集成。

覆盖以下能力（对称 kitex 包，治理配置热更新不适用 Hertz）：

• 日志桥接：将 Hertz 框架内部日志通过 hlog → logx 归一，自动携带 trace_id 和结构化字段
• 生命周期管理：RunServer 将 Hertz server 注册到 bootstrap，一行完成 shutdown + 后台 Run； server 启动失败（如端口占用）时自动触发 RequestShutdown 优雅关机，避免进程"假活"

子包（推荐新代码直接使用子包）：

• health: 健康检查端点（/ping、/health、/buildVersion）+ DB checker （Redis checker 在子包 health/redischeck）
• metrics: Prometheus /metrics 端点（gzip/OpenMetrics 协商透传）
• sse: Server-Sent Events 流式推送（官方 protocol/sse 的并发安全封装）
• OTel tracing 见 hertzotel / hertztracer（server/client 全量能力）
• trace_id 中间件见 middleware/hmw（FromRequestContext + Middleware）

完整生命周期示例

hlog.SetSilentMode(true) // 静默客户端不规范行为导致的读头错误日志（推荐生产开启）
hlog.SetLogger(hertz.NewLogger(logx.NewSlogLogger("my-http")))

b, _ := bootstrap.New(bootstrap.WithServiceName("svc")) // + nacos/obs WithXxx 按需注入
b.Run(func(app *bootstrap.App) error {
    tracing := hertzotel.NewServerTracing()
    h := server.New(
        server.WithHostPorts(":8080"),
        server.WithExitWaitTime(10*time.Second), // 排空等待上限，默认 5s
        tracing.Option,
    )
    h.Use(tracing.Middleware)
    h.Use(mw.DefaultMiddleware(mw.StackConfig{SkipPaths: []string{"/healthz"}})...)

    // 健康检查 + 指标（在 RunServer 之前注册，确保端点随 server 一起就绪）
    // Redis 检查器在子包 redischeck；软依赖用 health.Degraded(err) 降级
    health.RegisterHealthRoutes(h, health.WithCheckers(
        redischeck.NamedRedisChecker("redis", rdb),
        health.NamedDBChecker("mysql", sqlDB),
    ))
    hmetrics.InitAndRegister("my-http", h)

    hertz.RunServer(app, "hertz", h)
    <-app.Context().Done()
    return nil
})

信号行为（对照官方 graceful-shutdown 文档）

Hertz 内置信号处理（h.Run() 内的 waitSignal）：

• v0.9.6+：SIGTERM/SIGINT/SIGHUP 均触发优雅退出（h.Shutdown）
• < v0.9.6：SIGTERM 立即退出；SIGINT/SIGHUP 触发优雅退出

ekit bootstrap 同时监听 SIGINT/SIGTERM，与 Hertz 内置处理并发触发。 RunServer 内部已容忍双路 Shutdown 竞态（hertz 返回 "engine is not running" 视为成功）， 用户无需额外处理。

优雅退出流程（Hertz 内部，对照官方文档）：

1. engine 状态设为 closed
2. 并发触发 OnShutdown 钩子（h.Engine.OnShutdown = append(h.Engine.OnShutdown, fn)）
3. 从注册中心注销
4. 关闭网络库信号监听
5. 进行中请求响应附带 Connection:Close 头
6. netpoll：每秒检查直到 active conn = 0；go net：关闭监听
7. 等待 ExitWaitTime（默认 5s）到期后退出

退出时间控制

server.WithExitWaitTime(d) — 排空等待上限（默认 5s），是官方文档的核心旋钮。 有长耗时请求时调大；与 bootstrap 的 ShutdownTimeout（单资源关闭预算）配合： bootstrap 关闭回调传入的 ctx 有 ShutdownTimeout 截断，Hertz 内部再以 ExitWaitTime 截断， 实际排空上限 = min(ShutdownTimeout, ExitWaitTime)。 保持 ExitWaitTime <= ShutdownTimeout 以确保排空不被 bootstrap 兜底截断。

与 kitex 包的差异

Hertz 使用中间件链（h.Use）而非 Suite 模式，因此不提供 ClientSuite/ServerSuite。 治理配置热更新（retry/rpc_timeout/circuit_breaker/limiter）是 Kitex RPC 框架级概念， Hertz 的对应能力由 mw.RateLimitMiddleware 等静态中间件覆盖，无需动态治理。

Index

• func AddShutdownHook(h *server.Hertz, fn func(ctx context.Context) error)
• func NewLogger(logger logx.Logger) hlog.FullLogger
• func RunServer(app lifecycle.App, name string, h *server.Hertz, opts ...RunServerOption)
• type RunServerOption
  • func WithOnReady(fn func(ctx context.Context)) RunServerOption
  • func WithReadyProbeTimeout(d time.Duration) RunServerOption

Functions

func AddShutdownHook

func AddShutdownHook(h *server.Hertz, fn func(ctx context.Context) error)

AddShutdownHook 注册 Hertz 优雅退出钩子函数,等价于官方教程推荐的 h.Engine.OnShutdown = append(...) 写法,但放在 ekit hertz 包内提供 helper,避免用户在 bootstrap.Run userFn 中手拿 engine。

hertz 官方 OnShutdown 签名 func(ctx context.Context) 不接受 error, 本 helper 接受 func(ctx) error 并把 fn 返回的 error 通过 bootstrapLog 记录为 Warn 日志(hertz 调用栈会忽略 error,日志是唯一能见的位置)。

fn 在 RunServer 调用前后都可以注册(只是 append 切片,无副作用), 多个 hook 按 append 顺序执行(官方文档明确)。

⚠️ 与 RunServer 的关系:

ekit hertz.RunServer 内部用 lifecycle.App.AddResource 注册 h.Shutdown,
OnShutdown hook 在 Shutdown 流程早期被调用(在 deregister 之前),
适合做"关停前刷数据/通知外部"类工作。
如果 hook 是"释放外部资源"(如关 DB),推荐直接用 lifecycle.App.AddResource
+ 显式 closer,语义更清晰、错误能上报 shutdown.Manager。

官方依据:https://www.cloudwego.io/zh/docs/hertz/tutorials/basic-feature/hooks/

"h.Engine.OnShutdown = append(h.Engine.OnShutdown, shutDownFunc)"

用法:

h := server.New(...)
hertz.AddShutdownHook(h, func(ctx context.Context) error {
    // 关闭前的最后操作
    return flushLastBatchToRemote(ctx)
})
hertz.RunServer(app, "my-svc", h)

func NewLogger

func NewLogger(logger logx.Logger) hlog.FullLogger

NewLogger 将 ekit logx.Logger 适配为 Hertz hlog.FullLogger。

调用后 Hertz 框架内部日志（网络层、连接异常、路由警告等）将通过 logx 输出， 自动携带 trace_id、service name 和结构化字段。 本函数会把自身所在文件注册为 logx 内部帧（logx.SkipCallerFiles）， 使经由适配器的框架日志 caller 归属真实调用方；副作用仅此一项。

使用方式：

hlog.SetLogger(hertz.NewLogger(logx.NewSlogLogger("my-http")))

⚠️ 按判据（而非函数名）：**传入 `logx.IsHlogBacked(l) == true` 的 Logger 会形成 adapter → logx → hlog → adapter 的无限递归**（栈溢出 + 进程挂死）， 本函数检测到即 panic 兜底（fail-fast，panic message 带实测值）。 常见触发路径：先 `hlog.SetLogger(...)` 改变了全局默认背端，随后 `logx.Default()` / `logx.WithService(...)` 取到的就是 hlog-backed 实例—— 默认背端未被改动时它们并非 hlog-backed，可以安全传入。 安全做法：`logx.IsHlogBacked(l)` 为 false 即可，或直接传 `logx.NewStdLogger(...)` / `logx.NewSlogLogger(...)`。

func RunServer

func RunServer(app lifecycle.App, name string, h *server.Hertz, opts ...RunServerOption)

RunServer 将 Hertz Server 注册到 ekit 生命周期管理（bootstrap.App 满足 lifecycle.App 接口；transport 适配层只依赖 lifecycle 契约，不依赖 bootstrap）。

该函数会：

1. 通过 app.AddResource 注册 h.Shutdown 作为关闭回调（优雅关闭时自动调用）。
2. 通过 app.GoBackground 在后台启动 h.Run()（阻塞直到 server 退出）。 设置 WithOnReady 时，先循环 TCP dial 探活全部 HostPort（默认超时 5s， WithReadyProbeTimeout 可调），全部可建连后执行 onReady——hertz 的 OnRun 钩子先于 listenAndServe 执行，无法用作就绪信号，故以探活近似真实就绪 （TCP 可建连 ≠ 业务健康，业务级健康门请配合 hertz/health 检查后再 Ready）。
3. h.Run() 返回 error 或 panic（netpoll 传输层在监听失败如端口占用时 直接 panic 而非返回 error）时调用 app.RequestShutdown() 触发优雅关机， 避免进程无服务地"假活"；探活超时同样触发关机（按启动失败处理）。

关闭语义（对照官方 graceful-shutdown 文档）

信号路径：SIGTERM/SIGINT（SIGHUP 未被忽略时含之）由 h.Run() 内置 waitSignal 处理，直接触发 h.Shutdown(context.Background())，排空上限为 server.WithExitWaitTime（**默认 5s** — hertz 官方默认;未配时 netpoll 1s ticker 检 active conn / go net 立即关 listen）。同一信号也会让 bootstrap 走本函数注册的 关闭回调，第二次 Shutdown 因 engine 状态已非 running 返回 "engine is not running"——这是双路关闭的良性竞争而非故障，此处按成功处理， 避免每次信号关机都产生假错误日志。

程序化路径（userFn 返回 / RequestShutdown）：走本函数注册的关闭回调， ctx 为 bootstrap 单资源预算（shutdown.New 的 defaultTimeout）；hertz 内部 再以 ExitWaitTime 截断，实际排空上限 = min(两者)。需要更长排空时间时调大 server.WithExitWaitTime，并保持其小于 bootstrap 单资源预算。

⚠️ **推荐显式设置 server.WithExitWaitTime**(尤其长耗时 RPC):保持其小于 bootstrap 单资源关闭预算(shutdown.New 的 defaultTimeout),避免排空被 bootstrap 兜底截断。hertz Shutdown 接受传入 ctx 但内部还会以 ExitWaitTime 截断,二者取 min。

使用方式（在 bootstrap.Run 的 userFn 内，对称 kitex.RunServer）：

b, _ := bootstrap.New(bootstrap.WithServiceName("svc")) // + nacos/obs WithXxx 按需注入
b.Run(func(app *bootstrap.App) error {
    h := server.New(server.WithHostPorts(":8080"))
    h.Use(mw.DefaultMiddleware(mw.StackConfig{})...)
    hertz.RunServer(app, "hertz", h,
        hertz.WithOnReady(func(ctx context.Context) { app.Ready() }))
    <-app.Context().Done() // 阻塞直到收到 SIGINT/SIGTERM
    return nil
})

⚠️ userFn 返回 = 主动关机。若 RunServer 后直接 return nil， bootstrap.Run 会立即执行 shutdown 序列，服务器启动即退出。

Types

type RunServerOption

type RunServerOption func(*runServerConfig)

RunServerOption 配置 RunServer 的就绪回调行为。

func WithOnReady

func WithOnReady(fn func(ctx context.Context)) RunServerOption

WithOnReady 注册就绪回调：TCP 探活通过（全部 HostPort 可建连）后执行， 典型用途是触发延迟注册（app.Ready()，配合 bootstrap/nacos v0.3.0）。 设置本选项即默认启用 TCP 探活；未设置时行为与 v0.5.x 一致（无回调无探活）。

func WithReadyProbeTimeout

func WithReadyProbeTimeout(d time.Duration) RunServerOption

WithReadyProbeTimeout 配置探活超时（默认 5s）。设为负数禁用探活—— 直接在 GoBackground 启动前同步回调（不推荐：回调时端口可能尚未监听， hertz OnRun 钩子先于 listenAndServe 执行，无原生就绪信号可用）。