Skip to content

[ENH]: add readiness probe for garbage collector #4662

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.

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

Merged
merged 1 commit into from
May 29, 2025

Conversation

codetheweb
Copy link
Contributor

Description of changes

Adds a readiness probe for GC.

Test plan

How are these changes tested?

Verified that the service was marked ready using kubectl.

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?
n/a

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link

github-actions bot commented May 29, 2025

✅ The Helm chart's version was changed. Your changes to the chart will be published upon merge to main.

Copy link
Contributor

propel-code-bot bot commented May 29, 2025

Add Readiness Probe to Garbage Collector Service

This PR introduces a readiness probe to the garbage collector component in the Chroma distributed system, enabling Kubernetes to verify when the garbage collector service is ready to accept traffic. The implementation involves adding a minimal gRPC health service and configuring the Helm and k8s manifests accordingly, with corresponding updates to Rust, proto, and configuration code.

Key Changes:
• Added a gRPC health/readiness probe to the garbage collector by implementing a minimal service in Rust and exposing a corresponding health endpoint.
• Updated Kubernetes Helm chart and garbage-collector YAML to specify a readinessProbe using gRPC on port 50055.
• Created a new proto definition for the (placeholder) garbage_collector service and updated Rust proto generation accordingly.
• Extended garbage collector configuration to support the probe port.
• Added tonic-health as a dependency and updated the Rust service entrypoint to start the health server in parallel to the main service logic.

Affected Areas:
• garbage_collector Rust crate (src/lib.rs, config.rs, garbage_collector_component.rs)
• Kubernetes manifests (k8s/distributed-chroma/templates/garbage-collector.yaml, Chart.yaml)
• Protobuf definitions (idl/chromadb/proto/garbage_collector.proto, rust/types/build.rs, rust/types/src/lib.rs)
• Cargo manifest (rust/garbage_collector/Cargo.toml)
• Cargo.lock

This summary was automatically generated by @propel-code-bot

@codetheweb codetheweb force-pushed the feat-gc-readiness-probe branch 2 times, most recently from d7aba55 to 9e68ab9 Compare May 29, 2025 00:32
@codetheweb codetheweb requested a review from Sicheng-Pan May 29, 2025 00:32
@codetheweb codetheweb force-pushed the feat-gc-readiness-probe branch from 9e68ab9 to d71fd60 Compare May 29, 2025 17:23
@codetheweb codetheweb force-pushed the feat-gc-readiness-probe branch from d71fd60 to 18e5536 Compare May 29, 2025 17:34
@@ -47,6 +47,7 @@ pub use tenant::*;
pub use types::*;
pub use where_parsing::*;

#[allow(clippy::all)]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is needed to ignore a new warning in the prost-genenerated code--happens because we have a service with no methods and prost generates slightly unidiomatic code

@codetheweb codetheweb enabled auto-merge (squash) May 29, 2025 17:36
@codetheweb codetheweb merged commit f58eea6 into main May 29, 2025
71 checks passed
@codetheweb codetheweb deleted the feat-gc-readiness-probe branch May 29, 2025 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants