Skip to content
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

chore: add more metrics about parquet and cache #4410

Merged
merged 5 commits into from
Jul 30, 2024

Conversation

MichaelScofield
Copy link
Collaborator

@MichaelScofield MichaelScofield commented Jul 22, 2024

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?

as title

useful for diagnosing slow queries

Checklist

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.

Summary by CodeRabbit

  • New Features

    • Introduced a cache eviction metric for improved monitoring of cache performance.
    • Added a histogram metric to measure the time taken for loading Parquet metadata.
  • Improvements

    • Enhanced observability of cache eviction reasons for better diagnostics.
    • Implemented performance tracking in the MetadataLoader for metadata loading efficiency.

Copy link
Contributor

coderabbitai bot commented Jul 22, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes improve the caching system's monitoring capabilities by adding metrics for cache evictions and performance tracking during Parquet metadata loading. The CacheManagerBuilder now logs eviction reasons more effectively, while new metrics provide insights into cache behavior and loading efficiency. These enhancements allow developers to better diagnose performance issues, leading to improved overall system observability.

Changes

Files Change Summary
src/cache.rs Enhanced CacheManagerBuilder to include CACHE_EVICTION metric for improved logging of eviction causes.
src/mito2/src/metrics.rs Introduced CACHE_EVICTION counter and PARQUET_METADATA_LOAD_ELAPSED histogram for monitoring cache evictions and metadata loading times.
src/sst/parquet/metadata.rs Added performance monitoring in MetadataLoader for Parquet metadata loading using the new histogram metric.

Poem

🐇 In the meadow where bunnies play,
Metrics bloom in a lively array.
Evictions tracked with a hop and a cheer,
Loading data faster, the path is now clear!
Cache and metadata, a dance so bright,
Observability shines in the soft moonlight! ✨


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jul 22, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ae2a66 and 6b8e099.

Files selected for processing (3)
  • src/mito2/src/cache.rs (2 hunks)
  • src/mito2/src/metrics.rs (2 hunks)
  • src/mito2/src/sst/parquet/metadata.rs (2 hunks)
Additional comments not posted (8)
src/mito2/src/sst/parquet/metadata.rs (2)

71-72: LGTM!

The timer for the PARQUET_METADATA_LOAD_ELAPSED metric is correctly started to measure the duration of the metadata loading process.


22-22: LGTM! Verify the metric initialization.

The PARQUET_METADATA_LOAD_ELAPSED metric is correctly introduced.

Ensure that the metric is properly initialized in the metrics module.

Verification successful

Metric initialization verified.

The PARQUET_METADATA_LOAD_ELAPSED metric is properly initialized in the metrics module and used correctly in the code.

  • Initialization found in src/mito2/src/metrics.rs:
    pub static ref PARQUET_METADATA_LOAD_ELAPSED: Histogram = register_histogram!(
        "greptime_parquet_metadata_load_elapsed",
        "parquet metadata load elapsed",
    ).unwrap();
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the `PARQUET_METADATA_LOAD_ELAPSED` metric is properly initialized in the metrics module.

# Test: Search for the metric initialization. Expect: Initialization code for the metric.
rg --type rust 'PARQUET_METADATA_LOAD_ELAPSED' -A 3

Length of output: 987

src/mito2/src/cache.rs (4)

212-219: LGTM!

The eviction_listener for sst_meta_cache correctly logs eviction reasons using the CACHE_EVICTION metric.


227-234: LGTM!

The eviction_listener for vector_cache correctly logs eviction reasons using the CACHE_EVICTION metric.


242-247: LGTM!

The eviction_listener for page_cache correctly logs eviction reasons using the CACHE_EVICTION metric.


37-37: LGTM! Verify the metric initialization.

The CACHE_EVICTION metric is correctly introduced.

Ensure that the metric is properly initialized in the metrics module.

Verification successful

The CACHE_EVICTION metric is properly initialized and used.

  • Initialization found in src/mito2/src/metrics.rs:

    pub static ref CACHE_EVICTION: IntGaugeVec = register_int_gauge_vec!(
        "greptime_mito_cache_eviction",
        "mito cache eviction",
        &[TYPE_LABEL, "cause"]
    );
  • Usage found in src/mito2/src/cache.rs.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the `CACHE_EVICTION` metric is properly initialized in the metrics module.

# Test: Search for the metric initialization. Expect: Initialization code for the metric.
rg --type rust 'CACHE_EVICTION' -A 3

Length of output: 1341

src/mito2/src/metrics.rs (2)

193-198: LGTM!

The CACHE_EVICTION metric is correctly introduced and initialized to track cache evictions.


324-328: LGTM!

The PARQUET_METADATA_LOAD_ELAPSED metric is correctly introduced and initialized to measure the elapsed time for loading Parquet metadata.

Copy link

codecov bot commented Jul 22, 2024

Codecov Report

Attention: Patch coverage is 89.65517% with 3 lines in your changes missing coverage. Please review.

Project coverage is 85.02%. Comparing base (4cd5ec7) to head (85d6617).
Report is 22 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4410   +/-   ##
=======================================
  Coverage   85.02%   85.02%           
=======================================
  Files        1075     1075           
  Lines      192542   192567   +25     
=======================================
+ Hits       163709   163739   +30     
+ Misses      28833    28828    -5     

src/mito2/src/metrics.rs Outdated Show resolved Hide resolved
src/mito2/src/cache.rs Show resolved Hide resolved
@MichaelScofield
Copy link
Collaborator Author

@v0y4g3r PTAL

src/mito2/src/metrics.rs Outdated Show resolved Hide resolved
@MichaelScofield
Copy link
Collaborator Author

@evenyag PTAL

src/mito2/src/metrics.rs Outdated Show resolved Hide resolved
@MichaelScofield
Copy link
Collaborator Author

@evenyag PTAL

src/mito2/src/cache.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@v0y4g3r v0y4g3r left a comment

Choose a reason for hiding this comment

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

LGTM

@MichaelScofield MichaelScofield added this pull request to the merge queue Jul 30, 2024
Merged via the queue into main with commit 6d8a502 Jul 30, 2024
53 checks passed
@MichaelScofield MichaelScofield deleted the chore/more-metrics branch July 30, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants