apollo_dashboard: simpler new fn for Panel

Author: matanl-starkware

crates/apollo_dashboard/src/dashboard.rs

@@ -137,25 +137,58 @@ pub(crate) struct Panel {
     extra: ExtraParams,
 }
 
+// helper: unify "String" and "Vec<String>"
+pub(crate) trait IntoExprs {
+    fn into_exprs(self) -> Vec<String>;
+}
+
+impl IntoExprs for String {
+    fn into_exprs(self) -> Vec<String> {
+        vec![self]
+    }
+}
+
+impl IntoExprs for &str {
+    fn into_exprs(self) -> Vec<String> {
+        vec![self.to_string()]
+    }
+}
+
+impl IntoExprs for Vec<String> {
+    fn into_exprs(self) -> Vec<String> {
+        self
+    }
+}
+
+impl IntoExprs for Vec<&str> {
+    fn into_exprs(self) -> Vec<String> {
+        self.into_iter().map(|s| s.to_string()).collect::<Vec<_>>()
+    }
+}
+
 impl Panel {
     pub(crate) fn new(
         name: impl ToString,
         description: impl ToString,
-        exprs: Vec<String>,
+        exprs: impl IntoExprs,
         panel_type: PanelType,
     ) -> Self {
         // A panel assigns a unique id to each of its expressions. Conventionally, we use letters
         // A–Z, and for simplicity, we limit the number of expressions to this range.
         const NUM_LETTERS: u8 = b'Z' - b'A' + 1;
         let name = name.to_string();
         let description = description.to_string();
+
+        let exprs = exprs.into_exprs();
+
         assert!(
             exprs.len() <= NUM_LETTERS.into(),
             "Too many expressions ({} > {NUM_LETTERS}) in panel '{name}'.",
             exprs.len(),
         );
         Self { name, description, exprs, panel_type, extra: ExtraParams::default() }
     }
+
     pub fn with_unit(mut self, unit: Unit) -> Self {
         self.extra.unit = Some(unit);
         self
@@ -265,7 +298,7 @@ impl Panel {
                          (rate({metric_name_with_filter_and_reason}[{HISTOGRAM_TIME_RANGE}])))",
                     )
                 })
-                .collect(),
+                .collect::<Vec<_>>(),
             panel_type,
         )
     }
@@ -288,14 +321,14 @@ impl Panel {
 
         let expr = format!("({numerator_expr} / ({denominator_expr}))");
 
-        Self::new(name, description, vec![expr], PanelType::TimeSeries).with_unit(Unit::PercentUnit)
+        Self::new(name, description, expr, PanelType::TimeSeries).with_unit(Unit::PercentUnit)
     }
 
     pub(crate) fn from_counter(metric: &MetricCounter, panel_type: PanelType) -> Self {
         Self::new(
             metric.get_name(),
             metric.get_description(),
-            vec![metric.get_name_with_filter().to_string()],
+            metric.get_name_with_filter().to_string(),
             panel_type,
         )
     }
@@ -304,7 +337,7 @@ impl Panel {
         Self::new(
             metric.get_name(),
             metric.get_description(),
-            vec![metric.get_name_with_filter().to_string()],
+            metric.get_name_with_filter().to_string(),
             panel_type,
         )
     }
@@ -328,7 +361,7 @@ impl Panel {
                         metric_name_with_filter.as_ref(),
                     )
                 })
-                .collect(),
+                .collect::<Vec<_>>(),
             PanelType::TimeSeries,
         )
     }

crates/apollo_dashboard/src/dashboard_test.rs

@@ -91,7 +91,7 @@ fn test_ratio_time_series() {
 
 #[test]
 fn test_extra_params() {
-    let panel_with_extra_params = Panel::new("x", "x", vec!["y".to_string()], PanelType::Stat)
+    let panel_with_extra_params = Panel::new("x", "x", "y".to_string(), PanelType::Stat)
         .with_unit(Unit::Bytes)
         .show_percent_change()
         .with_log_query("Query")
@@ -118,7 +118,7 @@ fn test_extra_params() {
     );
     assert_eq!(panel_with_extra_params.extra.legends, Some(vec!["a".to_string()]));
 
-    let panel_without_extra_params = Panel::new("x", "x", vec!["y".to_string()], PanelType::Stat);
+    let panel_without_extra_params = Panel::new("x", "x", "y".to_string(), PanelType::Stat);
     assert!(panel_without_extra_params.extra.unit.is_none());
     assert!(panel_without_extra_params.extra.show_percent_change.is_none());
     assert!(panel_without_extra_params.extra.log_query.is_none());
@@ -129,7 +129,7 @@ fn test_extra_params() {
 #[test]
 #[should_panic]
 fn thresholds_first_step_must_be_none() {
-    let _ = Panel::new("x", "x", vec!["y".into()], PanelType::Stat).with_absolute_thresholds(vec![
+    let _ = Panel::new("x", "x", "y", PanelType::Stat).with_absolute_thresholds(vec![
         ("green", Some(0.0)), // illegal: first step must be None
         ("red", Some(80.0)),
     ]);
@@ -138,7 +138,7 @@ fn thresholds_first_step_must_be_none() {
 #[test]
 #[should_panic]
 fn thresholds_must_be_strictly_increasing() {
-    let _ = Panel::new("x", "x", vec!["y".into()], PanelType::Stat).with_absolute_thresholds(vec![
+    let _ = Panel::new("x", "x", "y", PanelType::Stat).with_absolute_thresholds(vec![
         ("green", None),
         ("red", Some(90.0)),
         ("yellow", Some(80.0)), // illegal: not increasing
@@ -148,5 +148,5 @@ fn thresholds_must_be_strictly_increasing() {
 #[test]
 #[should_panic]
 fn amount_of_legends_must_match_amount_of_exprs() {
-    let _ = Panel::new("x", "x", vec!["y".into()], PanelType::Stat).with_legends(vec!["a", "b"]);
+    let _ = Panel::new("x", "x", "y", PanelType::Stat).with_legends(vec!["a", "b"]);
 }

crates/apollo_dashboard/src/panels/batcher.rs

@@ -19,7 +19,7 @@ fn get_panel_validator_wasted_txs() -> Panel {
     Panel::new(
         "Proposal Validation: Wasted TXs",
         "Number of txs executed by the validator but excluded from the block (10m window)",
-        vec![format!("increase({}[10m])", VALIDATOR_WASTED_TXS.get_name_with_filter())],
+        format!("increase({}[10m])", VALIDATOR_WASTED_TXS.get_name_with_filter()),
         PanelType::TimeSeries,
     )
     .with_log_query("Finished building block as validator. Started executing")
@@ -29,7 +29,7 @@ fn get_panel_proposer_deferred_txs() -> Panel {
     Panel::new(
         "Proposal Build: Deferred TXs",
         "Number of txs started execution by the proposer but excluded from the block (10m window)",
-        vec![format!("increase({}[10m])", PROPOSER_DEFERRED_TXS.get_name_with_filter())],
+        format!("increase({}[10m])", PROPOSER_DEFERRED_TXS.get_name_with_filter()),
         PanelType::TimeSeries,
     )
     .with_log_query("Finished building block as proposer. Started executing")
@@ -39,7 +39,7 @@ fn get_panel_storage_height() -> Panel {
     Panel::new(
         "Storage Height",
         "The height of the batcher's storage",
-        vec![STORAGE_HEIGHT.get_name_with_filter().to_string()],
+        STORAGE_HEIGHT.get_name_with_filter().to_string(),
         PanelType::Stat,
     )
     .with_log_query("Committing block at height")
@@ -75,7 +75,7 @@ pub(crate) fn get_panel_batched_transactions_rate() -> Panel {
     Panel::new(
         "Batched Transactions Rate (TPS)",
         "The rate of transactions batched by the Batcher (1m window)",
-        vec![format!("rate({}[1m])", BATCHED_TRANSACTIONS.get_name_with_filter())],
+        format!("rate({}[1m])", BATCHED_TRANSACTIONS.get_name_with_filter()),
         PanelType::TimeSeries,
     )
     .with_log_query("BATCHER_FIN_VALIDATOR")
@@ -85,11 +85,11 @@ fn get_panel_block_close_reasons() -> Panel {
     Panel::new(
         "Block Close Reasons",
         "Number of blocks closed by reason (10m window)",
-        vec![format!(
+        format!(
             "sum by ({}) (increase({}[10m]))",
             LABEL_NAME_BLOCK_CLOSE_REASON,
             BLOCK_CLOSE_REASON.get_name_with_filter()
-        )],
+        ),
         PanelType::Stat,
     )
     .with_log_query("\"Block builder deadline reached.\" OR \"Block is full.\"")
@@ -99,7 +99,7 @@ fn get_panel_num_batches_in_proposal() -> Panel {
     Panel::new(
         "Number of Chunks in Proposal",
         "The number of transaction batches received in a valid proposal",
-        vec![CONSENSUS_NUM_BATCHES_IN_PROPOSAL.get_name_with_filter().to_string()],
+        CONSENSUS_NUM_BATCHES_IN_PROPOSAL.get_name_with_filter().to_string(),
         PanelType::TimeSeries,
     )
 }
@@ -108,7 +108,7 @@ fn get_panel_num_txs_in_proposal() -> Panel {
     Panel::new(
         "Number of Transactions in Proposal",
         "The total number of individual transactions in a valid proposal received",
-        vec![CONSENSUS_NUM_TXS_IN_PROPOSAL.get_name_with_filter().to_string()],
+        CONSENSUS_NUM_TXS_IN_PROPOSAL.get_name_with_filter().to_string(),
         PanelType::TimeSeries,
     )
     .with_log_query("BATCHER_FIN_PROPOSER")

crates/apollo_dashboard/src/panels/blockifier.rs

@@ -66,11 +66,11 @@ fn get_panel_sierra_gas_in_last_block() -> Panel {
     Panel::new(
         "Average Sierra Gas Usage in Block",
         "The average sierra gas usage in block (10m window)",
-        vec![format!(
+        format!(
             "avg_over_time({}[10m])/{}",
             SIERRA_GAS_IN_LAST_BLOCK.get_name_with_filter(),
             DENOMINATOR_DIVISOR_FOR_READABILITY
-        )],
+        ),
         PanelType::TimeSeries,
     )
 }
@@ -79,11 +79,11 @@ fn get_panel_proving_gas_in_last_block() -> Panel {
     Panel::new(
         "Average Proving Gas Usage in Block",
         "The average proving gas usage in block (10m window)",
-        vec![format!(
+        format!(
             "avg_over_time({}[10m])/{}",
             PROVING_GAS_IN_LAST_BLOCK.get_name_with_filter(),
             DENOMINATOR_DIVISOR_FOR_READABILITY
-        )],
+        ),
         PanelType::TimeSeries,
     )
 }