Skip to content

feat(clp-package): Add healthcheck to api-server service in Docker Compose (fixes #1608).#1612

Merged
junhaoliao merged 1 commit into
y-scope:mainfrom
junhaoliao:api-server-compose-health
Nov 17, 2025
Merged

feat(clp-package): Add healthcheck to api-server service in Docker Compose (fixes #1608).#1612
junhaoliao merged 1 commit into
y-scope:mainfrom
junhaoliao:api-server-compose-health

Conversation

@junhaoliao

@junhaoliao junhaoliao commented Nov 16, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

This enables proper monitoring of api-server service health status during Docker Compose orchestration.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

task
cd build/clp-package
./sbin/start-clp.sh

# observed the package was started successfully

the API server also reported health:
 ✔ Container clp-package-43cd-api-server-1                     Healthy                                                                                                                        13.9s

Summary by CodeRabbit

Release Notes

  • Chores
    • Enhanced API server health monitoring by implementing automated health checks to detect service availability and improve system reliability.

@coderabbitai

coderabbitai Bot commented Nov 16, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

Adds a healthcheck configuration to the api-server service in the Docker Compose file that periodically verifies the service availability by making HTTP requests to the /health endpoint on port 3001.

Changes

Cohort / File(s) Summary
Docker Compose Configuration
tools/deployment/package/docker-compose-all.yaml		 Added healthcheck block to api-server service using curl to test the /health endpoint at http://api_server:3001/health

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a healthcheck to the api-server service in Docker Compose, with clear reference to the related issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27ba1ae and 1d9e707.

📒 Files selected for processing (1)
  • tools/deployment/package/docker-compose-all.yaml (1 hunks)
🔇 Additional comments (1)
tools/deployment/package/docker-compose-all.yaml (1)

516-523: Healthcheck configuration verified and is correct—no issues found.

Verification confirms that both requirements are met:

  1. ✅ curl is available in the api-server container image—it is explicitly installed via apt-get in ./tools/docker-images/clp-package/setup-scripts/install-prebuilt-packages.sh
  2. ✅ The /health endpoint is properly implemented in components/api-server/src/bin/api_server.rs (lines 103–104), with a valid handler function that returns a success response

The healthcheck configuration will function as expected.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@junhaoliao junhaoliao marked this pull request as ready for review November 16, 2025 17:56
@junhaoliao junhaoliao requested a review from a team as a code owner November 16, 2025 17:56
@junhaoliao junhaoliao requested a review from hoophalab November 16, 2025 17:56
@junhaoliao junhaoliao merged commit 98d56c8 into y-scope:main Nov 17, 2025
21 of 22 checks passed
@junhaoliao junhaoliao deleted the api-server-compose-health branch November 17, 2025 16:45
junhaoliao added a commit to junhaoliao/clp that referenced this pull request May 17, 2026
@junhaoliao
feat(clp-package): Add healthcheck to api-server service in Docker Co…
520c25f 
…mpose (fixes y-scope#1608). (y-scope#1612)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hoophalab hoophalab hoophalab approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@junhaoliao @hoophalab