Skip to content

serve 环境变量

This content is not available in your language yet.

这些环境变量调节 tansr serve 的准入、超时、事件缓冲、多会话治理与日志形态。全部键都可以不设:留空等于未设,走库内缺省,行为不变;取值非法时忽略并打一条告警,不会拒绝启动。

  • 「类型」列给出取值形;整数类的单位(ms / bytes / days)写在括号里。
  • 「敏感」为「是」的键其取值不会进入日志和告警;不要把它写进版本库。
  • 深链锚点为小写键名,例如 #tansr_serve_max_active_sessions。
  • 另有 5 个键由 tansr serve 入口自行定义,不在本表(见末节「入口级键」)。
键 组 类型 缺省 敏感
TANSR_SERVE_MAX_ACTIVE_SESSIONS 准入 / 过载保护 整数:integer >= 1 留空(库缺省) 否
TANSR_SERVE_MAX_SSE_CONNECTIONS 准入 / 过载保护 整数:integer >= 1 留空(库缺省) 否
TANSR_SERVE_MAX_INFLIGHT_BODY_BYTES 准入 / 过载保护 整数:integer >= 1;bytes 留空(库缺省) 否
TANSR_SERVE_ELD_THRESHOLD_MS 准入 / 过载保护 整数:integer >= 1;ms 留空(库缺省) 否
TANSR_SERVE_REQUEST_TIMEOUT_MS node:http 参数 整数:integer >= 0;ms 留空(库缺省) 否
TANSR_SERVE_EXPOSE_OBSERVABILITY 观测端点暴露 布尔:1|true|yes|on / 0|false|no|off 留空(库缺省) 否
TANSR_SERVE_EXPOSE_METRICS 观测端点暴露 布尔:1|true|yes|on / 0|false|no|off 留空(库缺省) 否
TANSR_SERVE_EVENT_BUFFER_MAX_BYTES 事件环形缓冲 整数:integer >= 1;bytes 留空(库缺省) 否
TANSR_SERVE_ORPHAN_GRACE_MS /v2 多会话治理 整数:integer >= 0;ms 留空(库缺省) 否
TANSR_SERVE_IDLE_AFTER_GONE_MS /v2 多会话治理 整数:integer >= 0;ms 留空(库缺省) 否
TANSR_SERVE_MAX_RETAINED_SESSIONS /v2 多会话治理 整数:integer >= 0 留空(库缺省) 否
TANSR_SERVE_MAX_SESSION_LIFETIME_MS /v2 多会话治理 整数:integer >= 1;ms 留空(库缺省) 否
TANSR_SERVE_MAX_TURNS_PER_SESSION /v2 多会话治理 整数:integer >= 1 留空(库缺省) 否
TANSR_SERVE_SESSION_SHARD /v2 多副本分片 整数:integer in [0, 255] 留空(库缺省) 否
TANSR_SERVE_AUTH_MAX_PENDING /v2 多副本分片 整数:integer >= 1 留空(库缺省) 否
TANSR_SERVE_AUTH_TIMEOUT_MS /v2 多副本分片 整数:integer in [1, 2147483647];ms 留空(库缺省) 否
TANSR_SERVE_LEGACY_V1 旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口 布尔:1|true|yes|on / 0|false|no|off 留空(库缺省) 否
TANSR_SERVE_LEGACY_PREFIX 旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口 枚举:readwrite|readonly|off 留空(库缺省) 否
TANSR_SERVE_LEGACY_SUNSET 旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口 其他:HTTP date (IMF-fixdate) or ISO-8601 timestamp 留空(库缺省) 否
TANSR_SERVE_NOTIFY_URL /v2 轮末 webhook 出站 URL:absolute http(s) URL 留空(库缺省) 否
TANSR_SERVE_NOTIFY_SECRET /v2 轮末 webhook 出站 字符串:non-empty string; value never logged; requires TANSR_SERVE_NOTIFY_URL 留空(库缺省) 是
TANSR_SERVE_UPSTREAM_MAX_INFLIGHT 上游治理层 整数:integer >= 1 留空(库缺省) 否
TANSR_SERVE_UPSTREAM_CONNECT_TIMEOUT_MS 驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 否
TANSR_SERVE_UPSTREAM_IDLE_TIMEOUT_MS 驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 否
TANSR_SERVE_UPSTREAM_TOTAL_TIMEOUT_MS 驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 否
TANSR_SERVE_TURN_WALL_CLOCK_MS 驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 否
TANSR_SERVE_HOST_SHELL 驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 枚举:posix|powershell 留空(库缺省) 否
TANSR_SERVE_SSE_MAX_FRAME_BYTES SSE 传输 整数:integer >= 1;bytes 留空(库缺省) 否
TANSR_SERVE_SSE_MAX_BUFFER_BYTES SSE 传输 整数:integer >= 1;bytes 留空(库缺省) 否
TANSR_SERVE_SSE_SLOW_POLICY SSE 传输 枚举:disconnect|drop-oldest 留空(库缺省) 否
TANSR_SERVE_SSE_RETRY_MS SSE 传输 整数:integer >= 0;ms 留空(库缺省) 否
TANSR_SERVE_LOG_FORMAT 日志形态 枚举:json|text 留空(库缺省) 否
TANSR_SERVE_LOG_LEVEL 日志形态 枚举:debug|info|warn|error 留空(库缺省) 否
TANSR_SERVE_ON_UNHANDLED 进程级兜底 枚举:log|drain-exit 留空(库缺省) 否
TANSR_SERVE_READY_STREAM 进程级兜底 枚举:stdout|stderr|none 留空(库缺省) 否
TANSR_SERVE_CWD_ON_RESUME factory 枚举:current|stored 留空(库缺省) 否
TANSR_SERVE_SESSION_MAX_AGE_DAYS factory 整数:integer >= 1;days 留空(库缺省) 否
TANSR_SERVE_SESSION_MAX_PER_END_USER factory 整数:integer >= 1 留空(库缺省) 否

组 admission,共 4 键。

组 类型 缺省 说明 敏感
准入 / 过载保护 整数:integer >= 1 留空(库缺省) 对应运行时选项 admission.maxActiveSessions。 否
组 类型 缺省 说明 敏感
准入 / 过载保护 整数:integer >= 1 留空(库缺省) 对应运行时选项 admission.maxSseConnections。 否
组 类型 缺省 说明 敏感
准入 / 过载保护 整数:integer >= 1;bytes 留空(库缺省) 对应运行时选项 admission.maxInflightBodyBytes。 否
组 类型 缺省 说明 敏感
准入 / 过载保护 整数:integer >= 1;ms 留空(库缺省) 对应运行时选项 admission.eventLoopDelayP99Ms。 否

组 http,共 1 键。

组 类型 缺省 说明 敏感
node:http 参数 整数:integer >= 0;ms 留空(库缺省) 对应运行时选项 http.requestTimeout。 否

组 observability,共 2 键。

组 类型 缺省 说明 敏感
观测端点暴露 布尔:1|true|yes|on / 0|false|no|off 留空(库缺省) 对应运行时选项 observability.expose。 否
组 类型 缺省 说明 敏感
观测端点暴露 布尔:1|true|yes|on / 0|false|no|off 留空(库缺省) 对应运行时选项 observability.exposeMetrics。 否

组 ring,共 1 键。

组 类型 缺省 说明 敏感
事件环形缓冲 整数:integer >= 1;bytes 留空(库缺省) 对应运行时选项 eventBufferMaxBytes。 否

组 governance,共 5 键。

组 类型 缺省 说明 敏感
/v2 多会话治理 整数:integer >= 0;ms 留空(库缺省) 对应运行时选项 v2.governance.orphanGraceMs。 否
组 类型 缺省 说明 敏感
/v2 多会话治理 整数:integer >= 0;ms 留空(库缺省) 对应运行时选项 v2.governance.idleAfterGoneMs。 否
组 类型 缺省 说明 敏感
/v2 多会话治理 整数:integer >= 0 留空(库缺省) 对应运行时选项 v2.governance.maxRetainedSessions。 否
组 类型 缺省 说明 敏感
/v2 多会话治理 整数:integer >= 1;ms 留空(库缺省) 对应运行时选项 v2.governance.maxSessionLifetimeMs。 否
组 类型 缺省 说明 敏感
/v2 多会话治理 整数:integer >= 1 留空(库缺省) 对应运行时选项 v2.governance.maxTurnsPerSession。 否

组 v2,共 3 键。

组 类型 缺省 说明 敏感
/v2 多副本分片 整数:integer in [0, 255] 留空(库缺省) 对应运行时选项 v2.sessionIdShard。 否
组 类型 缺省 说明 敏感
/v2 多副本分片 整数:integer >= 1 留空(库缺省) 对应运行时选项 v2.authentication.maxPending。 否
组 类型 缺省 说明 敏感
/v2 多副本分片 整数:integer in [1, 2147483647];ms 留空(库缺省) 对应运行时选项 v2.authentication.timeoutMs。 否

旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口

Section titled “旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口”

