feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655

Merged
jarvis9443 merged 2 commits into
mainfrom
feat/readyz-endpoint
Jun 26, 2026
Merged

feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom
feat/readyz-endpoint

Conversation

@jarvis9443

@jarvis9443jarvis9443 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Problem

/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).

Change

Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):

  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.

  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:

    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),

    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.

OpenAPI documents /livez 503 and the new /readyz path.

Tests

  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.

Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.

A paired api7/docs PR updates the health-check docs (liveness vs readiness).

Fixes#591

@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai

coderabbitaiBot commented Jun 26, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0

📥 Commits

Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.

📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/readyz-endpoint

Comment @coderabbitai help to get the list of available commands.

@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443 merged commit 2cdf236 into mainJun 26, 2026
12 checks passed
@jarvis9443
jarvis9443 deleted the feat/readyz-endpoint branch June 26, 2026 09:51
This was referenced Jul 2, 2026
Closed
Merged
@jarvis9443jarvis9443 mentioned this pull request Jul 10, 2026
Open
@jarvis9443jarvis9443 mentioned this pull request Aug 4, 2026
Merged
@jarvis9443jarvis9443 mentioned this pull request Aug 25, 2026
Merged
jarvis9443 added a commit that referenced this pull request Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state

1 participant

@jarvis9443
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(health): add /readyz and return 503 (not 500) on graceful shutdown - #655
Merged
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Jun 26, 2026
Merged
feat(health): add /readyz and return 503 (not 500) on graceful shutdown#655
jarvis9443 merged 2 commits into
mainfrom 
feat/readyz-endpoint
Conversation
@jarvis9443
@jarvis9443jarvis9443
commented
Jun 26, 2026

Copy link


Copy Markdown

Contributor
Problem
/livez represented intentional graceful shutdown as 500 Internal Server Error. That fails Kubernetes probes (any non-2xx/3xx does), but it's semantically wrong — a drain is an expected state, not an internal crash — and it conflates liveness (restart me) with readiness (stop sending traffic).
Change
Following LiteLLM (separate /health/liveliness + /health/readiness, both 503 on drain):
  • /livez returns 503, not 500, during graceful shutdown (proxy + admin). Liveness otherwise stays 200.
  • New /readyz endpoint (proxy + admin) for traffic eligibility, distinct from liveness. Returns 503 when:
    • draining (graceful shutdown),
    • the config watch hasn't applied yet (startup),
    • the config snapshot is stale (> 300s — a wedged watch),
    and 200 otherwise. The proxy reads config freshness through a probe wired from the watch supervisor (with_config_apply_age); the admin reads it from its existing watch status. When no freshness signal is wired, readiness gates on shutdown only.
OpenAPI documents /livez 503 and the new /readyz path.
Tests
  • Unit: livez_response 503 on shutdown (proxy + admin), readyz_response (ready / draining / config-not-ready), config_readiness_block thresholds, and the openapi path/response assertions.
  • DP e2e (health-minimal): /readyz reports ready once config is applied on both listeners.
Verified locally: cargo test -p aisix-proxy -p aisix-admin, cargo fmt --check, cargo clippy, and the e2e (vitest run health-minimal) against a real aisix binary + etcd.
A paired api7/docs PR updates the health-check docs (liveness vs readiness).
Fixes#591
@jarvis9443
feat(health): add /readyz and 503 (not 500) on graceful shutdown
d20c2db
/livez represented graceful shutdown as 500 Internal Server Error —
mechanically enough to fail k8s probes, but semantically wrong: a drain
is expected, not a crash. Return 503 instead, on both the proxy and admin
listeners.
Add a /readyz readiness endpoint (proxy + admin) for traffic eligibility,
distinct from /livez liveness. It returns 503 while draining, before the
first config apply (startup), or when the etcd config watch is stale
(> 300s). The proxy reads config freshness through a probe wired from the
watch supervisor; the admin reads it from its watch status. OpenAPI now
documents /livez 503 and the /readyz path.
@coderabbitai
coderabbitaiBot
commented
Jun 26, 2026•

edited

Loading

Copy link


Copy Markdown

Warning
Review limit reached
@jarvis9443, we couldn't start this review because you've reached your PR review rate limit.
More reviews will be available in 13 minutes and 14 seconds. Learn how PR review limits work.
Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).
⌛ How to resolve this issue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.
🚦 How do rate limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Please see our Fair Usage Limits Policy for further information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 40db9029-7c3b-4f07-bb5d-9702d0a963b0
📥 Commits
Reviewing files that changed from the base of the PR and between 9dea4a3 and e42e18a.
📒 Files selected for processing (7)
  • crates/aisix-admin/src/lib.rs
  • crates/aisix-admin/src/openapi.rs
  • crates/aisix-proxy/src/health.rs
  • crates/aisix-proxy/src/lib.rs
  • crates/aisix-proxy/src/state.rs
  • crates/aisix-server/src/main.rs
  • tests/e2e/src/cases/health-minimal-e2e.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch feat/readyz-endpoint
Comment @coderabbitai help to get the list of available commands.
@jarvis9443
Merge remote-tracking branch 'origin/main' into feat/readyz-endpoint
e42e18a
# Conflicts:
#	tests/e2e/src/cases/health-minimal-e2e.test.ts
@jarvis9443
jarvis9443
merged commit 2cdf236
into
mainJun 26, 2026

12 checks passed

@jarvis9443
jarvis9443
deleted the

feat/readyz-endpoint

branch
June 26, 2026 09:51

This was referenced Jul 2, 2026

Closed

 Merged

@jarvis9443jarvis9443
mentioned this pull request
Jul 10, 2026

Open

@jarvis9443jarvis9443
mentioned this pull request
Aug 4, 2026
 Merged

@jarvis9443jarvis9443
mentioned this pull request
Aug 25, 2026
 Merged

jarvis9443 added a commit
that referenced
this pull request
Aug 29, 2026
@jarvis9443
test(usage): take the served attempt's usage event, not the first one
42a874a
Every attempt emits its own UsageEvent (#655), so a connection hiccup
against the mock server puts a failed attempt's zeroed event on the
channel ahead of the real one. The matrix read the first event and
asserted upstream token counts on it, which passed locally and failed
intermittently under CI load — on the responses verbatim-streaming cell,
reporting a completion-token mismatch that had nothing to do with the
projection under test.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Use readiness semantics or 503 for graceful shutdown health state


1 participant

@jarvis9443