Skip to content

feat: add /lean/v0/ready endpoint for readiness checks #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
chetanyb wants to merge 1 commit into from
Closed

feat: add /lean/v0/ready endpoint for readiness checks #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion pkgs/cli/src/api_server.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ fn routeConnection(connection: std.net.Server.Connection, allocator: std.mem.All

if (std.mem.eql(u8, request.head.target, "/lean/v0/health")) {
ctx.handleHealth(&request);
} else if (std.mem.eql(u8, request.head.target, "/lean/v0/ready")) {
ctx.handleReady(&request);
} else if (std.mem.eql(u8, request.head.target, "/lean/v0/states/finalized")) {
ctx.handleFinalizedCheckpointState(&request) catch |err| {
ctx.logger.warn("failed to handle finalized checkpoint state request: {}", .{err});
Expand Down Expand Up @@ -236,7 +238,7 @@ pub const ApiServer = struct {
}
}

/// Handle health check endpoint
/// Handle health check endpoint (liveness)
fn handleHealth(_: *const Self, request: *std.http.Server.Request) void {
const response = "{\"status\":\"healthy\",\"service\":\"zeam-api\"}";
_ = request.respond(response, .{
Expand All @@ -246,6 +248,25 @@ pub const ApiServer = struct {
}) catch {};
}

/// Handle readiness check endpoint
/// Returns 200 if chain is initialized and ready to serve requests, 503 otherwise
fn handleReady(self: *const Self, request: *std.http.Server.Request) void {
if (self.getChain()) |_| {
_ = request.respond("{\"ready\":true}", .{
.extra_headers = &.{
.{ .name = "content-type", .value = "application/json; charset=utf-8" },
},
}) catch {};
} else {
_ = request.respond("{\"ready\":false}", .{
.status = .service_unavailable,
.extra_headers = &.{
.{ .name = "content-type", .value = "application/json; charset=utf-8" },
},
}) catch {};
}
}

/// Handle finalized checkpoint state endpoint
/// Serves the finalized checkpoint lean state (BeamState) as SSZ octet-stream at /lean/v0/states/finalized
fn handleFinalizedCheckpointState(self: *const Self, request: *std.http.Server.Request) !void {
Expand Down
Loading