GreptimeTeam / greptimedb

An Open-Source, Cloud-Native, Unified Time Series Database for Metrics, Events, and Logs with SQL/PromQL supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
4k stars 289 forks source link

feat: inverted index cache #4259

Closed v0y4g3r closed 2 weeks ago

v0y4g3r commented 2 weeks ago

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Add iverted index cache

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The recent changes introduce caching and metric functionalities to the Greptime project, focusing on improving performance and monitoring. Key additions include workspace dependencies for moka, prometheus, and uuid to support these features. Advanced functionalities for reading, indexing, and caching data in the inverted index are implemented. Enhanced caching mechanisms aim to reduce redundant reads, while Prometheus metrics enable monitoring of cache statistics. Refinements in existing modules ensure smooth integration of these functionalities.

Changes

File Groupings Change Summaries
src/index/Cargo.toml Added dependencies: moka, prometheus, and uuid.
src/index/src/inverted_index.rs Introduced a new metrics module.
src/index/src/inverted_index/format/reader.rs Added read_all, seek_read methods; renamed metadata method; adjusted fst and bitmap methods.
src/index/src/inverted_index/format/reader/blob.rs Updated InvertedIndexBlobReader with new methods and logic for reading data.
src/index/src/inverted_index/format/reader/cache.rs Implemented caching mechanisms via CachedInvertedIndexBlobReader and InvertedIndexCache.
src/index/src/inverted_index/format/writer/blob.rs Modified fst and bitmap function calls to include offset and size parameters.
src/index/src/inverted_index/metrics.rs Introduced Prometheus metrics for cache tracking via INDEX_CACHE_STATS.
src/index/src/inverted_index/search/fst_values_mapper.rs Adjusted base offset calculation and closure arguments in the bitmap method.
src/index/src/inverted_index/search/index_apply/predicates_apply.rs Updated IndexApplier implementation for FST offset and size handling.
src/mito2/src/cache.rs Added index_cache field and methods in CacheManager; initialized InvertedIndexCache.
src/mito2/src/read/scan_region.rs Introduced index_cache variable in ScanRegion.
src/mito2/src/sst/file.rs Added impl From<FileId> for Uuid.
src/mito2/src/sst/index/applier.rs Added index_cache field in SstIndexApplier; updated apply method.
src/mito2/src/sst/index/applier/builder.rs Enhanced SstIndexApplierBuilder to include index_cache field and parameter.
Multiple src/mito2/src/sst/index/applier/builder/* Files Added None parameter in test function calls.
src/mito2/src/sst/index/creator.rs Loaded InvertedIndexCache and passed as an argument in tests.
src/puffin/Cargo.toml Updated async-compression dependency with futures-io and zstd features.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant CacheManager
    participant InvertedIndexCache
    participant Metrics

    Client->>CacheManager: Initialize Index Cache
    CacheManager->>InvertedIndexCache: Create Cache Instance
    CacheManager->>Metrics: Register Cache Metrics

    Client->>CacheManager: Request Data
    CacheManager->>InvertedIndexCache: Check Cache for Data
    alt Data in Cache
        InvertedIndexCache->>CacheManager: Return Data
        CacheManager->>Client: Deliver Cached Data
    else Data not in Cache
        InvertedIndexCache->>CacheManager: Indicate Cache Miss
        CacheManager->>Client: Fetch Data from Source
        CacheManager->>InvertedIndexCache: Store Data in Cache
    end

    Metrics->>Client: Provide Cache Metrics
sequenceDiagram
    participant Prometheus
    participant Metrics
    participant Client

    Prometheus->>Metrics: Request Cache Metrics
    Metrics->>Client: Generate Cache Stats
    Client->>Metrics: Report Cache Stats
    Metrics->>Prometheus: Send Cache Statistics

Poem

In the fields of code where rabbits delight,
New caches bloom, metrics in sight.
With moka, prometheus, and uuid in tow,
Our project leaps with a performance glow.
No more redundant reads, we cheer,
Bytes saved, the future's clear!
Hopping fast and coding dear.

[!TIP]

AI model upgrade ## `gpt-4o` model for reviews and chat is now live OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide any feedback or to report any issues.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
v0y4g3r commented 2 weeks ago

@coderabbitai review

coderabbitai[bot] commented 2 weeks ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.