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

refactor: sink metrics #18730

Merged
merged 10 commits into from
Sep 26, 2024
Merged

refactor: sink metrics #18730

merged 10 commits into from
Sep 26, 2024

Conversation

fuyufjh
Copy link
Member

@fuyufjh fuyufjh commented Sep 26, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Background

In other places (such as source), the usage of metrics is generally as follows:

  • Inside SourceMetrics, there is a pair of MetricsVec instead of actual Metrics.
  • Only when it comes to the specific working struct, build the actual Metrics from MetricsVec with particular labels.

While, on the sink side, SinkMetrics directly consist of a collection of Metrics.

What's in this PR

  • Refactor SinkMetrics from a set of Metrics to a set of MetricVec
  • Introduce a GLOBAL_SINK_METRICS
  • Move the real Metrics into separated places:
    • SinkWriterMetrics for general sink metrics
    • LogWriterMetrics
    • LogReaderMetrics
    • Iceberg sink related metrics are in multiple places. See iceberg/mod.rs for details

This will also resolve the issue discussed at #17812 (comment), because it follows the standard pattern of #14838.

Follow-ups

  • The metrics labels were a bit messy. I'd like to do a bit refactoring on them in future PR.

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

Copy link
Contributor

@wenym1 wenym1 left a comment

Choose a reason for hiding this comment

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

Rest LGTM!

@@ -218,12 +219,33 @@ impl<F: LogStoreFactory> SinkExecutor<F> {
if self.sink.is_sink_into_table() {
processed_input.boxed()
} else {
let labels = [
&actor_id.to_string(),
"NA", // TODO: remove the connector label for log writer metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason to erase the connector label?

We can get the connector label easily from self.sink, which can be supported by implementing the following method for Sinkimpl

impl SinkImpl {
    pub fn sink_name(&self) -> &'static str {
        fn get_sink_name<S: Sink>(_sink: &S) -> &'static str {
            S::SINK_NAME
        }

        dispatch_sink!(self, sink, get_sink_name(&**sink))
    }
}

Copy link
Member Author

Choose a reason for hiding this comment

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

Can do. I was thinking that, for LogWriterMetrics, it's supposed to be unaware of the log reader i.e. the actual Sink implementation.

Also, the sink_name is here, which I think is enough for users.

@fuyufjh fuyufjh added this pull request to the merge queue Sep 26, 2024
Merged via the queue into main with commit 39141cc Sep 26, 2024
34 of 35 checks passed
@fuyufjh fuyufjh deleted the eric/refactor_sink_metrics branch September 26, 2024 12:55
@fuyufjh fuyufjh mentioned this pull request Sep 29, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants