risingwave_pb/sim/
telemetry.rs

1// This file is @generated by prost-build.
2#[derive(prost_helpers::AnyPB)]
3#[derive(Clone, Copy, PartialEq, ::prost::Message)]
4pub struct SystemMemory {
5    #[prost(uint64, tag = "1")]
6    pub used: u64,
7    #[prost(uint64, tag = "2")]
8    pub total: u64,
9}
10#[derive(prost_helpers::AnyPB)]
11#[derive(Clone, PartialEq, ::prost::Message)]
12pub struct SystemOs {
13    #[prost(string, tag = "1")]
14    pub name: ::prost::alloc::string::String,
15    #[prost(string, tag = "2")]
16    pub version: ::prost::alloc::string::String,
17    #[prost(string, tag = "3")]
18    pub kernel_version: ::prost::alloc::string::String,
19}
20#[derive(prost_helpers::AnyPB)]
21#[derive(Clone, Copy, PartialEq, ::prost::Message)]
22pub struct SystemCpu {
23    #[prost(float, tag = "1")]
24    pub available: f32,
25}
26#[derive(prost_helpers::AnyPB)]
27#[derive(Clone, PartialEq, ::prost::Message)]
28pub struct SystemData {
29    #[prost(message, optional, tag = "1")]
30    pub memory: ::core::option::Option<SystemMemory>,
31    #[prost(message, optional, tag = "2")]
32    pub os: ::core::option::Option<SystemOs>,
33    #[prost(message, optional, tag = "3")]
34    pub cpu: ::core::option::Option<SystemCpu>,
35}
36/// NodeCount represents how many nodes in this cluster
37#[derive(prost_helpers::AnyPB)]
38#[derive(Clone, Copy, PartialEq, ::prost::Message)]
39pub struct NodeCount {
40    #[prost(uint32, tag = "1")]
41    pub meta: u32,
42    #[prost(uint32, tag = "2")]
43    pub compute: u32,
44    #[prost(uint32, tag = "3")]
45    pub frontend: u32,
46    #[prost(uint32, tag = "4")]
47    pub compactor: u32,
48}
49/// RwVersion represents the version of RisingWave
50#[derive(prost_helpers::AnyPB)]
51#[derive(Clone, PartialEq, ::prost::Message)]
52pub struct RwVersion {
53    /// Version is the Cargo package version of RisingWave
54    #[prost(string, tag = "1")]
55    pub rw_version: ::prost::alloc::string::String,
56    /// GitSHA is the Git commit SHA of RisingWave
57    #[prost(string, tag = "2")]
58    pub git_sha: ::prost::alloc::string::String,
59}
60#[derive(prost_helpers::AnyPB)]
61#[derive(Clone, PartialEq, ::prost::Message)]
62pub struct ReportBase {
63    /// tracking_id is persistent in meta data
64    #[prost(string, tag = "1")]
65    pub tracking_id: ::prost::alloc::string::String,
66    /// session_id is reset every time node restarts
67    #[prost(string, tag = "2")]
68    pub session_id: ::prost::alloc::string::String,
69    /// system_data is hardware and os info
70    #[prost(message, optional, tag = "3")]
71    pub system_data: ::core::option::Option<SystemData>,
72    /// up_time is how long the node has been running
73    #[prost(uint64, tag = "4")]
74    pub up_time: u64,
75    /// report_time is when the report is created
76    #[prost(uint64, tag = "5")]
77    pub report_time: u64,
78    /// node_type is the node that creates the report
79    #[prost(enumeration = "TelemetryNodeType", tag = "6")]
80    pub node_type: i32,
81    /// mark the report is a test message
82    /// if so, the backend do validations but not store it
83    #[prost(bool, tag = "7")]
84    pub is_test: bool,
85}
86#[derive(prost_helpers::AnyPB)]
87#[derive(Clone, PartialEq, ::prost::Message)]
88pub struct MetaReport {
89    #[prost(message, optional, tag = "1")]
90    pub base: ::core::option::Option<ReportBase>,
91    /// meta_backend is the backend of meta data
92    #[prost(enumeration = "MetaBackend", tag = "2")]
93    pub meta_backend: i32,
94    /// node_count is the count of each node type
95    #[prost(message, optional, tag = "3")]
96    pub node_count: ::core::option::Option<NodeCount>,
97    /// rw_version is the version of RisingWave
98    #[prost(message, optional, tag = "4")]
99    pub rw_version: ::core::option::Option<RwVersion>,
100    /// This field represents the "number of running streaming jobs"
101    /// and is used to indicate whether the cluster is active.
102    #[prost(uint32, tag = "5")]
103    pub stream_job_count: u32,
104    /// stream_jobs is the list of running streaming jobs
105    /// and is used to collect the table_id, connector_name and table_optimizations
106    #[prost(message, repeated, tag = "6")]
107    pub stream_jobs: ::prost::alloc::vec::Vec<StreamJobDesc>,
108    /// How the cluster is deployed
109    #[prost(enumeration = "TelemetryClusterType", tag = "7")]
110    pub cluster_type: i32,
111    /// The object store media type obtained from ObjectStore::store_media_type
112    #[prost(string, tag = "8")]
113    pub object_store_media_type: ::prost::alloc::string::String,
114    /// The connector usage of the cluster
115    #[prost(string, tag = "9")]
116    pub connector_usage_json_str: ::prost::alloc::string::String,
117}
118#[derive(prost_helpers::AnyPB)]
119#[derive(Clone, PartialEq, ::prost::Message)]
120pub struct StreamJobDesc {
121    #[prost(int32, tag = "1")]
122    pub table_id: i32,
123    #[prost(string, optional, tag = "2")]
124    pub connector_name: ::core::option::Option<::prost::alloc::string::String>,
125    #[prost(enumeration = "PlanOptimization", repeated, tag = "3")]
126    pub plan_optimizations: ::prost::alloc::vec::Vec<i32>,
127}
128#[derive(prost_helpers::AnyPB)]
129#[derive(Clone, PartialEq, ::prost::Message)]
130pub struct ComputeReport {
131    #[prost(message, optional, tag = "1")]
132    pub base: ::core::option::Option<ReportBase>,
133}
134#[derive(prost_helpers::AnyPB)]
135#[derive(Clone, PartialEq, ::prost::Message)]
136pub struct FrontendReport {
137    #[prost(message, optional, tag = "1")]
138    pub base: ::core::option::Option<ReportBase>,
139}
140#[derive(prost_helpers::AnyPB)]
141#[derive(Clone, PartialEq, ::prost::Message)]
142pub struct CompactorReport {
143    #[prost(message, optional, tag = "1")]
144    pub base: ::core::option::Option<ReportBase>,
145}
146#[derive(prost_helpers::AnyPB)]
147#[derive(Clone, PartialEq, ::prost::Message)]
148pub struct EventMessage {
149    /// tracking_id is persistent in meta data
150    #[prost(string, tag = "1")]
151    pub tracking_id: ::prost::alloc::string::String,
152    /// event_time is when the event is created
153    #[prost(uint64, tag = "3")]
154    pub event_time_sec: u64,
155    /// event_stage describes in which process the event happens
156    #[prost(enumeration = "TelemetryEventStage", tag = "4")]
157    pub event_stage: i32,
158    /// feature_name is the name of the feature triggered the event
159    #[prost(string, tag = "5")]
160    pub event_name: ::prost::alloc::string::String,
161    /// connector_name is the name of the connector involves
162    #[prost(string, optional, tag = "6")]
163    pub connector_name: ::core::option::Option<::prost::alloc::string::String>,
164    /// connector_direction is the direction of data flow, can be source or sink
165    #[prost(enumeration = "TelemetryDatabaseObject", optional, tag = "10")]
166    pub object: ::core::option::Option<i32>,
167    /// catalog_id is the id of the catalog involves (table_id/source_id/...)
168    #[prost(int64, tag = "7")]
169    pub catalog_id: i64,
170    /// attributes is the additional information of the event: json format ser to string
171    #[prost(string, optional, tag = "8")]
172    pub attributes: ::core::option::Option<::prost::alloc::string::String>,
173    /// node is the node that creates the event
174    #[prost(string, tag = "9")]
175    pub node: ::prost::alloc::string::String,
176    /// mark the event is a test message
177    #[prost(bool, tag = "11")]
178    pub is_test: bool,
179}
180#[derive(prost_helpers::AnyPB)]
181#[derive(Clone, PartialEq, ::prost::Message)]
182pub struct BatchEventMessage {
183    #[prost(message, repeated, tag = "1")]
184    pub events: ::prost::alloc::vec::Vec<EventMessage>,
185}
186#[derive(prost_helpers::AnyPB)]
187#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
188#[repr(i32)]
189pub enum MetaBackend {
190    Unspecified = 0,
191    Memory = 1,
192    Etcd = 2,
193    Rdb = 3,
194}
195impl MetaBackend {
196    /// String value of the enum field names used in the ProtoBuf definition.
197    ///
198    /// The values are not transformed in any way and thus are considered stable
199    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
200    pub fn as_str_name(&self) -> &'static str {
201        match self {
202            Self::Unspecified => "META_BACKEND_UNSPECIFIED",
203            Self::Memory => "META_BACKEND_MEMORY",
204            Self::Etcd => "META_BACKEND_ETCD",
205            Self::Rdb => "META_BACKEND_RDB",
206        }
207    }
208    /// Creates an enum from field names used in the ProtoBuf definition.
209    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
210        match value {
211            "META_BACKEND_UNSPECIFIED" => Some(Self::Unspecified),
212            "META_BACKEND_MEMORY" => Some(Self::Memory),
213            "META_BACKEND_ETCD" => Some(Self::Etcd),
214            "META_BACKEND_RDB" => Some(Self::Rdb),
215            _ => None,
216        }
217    }
218}
219#[derive(prost_helpers::AnyPB)]
220#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
221#[repr(i32)]
222pub enum TelemetryNodeType {
223    Unspecified = 0,
224    Meta = 1,
225    Compute = 2,
226    Frontend = 3,
227    Compactor = 4,
228}
229impl TelemetryNodeType {
230    /// String value of the enum field names used in the ProtoBuf definition.
231    ///
232    /// The values are not transformed in any way and thus are considered stable
233    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
234    pub fn as_str_name(&self) -> &'static str {
235        match self {
236            Self::Unspecified => "TELEMETRY_NODE_TYPE_UNSPECIFIED",
237            Self::Meta => "TELEMETRY_NODE_TYPE_META",
238            Self::Compute => "TELEMETRY_NODE_TYPE_COMPUTE",
239            Self::Frontend => "TELEMETRY_NODE_TYPE_FRONTEND",
240            Self::Compactor => "TELEMETRY_NODE_TYPE_COMPACTOR",
241        }
242    }
243    /// Creates an enum from field names used in the ProtoBuf definition.
244    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
245        match value {
246            "TELEMETRY_NODE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
247            "TELEMETRY_NODE_TYPE_META" => Some(Self::Meta),
248            "TELEMETRY_NODE_TYPE_COMPUTE" => Some(Self::Compute),
249            "TELEMETRY_NODE_TYPE_FRONTEND" => Some(Self::Frontend),
250            "TELEMETRY_NODE_TYPE_COMPACTOR" => Some(Self::Compactor),
251            _ => None,
252        }
253    }
254}
255#[derive(prost_helpers::AnyPB)]
256#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
257#[repr(i32)]
258pub enum TelemetryClusterType {
259    Unspecified = 0,
260    SingleNode = 1,
261    DockerCompose = 2,
262    Kubernetes = 3,
263    CloudHosted = 4,
264}
265impl TelemetryClusterType {
266    /// String value of the enum field names used in the ProtoBuf definition.
267    ///
268    /// The values are not transformed in any way and thus are considered stable
269    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
270    pub fn as_str_name(&self) -> &'static str {
271        match self {
272            Self::Unspecified => "TELEMETRY_CLUSTER_TYPE_UNSPECIFIED",
273            Self::SingleNode => "TELEMETRY_CLUSTER_TYPE_SINGLE_NODE",
274            Self::DockerCompose => "TELEMETRY_CLUSTER_TYPE_DOCKER_COMPOSE",
275            Self::Kubernetes => "TELEMETRY_CLUSTER_TYPE_KUBERNETES",
276            Self::CloudHosted => "TELEMETRY_CLUSTER_TYPE_CLOUD_HOSTED",
277        }
278    }
279    /// Creates an enum from field names used in the ProtoBuf definition.
280    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
281        match value {
282            "TELEMETRY_CLUSTER_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
283            "TELEMETRY_CLUSTER_TYPE_SINGLE_NODE" => Some(Self::SingleNode),
284            "TELEMETRY_CLUSTER_TYPE_DOCKER_COMPOSE" => Some(Self::DockerCompose),
285            "TELEMETRY_CLUSTER_TYPE_KUBERNETES" => Some(Self::Kubernetes),
286            "TELEMETRY_CLUSTER_TYPE_CLOUD_HOSTED" => Some(Self::CloudHosted),
287            _ => None,
288        }
289    }
290}
291#[derive(prost_helpers::AnyPB)]
292#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
293#[repr(i32)]
294pub enum PlanOptimization {
295    TableOptimizationUnspecified = 0,
296}
297impl PlanOptimization {
298    /// String value of the enum field names used in the ProtoBuf definition.
299    ///
300    /// The values are not transformed in any way and thus are considered stable
301    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
302    pub fn as_str_name(&self) -> &'static str {
303        match self {
304            Self::TableOptimizationUnspecified => "TABLE_OPTIMIZATION_UNSPECIFIED",
305        }
306    }
307    /// Creates an enum from field names used in the ProtoBuf definition.
308    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
309        match value {
310            "TABLE_OPTIMIZATION_UNSPECIFIED" => Some(Self::TableOptimizationUnspecified),
311            _ => None,
312        }
313    }
314}
315#[derive(prost_helpers::AnyPB)]
316#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
317#[repr(i32)]
318pub enum TelemetryEventStage {
319    Unspecified = 0,
320    CreateStreamJob = 1,
321    UpdateStreamJob = 2,
322    DropStreamJob = 3,
323    Query = 4,
324    Recovery = 5,
325}
326impl TelemetryEventStage {
327    /// String value of the enum field names used in the ProtoBuf definition.
328    ///
329    /// The values are not transformed in any way and thus are considered stable
330    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
331    pub fn as_str_name(&self) -> &'static str {
332        match self {
333            Self::Unspecified => "TELEMETRY_EVENT_STAGE_UNSPECIFIED",
334            Self::CreateStreamJob => "TELEMETRY_EVENT_STAGE_CREATE_STREAM_JOB",
335            Self::UpdateStreamJob => "TELEMETRY_EVENT_STAGE_UPDATE_STREAM_JOB",
336            Self::DropStreamJob => "TELEMETRY_EVENT_STAGE_DROP_STREAM_JOB",
337            Self::Query => "TELEMETRY_EVENT_STAGE_QUERY",
338            Self::Recovery => "TELEMETRY_EVENT_STAGE_RECOVERY",
339        }
340    }
341    /// Creates an enum from field names used in the ProtoBuf definition.
342    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
343        match value {
344            "TELEMETRY_EVENT_STAGE_UNSPECIFIED" => Some(Self::Unspecified),
345            "TELEMETRY_EVENT_STAGE_CREATE_STREAM_JOB" => Some(Self::CreateStreamJob),
346            "TELEMETRY_EVENT_STAGE_UPDATE_STREAM_JOB" => Some(Self::UpdateStreamJob),
347            "TELEMETRY_EVENT_STAGE_DROP_STREAM_JOB" => Some(Self::DropStreamJob),
348            "TELEMETRY_EVENT_STAGE_QUERY" => Some(Self::Query),
349            "TELEMETRY_EVENT_STAGE_RECOVERY" => Some(Self::Recovery),
350            _ => None,
351        }
352    }
353}
354#[derive(prost_helpers::AnyPB)]
355#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
356#[repr(i32)]
357pub enum TelemetryDatabaseObject {
358    Unspecified = 0,
359    Source = 1,
360    Mv = 2,
361    Table = 3,
362    Sink = 4,
363    Index = 5,
364}
365impl TelemetryDatabaseObject {
366    /// String value of the enum field names used in the ProtoBuf definition.
367    ///
368    /// The values are not transformed in any way and thus are considered stable
369    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
370    pub fn as_str_name(&self) -> &'static str {
371        match self {
372            Self::Unspecified => "TELEMETRY_DATABASE_OBJECT_UNSPECIFIED",
373            Self::Source => "TELEMETRY_DATABASE_OBJECT_SOURCE",
374            Self::Mv => "TELEMETRY_DATABASE_OBJECT_MV",
375            Self::Table => "TELEMETRY_DATABASE_OBJECT_TABLE",
376            Self::Sink => "TELEMETRY_DATABASE_OBJECT_SINK",
377            Self::Index => "TELEMETRY_DATABASE_OBJECT_INDEX",
378        }
379    }
380    /// Creates an enum from field names used in the ProtoBuf definition.
381    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
382        match value {
383            "TELEMETRY_DATABASE_OBJECT_UNSPECIFIED" => Some(Self::Unspecified),
384            "TELEMETRY_DATABASE_OBJECT_SOURCE" => Some(Self::Source),
385            "TELEMETRY_DATABASE_OBJECT_MV" => Some(Self::Mv),
386            "TELEMETRY_DATABASE_OBJECT_TABLE" => Some(Self::Table),
387            "TELEMETRY_DATABASE_OBJECT_SINK" => Some(Self::Sink),
388            "TELEMETRY_DATABASE_OBJECT_INDEX" => Some(Self::Index),
389            _ => None,
390        }
391    }
392}
risingwave_pb/sim/telemetry.rs

risingwave_pb/sim/
telemetry.rs
