Update /ready and /health schemas for v2.10
@devanbenz 已经在做这个了。
开始于 2026年10月9日。
评估
这个 Issue 还没有评估数据。
描述
Summary
Two contract changes are needed for InfluxDB OSS v2.10 and InfluxDB Cloud 2:
- The
/readyand/healthschemas don't describe the v2.10 responses. - The Cloud
Routesschema is missing two keys that Cloud returns.
I tested influxdata/influxdb main-2.x at 310ee146d9 (built locally) and a production InfluxDB Cloud 2 (TSM) org on 2026-10-08.
1. /ready and /health schemas are out of date
Problem
src/common/schemas/Ready.yml and src/common/paths/ready.yml haven't changed since 2021-03.
main-2.x returns fields and states that neither contract describes.
HEALTH_READY.md in main-2.x documents the same behavior.
influxdata/docs-v2#7286 added some of these changes by editing the OSS spec in docs-v2 directly.
The next sync from this repo would overwrite them, so the change belongs here.
Verification
/ready during startup returns 503:
{"status":"starting","started":"2026-10-08T17:54:06.861243-05:00","up":"48.001208ms",
"uptime":{"value":0.048001208,"unit":"seconds"},
"checks":[{"name":"shards","status":"fail","message":"waiting for shard enumeration",
"progress":{"completed":0,"total":0,"unit":"shards"}}, ...]}
/ready after startup returns 200 with status, started, up, and uptime, and no checks.
/health returns 200 with a failures object in the shards check, plus version and commit:
{"name":"influxdb","status":"pass","message":"healthy",
"checks":[{"name":"shards","status":"pass","failures":{"count":0,"unit":"shards"}}, ...],
"version":"dev","commit":"none"}
After a failed startup, /health returns 503 with status: fail, and the failing check's message contains the raw error.
With --startup-error-linger, both endpoints keep serving for the linger window before influxd exits.
With --health-auth-mode=required, the status code stays the same for every caller.
Only a caller with an operator token receives check messages, measure groups, version, and commit.
Every other caller receives check names and statuses only.
I tested with no token, a read-only token, an invalid token, and an operator token.
Suggested solution
Update the common /ready and /health schemas and paths to cover:
- The
503response on/ready, withstatus: startingand only the failing checks inchecks. uptimeon/ready, as{"value": <seconds>, "unit": "seconds"}.- The measure-group objects on checks, such as
progressandfailures. versionandcommiton/health.- A description note:
--health-auth-modeand--hardening-enabledreduce the response body for callers without operator permissions, and never change the status code.
After the change ships, docs-v2 closes influxdata/docs-v2#7286 and picks up the change through a normal sync.
- 主要语言
- Shell
- 星标
- 18
- 派生
- 9
- 平均合并
- 4 天 11 小时
- 30 天内合并 PR
- 4
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
influxdata/openapi 的其他 Issue
-
documentation
难度 2/5 1-3 小时 新手友好度 76/100
influxdata/openapi#657 ·
-
难度 1/5 1-3 小时 新手友好度 85/100
influxdata/openapi#653 ·
-
难度 1/5 1 小时以内 新手友好度 65/100
influxdata/openapi#240 ·
-
难度 4/5 3-5 天 新手友好度 25/100
influxdata/openapi#636 ·
-
难度 2/5 1-3 小时 新手友好度 45/100
influxdata/openapi#622 ·
查看 influxdata/openapi 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
bioconda/bioconda-recipes#70401 ·
维护者通常 2 天内回复
-
bisect
难度 2/5 1-3 小时 新手友好度 72/100
dtcxzyw/llvm-bisect-service#548 ·
-
area/agent status/need-triage
难度 2/5 1-3 小时 新手友好度 84/100
google-gemini/gemini-cli#29811 ·
维护者通常 2 天内回复
-
keypunch未关闭
难度 1/5 1 小时以内 新手友好度 88/100
-
难度 2/5 1-3 小时 新手友好度 88/100
amnezia-vpn/amnezia-client#3297 · 1 条评论 ·
维护者通常 1 天内回复