组 D51)(legacy,共 3 键。

组 类型 缺省 说明 敏感
旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口 布尔:1|true|yes|on / 0|false|no|off 留空(库缺省) 对应运行时选项 disableV1。 否
组 类型 缺省 说明 敏感
旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口 枚举:readwrite|readonly|off 留空(库缺省) 对应运行时选项 legacyPrefixes。 否
组 类型 缺省 说明 敏感
旧 /v1 面(UAPI-01 D14)与 /v2 /v3 退役窗口 其他:HTTP date (IMF-fixdate) or ISO-8601 timestamp 留空(库缺省) 对应运行时选项 legacyPrefixSunset。 否

组 notify,共 2 键。

组 类型 缺省 说明 敏感
/v2 轮末 webhook 出站 URL:absolute http(s) URL 留空(库缺省) 对应运行时选项 v2.onTurnEndNotify.url。 否
组 类型 缺省 说明 敏感
/v2 轮末 webhook 出站 字符串:non-empty string; value never logged; requires TANSR_SERVE_NOTIFY_URL 留空(库缺省) 对应运行时选项 v2.onTurnEndNotify.secret;取值不入日志与告警。 是

组 upstream,共 1 键。

组 类型 缺省 说明 敏感
上游治理层 整数:integer >= 1 留空(库缺省) 对应运行时选项 governor.bulkhead.maxConcurrent。 否

驱动分层超时 / 每轮墙钟 / 宿主 shell 方言

Section titled “驱动分层超时 / 每轮墙钟 / 宿主 shell 方言”

组 session,共 5 键。

组 类型 缺省 说明 敏感
驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 对应运行时选项 session.timeouts.connectTimeoutMs。 否
组 类型 缺省 说明 敏感
驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 对应运行时选项 session.timeouts.idleTimeoutMs。 否
组 类型 缺省 说明 敏感
驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 对应运行时选项 session.timeouts.totalTimeoutMs。 否
组 类型 缺省 说明 敏感
驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 整数:integer >= 1;ms 留空(库缺省) 对应运行时选项 session.maxTurnWallClockMs。 否
组 类型 缺省 说明 敏感
驱动分层超时 / 每轮墙钟 / 宿主 shell 方言 枚举:posix|powershell 留空(库缺省) 对应运行时选项 session.hostShell。 否

组 sse,共 4 键。

组 类型 缺省 说明 敏感
SSE 传输 整数:integer >= 1;bytes 留空(库缺省) 对应运行时选项 sse.maxFrameBytes。 否
组 类型 缺省 说明 敏感
SSE 传输 整数:integer >= 1;bytes 留空(库缺省) 对应运行时选项 sse.maxBufferBytes。 否
组 类型 缺省 说明 敏感
SSE 传输 枚举:disconnect|drop-oldest 留空(库缺省) 对应运行时选项 sse.onSlowSubscriber。 否
组 类型 缺省 说明 敏感
SSE 传输 整数:integer >= 0;ms 留空(库缺省) 对应运行时选项 sse.retryMs。 否

组 log,共 2 键。

组 类型 缺省 说明 敏感
日志形态 枚举:json|text 留空(库缺省) 对应运行时选项 logger.log。 否
组 类型 缺省 说明 敏感
日志形态 枚举:debug|info|warn|error 留空(库缺省) 对应运行时选项 logger.level。 否

组 process,共 2 键。

组 类型 缺省 说明 敏感
进程级兜底 枚举:log|drain-exit 留空(库缺省) 对应运行时选项 processGuards.onFatal。 否
组 类型 缺省 说明 敏感
进程级兜底 枚举:stdout|stderr|none 留空(库缺省) 对应运行时选项 readyFrame。 否

组 factory,共 3 键。

组 类型 缺省 说明 敏感
factory 枚举:current|stored 留空(库缺省) 对应运行时选项 factory.cwdOnResume。 否
组 类型 缺省 说明 敏感
factory 整数:integer >= 1;days 留空(库缺省) 对应运行时选项 factory.sessions.retention.maxAgeDays。 否
组 类型 缺省 说明 敏感
factory 整数:integer >= 1 留空(库缺省) 对应运行时选项 factory.sessions.retention.maxPerEndUser。 否

下列键由 tansr serve 的启动入口直接读取(多数有同义命令行旗标),不在上表的运行时选项表内;这里只登记键名以便深链,用法见 serve 部署指南。

入口级键,由 tansr serve 启动入口读取;不在 .env.example 运行时选项表内。

入口级键,由 tansr serve 启动入口读取;不在 .env.example 运行时选项表内。

入口级键,由 tansr serve 启动入口读取;不在 .env.example 运行时选项表内。

入口级键,由 tansr serve 启动入口读取;不在 .env.example 运行时选项表内。

入口级键,由 tansr serve 启动入口读取;不在 .env.example 运行时选项表内。