risingwave_error/tonic/
extra.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use serde::{Deserialize, Serialize};
16
17/// The score of the error.
18///
19/// Currently, it's used to identify the root cause of streaming pipeline failures, i.e., which actor
20/// led to the failure.
21#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
22pub struct Score(pub i32);
23
24/// A error with a score, used to find the root cause of multiple failures.
25#[derive(Debug, Clone)]
26pub struct ScoredError<E> {
27    pub error: E,
28    pub score: Score,
29}
30
31impl<E: std::fmt::Display> std::fmt::Display for ScoredError<E> {
32    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
33        self.error.fmt(f)
34    }
35}
36
37impl<E: std::error::Error> std::error::Error for ScoredError<E> {
38    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
39        self.error.source()
40    }
41
42    fn provide<'a>(&'a self, request: &mut std::error::Request<'a>) {
43        self.error.provide(request);
44        // HIGHLIGHT: Provide the score to make it retrievable from meta service.
45        request.provide_value(self.score);
46    }
47}
48
49/// Extra fields in errors that can be passed through the gRPC boundary.
50///
51/// - Field being set to `None` means it is not available.
52/// - To add a new field, also update the `provide` method.
53#[derive(Debug, Default, Clone, Serialize, Deserialize)]
54pub(super) struct Extra {
55    pub score: Option<Score>,
56}
57
58impl Extra {
59    /// Create a new [`Extra`] by [requesting](std::error::request_ref) each field from the given error.
60    pub fn new<T>(error: &T) -> Self
61    where
62        T: ?Sized + std::error::Error,
63    {
64        Self {
65            score: std::error::request_value(error),
66        }
67    }
68
69    /// Provide each field to the given [request](std::error::Request).
70    pub fn provide<'a>(&'a self, request: &mut std::error::Request<'a>) {
71        if let Some(score) = self.score {
72            request.provide_value(score);
73        }
74    }
75}
risingwave_error/tonic/extra.rs

risingwave_error/tonic/
extra.rs
