search

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: add path prefix label to obejct storage metrics #4277

Closed sunng87 closed 1 week ago

sunng87 commented 1 week 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?

This patch add a path label to object store related prometheus metrics, so that we can observe which path has most writes/reads.

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The recent changes enhance the object-store module by introducing the extract_parent_path function, which extracts parent paths from object storage operations. Additionally, Prometheus metrics are refined to include path-specific labels, providing more detailed insights into operations based on paths. These changes aim to improve path handling and monitoring granularity inside the module.

Changes

File Path Change Summary
src/object-store/src/util.rs Added extract_parent_path function with tests and refined normalize_path function with additional comments.
src/object-store/src/layers/prometheus.rs Enhancements to Prometheus metrics tracking by adding "path" as a label value in various functions and methods.

Poem

In the forest of code so fine,
Paths converge, metrics align.
Parent paths we now unveil,
Monitoring each with detail.
Prometheus smiles, paths no longer coy,
Every change a tune, coding's joy 🎶.

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.
codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 49.20635% with 64 lines in your changes missing coverage. Please review.

Project coverage is 84.67%. Comparing base (b5c6c72) to head (7e98924).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4277 +/- ## ========================================== - Coverage 84.94% 84.67% -0.28% ========================================== Files 1061 1061 Lines 188105 188201 +96 ========================================== - Hits 159795 159352 -443 - Misses 28310 28849 +539 ```
evenyag commented 1 week ago

The official PrometheusLayer already supports this, I think we should switch to it https://docs.rs/opendal/latest/opendal/layers/struct.PrometheusLayer.html#method.enable_path_label

sunng87 commented 1 week ago

According to the patch comment, we forked it to avoid a panic with metrics registration. https://github.com/GreptimeTeam/greptimedb/pull/2861

Checked upstream it doesn't seem to be addressed after our fork. Also our solution, using lazy_static, is not suitable to upstream because it's not suitable for a library.

evenyag commented 1 week ago

According to the patch comment, we forked it to avoid a panic with metrics registration. #2861

Checked upstream it doesn't seem to be addressed after our fork. Also our solution, using lazy_static, is not suitable to upstream because it's not suitable for a library.

The layer itself could be cloned. So we can use lazy_static to init a global PrometheusLayer that uses the default registry. Then we can clone the global layer and reuse it.

Yes, I realized that the layer will create a PrometheusMetrics in each call to the Layer::layer() implementation. The PrometheusMetrics always registers metrics to the provided registry. However, the registry doesn't allow registering the same metric multiple times.

So we can't create multiple Operator with the same prometheus layer. https://github.com/apache/opendal/blob/174bda53f79123cd114d2409189423a0a4cf6bf3/core/src/layers/prometheus.rs#L193-L210

evenyag commented 1 week ago

According to the patch comment, we forked it to avoid a panic with metrics registration. #2861 Checked upstream it doesn't seem to be addressed after our fork. Also our solution, using lazy_static, is not suitable to upstream because it's not suitable for a library.

~The layer itself could be cloned. So we can use lazy_static to init a global PrometheusLayer that uses the default registry. Then we can clone the global layer and reuse it.~

Yes, I realized that the layer will create a PrometheusMetrics in each call to the Layer::layer() implementation. The PrometheusMetrics always registers metrics to the provided registry. However, the registry doesn't allow registering the same metric multiple times.

So we can't create multiple Operator with the same prometheus layer. https://github.com/apache/opendal/blob/174bda53f79123cd114d2409189423a0a4cf6bf3/core/src/layers/prometheus.rs#L193-L210

I created an issue for this. https://github.com/apache/opendal/issues/4854

Maybe @Xuanwo can give us some suggestions.

Xuanwo commented 1 week ago

I created an issue for this. apache/opendal#4854

Maybe @Xuanwo can give us some suggestions.

Thanks! I'm also thinking allow users to set metrics or reuse them in someway. I will give it look.

sunng87 commented 1 week ago

Actually I found the Prometheus library has a few runtime panics which I think can be avoided by design. For example, if you provide labels doesn't match the declaration, it ends up with a runtime panics, which is very dangerous for some corner cases.

Xuanwo commented 1 week ago

Actually I found the Prometheus library has a few runtime panics which I think can be avoided by design. For example, if you provide labels doesn't match the declaration, it ends up with a runtime panics, which is very dangerous for some corner cases.

Would you like to submit an issue to upstream and link back here?

evenyag commented 1 week ago

Actually I found the Prometheus library has a few runtime panics which I think can be avoided by design. For example, if you provide labels doesn't match the declaration, it ends up with a runtime panics, which is very dangerous for some corner cases.

It provides a method get_metric_with_label_values() that returns an error instead. https://docs.rs/prometheus/latest/prometheus/core/struct.MetricVec.html#method.get_metric_with_label_values

evenyag commented 1 week ago

Thanks! I'm also thinking allow users to set metrics or reuse them in someway. I will give it look.

@Xuanwo I can submit a patch for a workaround by adding a method to set the metrics.

impl PrometheusLayer {
    fn metrics(mut self, metrics: Arc<PrometheusMetrics>) -> Self {
        self.metrics = Some(metrics);
        self
    }
}

But this may not be elegant enough.

WenyXu commented 1 week ago

The CI should be fixed in main branch🥲