counters: small UX fixes & tweaks

cmd/counters/src/ipc.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use super::{load_counters, taskname, Options, Order};
+use super::{load_counters, taskname, Options, Order, LIST_HINT};
 use anyhow::{bail, Result};
 use colored::{ColoredString, Colorize};
 use humility::core::Core;
@@ -96,9 +96,11 @@ impl Args {
 
         if ipcs.is_empty() {
             if let Some(ref name) = opts.name {
+                let hint = super::hint();
                 bail!(
-                    "no IPC counters found with names containing \"{}\" (-l to list)",
-                    name
+                    "no IPC counters found with names containing \"{name}\"\n\
+                    {hint} {LIST_HINT}\n\
+                    {hint} use `--client` to filter by client task name"
                 );
             } else {
                 bail!("no IPC counters found");

cmd/counters/src/lib.rs

@@ -201,6 +201,7 @@
 
 use anyhow::{bail, Result};
 use clap::{CommandFactory, Parser, ValueEnum};
+use colored::Colorize;
 use humility::core::Core;
 use humility::hubris::*;
 use humility::reflect::{self, Load, Value};
@@ -232,7 +233,10 @@ struct CountersArgs {
     /// * "csv": outputs counters in comma-separated values (CSV) format,
     ///   suitable for use with other tools.
     ///
-    /// [conflicts with: --ipc]
+    /// * "json": outputs counters in JSON format, suitable for use with
+    ///   other tools.
+    ///
+    /// [conflicts with: ipc]
     #[clap(long, short, value_enum, default_value_t = Output::Text)]
     output: Output,
 }
@@ -274,7 +278,9 @@ enum Subcmd {
         /// * "csv": outputs counters in comma-separated values (CSV) format,
         ///   suitable for use with other tools.
         ///
-        /// [conflicts with: --ipc]
+        /// * "json": outputs counters in JSON format, suitable for use with
+        ///   other tools.
+
         #[clap(long, short, value_enum, default_value_t = Output::Text)]
         output: Output,
     },
@@ -310,9 +316,14 @@ enum Output {
     Text,
     /// Output comma-separated values (CSV).
     Csv,
+    /// Output JSON.
     Json,
 }
 
+// Help message printed out when no counters match a filter.
+const LIST_HINT: &str = "use `humility counters list` to list all \
+    available counters";
+
 fn counters(context: &mut ExecutionContext) -> Result<()> {
     let core = &mut **context.core.as_mut().unwrap();
     let Subcommand::Other(subargs) = context.cli.cmd.as_ref().unwrap();
@@ -363,8 +374,9 @@ fn counters(context: &mut ExecutionContext) -> Result<()> {
     if counters.is_empty() {
         if let Some(name) = name {
             bail!(
-                "no counters found with names containing \"{}\" (-l to list)",
-                name
+                "no counters found with names containing \"{name}\"\n\
+                {} {LIST_HINT}",
+                hint(),
             );
         } else {
             bail!("no counters found");
@@ -435,9 +447,9 @@ fn counters(context: &mut ExecutionContext) -> Result<()> {
                 for (varname, ctr) in resolved_counters {
                     match ctr {
                         Err(e) if subargs.opts.verbose => {
-                            humility::msg!("counter dump failed: {e:?}")
+                            humility::warn!("counter dump failed: {e:?}")
                         }
-                        Err(e) => humility::msg!("counter dump failed: {e}"),
+                        Err(e) => humility::warn!("counter dump failed: {e}"),
                         Ok(mut ctr) => {
                             counters_dump_csv(
                                 &mut ctr,
@@ -453,9 +465,9 @@ fn counters(context: &mut ExecutionContext) -> Result<()> {
                 for (varname, ctr) in resolved_counters {
                     match ctr {
                         Err(e) if subargs.opts.verbose => {
-                            humility::msg!("counter dump failed: {e:?}")
+                            humility::warn!("counter dump failed: {e:?}")
                         }
-                        Err(e) => humility::msg!("counter dump failed: {e}"),
+                        Err(e) => humility::warn!("counter dump failed: {e}"),
                         Ok(ctr) => {
                             json.entry(t)
                                 .or_default()
@@ -473,9 +485,9 @@ fn counters(context: &mut ExecutionContext) -> Result<()> {
                         if ctrs.peek().is_some() { " |  " } else { "    " };
                     match ctr {
                         Err(e) if subargs.opts.verbose => {
-                            humility::msg!("counter dump failed: {e:?}")
+                            humility::warn!("counter dump failed: {e:?}")
                         }
-                        Err(e) => humility::msg!("counter dump failed: {e}"),
+                        Err(e) => humility::warn!("counter dump failed: {e}"),
                         Ok(mut ctr) => {
                             counter_dump(&mut ctr, &subargs.opts, pad)
                         }
@@ -610,6 +622,10 @@ fn load_counters(
         .or_else(|_| Counters::from_value(&val))
 }
 
+fn hint() -> impl std::fmt::Display {
+    "hint:".bold()
+}
+
 pub fn init() -> Command {
     Command {
         app: CountersArgs::command(),