Skip to content

[ENH] Implement compactor server interface #3375

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

Jump to bottom
Merged
merged 4 commits into from
Jan 21, 2025
Merged

[ENH] Implement compactor server interface #3375

merged 4 commits into from
Jan 21, 2025

Conversation

Sicheng-Pan
Copy link
Contributor

@Sicheng-Pan Sicheng-Pan commented Dec 31, 2024 •
edited
Loading

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • N/A
  • New functionality
    • We would like to manually start a compaction on certain collections. This PR is the first in the stack to implement this feature. Specifically, it:
      • Introduces the grpc interface for compactor. Currently there is only a single variant of request that allows the user to specify an optional list of collection ids for compaction.
      • Implements the CompactionServer struct in rust that implements this interface. It receives the request and send it to the running CompactionManager
      • The next PRs will handle the request in CompactionManager.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

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

@github-actions GitHub Actions
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)

@Sicheng-Pan Graphite App
Copy link
Contributor Author

Sicheng-Pan commented Dec 31, 2024 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

HammadB
HammadB reviewed Dec 31, 2024
View reviewed changes
idl/chromadb/proto/compactor.proto
@@ -0,0 +1,19 @@
syntax = "proto3";
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe as future work it would be useful to add an endpoint to see the status for the currently compacting and last N compactions

Copy link
Collaborator

@HammadB HammadB Dec 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I.e

/compaction/status

returns

id: <QUEUED | RUNNING | FAILED | SUCCEEDED> + Time

@Sicheng-Pan Sicheng-Pan marked this pull request as ready for review December 31, 2024 19:07
@Sicheng-Pan Sicheng-Pan mentioned this pull request Dec 31, 2024
Merged
1 task
@Sicheng-Pan Sicheng-Pan force-pushed the 12-30-_enh_implement_compactor_server_interface branch 2 times, most recently from 6adc66c to f04bbfa Compare January 10, 2025 00:16
@Sicheng-Pan Sicheng-Pan mentioned this pull request Jan 10, 2025
Merged
1 task
HammadB
HammadB reviewed Jan 14, 2025
View reviewed changes
rust/worker/src/compactor/compaction_manager.rs
_message: OneOffCompactionMessage,
_ctx: &ComponentContext<CompactionManager>,
) {
tracing::info!("CompactionManager: Performing compaction");
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think that this should not synchronously perform compaction but instead queue the id for compaction in the next scheduled run

Copy link
Contributor Author

@Sicheng-Pan Sicheng-Pan Jan 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

In the next run all eligible compaction will be compacted, which always include any valid collection uuid that may be specified by the manual compaction interface

Will queue the one-off collection and compact during scheduled compaction

HammadB
HammadB reviewed Jan 14, 2025
View reviewed changes
rust/worker/src/compactor/compaction_manager.rs Outdated
tracing::info!("CompactionManager: Performing compaction");
let mut ids = Vec::new();
self.compact_batch(&mut ids).await;
self.hnsw_index_provider.purge_by_id(&ids).await;
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is brittle and ideally we shouldn't have to rewrite this - suggest we queue up one offs instead of making them sync

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will update this in the next PR on the stack. This is only a template impl

@Sicheng-Pan Sicheng-Pan force-pushed the 12-30-_enh_implement_compactor_server_interface branch from f04bbfa to ccf3eb3 Compare January 14, 2025 22:30
@Sicheng-Pan Sicheng-Pan force-pushed the 12-30-_enh_implement_compactor_server_interface branch from 2245609 to b9521bc Compare January 21, 2025 21:47
@Sicheng-Pan
Copy link
Contributor Author

Sicheng-Pan commented Jan 21, 2025 •
edited
Loading

Merge activity

  • Jan 21, 5:43 PM EST: A user started a stack merge that includes this pull request via Graphite.
  • Jan 21, 5:44 PM EST: A user merged this pull request with Graphite.

@Sicheng-Pan Sicheng-Pan merged commit fcd258e into main Jan 21, 2025
81 checks passed
Sicheng-Pan added a commit that referenced this pull request Jan 21, 2025
@Sicheng-Pan
[ENH] Handle one-off compaction message in compaction manager (#3379)
be27c46 
## Description of changes

*Summarize the changes made by this PR.*
 - Improvements & Bug fixes
   - N/A
 - New functionality
   - Following [the previous PR](#3375), this PR implements the logic to handle one-off compaction message in the compaction manager. It adds the collection ids to the scheduler, which will whitelist the collections for the next compaction run only.
## Test plan
*How are these changes tested?*

- [ ] Tests pass locally with `pytest` for python, `yarn test` for js, `cargo test` for rust

## Documentation Changes
*Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the [docs repository](https://github.com/chroma-core/docs)?*
@Sicheng-Pan Sicheng-Pan deleted the 12-30-_enh_implement_compactor_server_interface branch February 11, 2025 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HammadB HammadB HammadB 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
@Sicheng-Pan @HammadB