ddm-admin-client: avoid duplicate error logging from DdmError

As described in docs/error-types-and-logging.adoc, recursing into a
source's Display implementation can result in duplicated error text in
log output, so this commit updates the error attributes on DdmError's
variants to stop doing this.

Unfortunately, this type of change is breaking, in terms of how callers
must log an error, but the difference isn't visible to the type system,
and therefore won't result in compilation errors. Accordingly, this
commit also updates any callers that were previously relying on the old
Display implementation, so they walk the error chain instead.

Author: sruggier

Cargo.lock

@@ -21,3 +21,4 @@ sled-hardware-types.workspace = true
 omicron-workspace-hack.workspace = true
 ddm-admin-client.workspace = true
 uuid.workspace = true
+slog-error-chain.workspace = true

clients/ddm-admin-client/Cargo.toml

@@ -18,6 +18,7 @@ use sled_hardware_types::underlay::BOOTSTRAP_MASK;
 use sled_hardware_types::underlay::BOOTSTRAP_PREFIX;
 use sled_hardware_types::underlay::BootstrapInterface;
 use slog::Logger;
+use slog_error_chain::SlogInlineError;
 use std::net::Ipv6Addr;
 use std::net::SocketAddr;
 use std::net::SocketAddrV6;
@@ -28,12 +29,12 @@ use crate::types::EnableStatsRequest;
 // TODO-cleanup Is it okay to hardcode this port number here?
 const DDMD_PORT: u16 = 8000;
 
-#[derive(Debug, Error)]
+#[derive(Debug, Error, SlogInlineError)]
 pub enum DdmError {
-    #[error("Failed to construct an HTTP client: {0}")]
+    #[error("Failed to construct an HTTP client")]
     HttpClient(#[from] reqwest::Error),
 
-    #[error("Failed making HTTP request to ddmd: {0}")]
+    #[error("Failed making HTTP request to ddmd")]
     DdmdApi(#[from] Error<types::Error>),
 }
 

clients/ddm-admin-client/src/lib.rs

@@ -144,7 +144,7 @@ pub async fn poll_ddmd_for_bootstore_and_tq_peer_update(
             Err(err) => {
                 warn!(
                     log, "Failed to get prefixes from ddmd";
-                    "err" => #%err,
+                    &err,
                 );
                 break;
             }

sled-agent/src/bootstrap/bootstore_setup.rs

@@ -62,7 +62,7 @@ pub enum EarlyNetworkSetupError {
     #[error("Bad configuration for setting up rack: {0}")]
     BadConfig(String),
 
-    #[error("Error contacting ddmd: {0}")]
+    #[error("Error contacting ddmd")]
     DdmError(#[from] DdmError),
 
     #[error("Error during request to MGS: {0}")]

sled-agent/src/bootstrap/early_networking.rs

@@ -194,7 +194,7 @@ pub enum Error {
     #[error(transparent)]
     ZoneInstall(#[from] illumos_utils::running_zone::InstallZoneError),
 
-    #[error("Error contacting ddmd: {0}")]
+    #[error("Error contacting ddmd")]
     DdmError(#[from] DdmError),
 
     #[error("Failed to access underlay device: {0}")]

sled-agent/src/services.rs

@@ -145,7 +145,7 @@ async fn possible_sled_agent_addrs(
             Err(err) => {
                 warn!(
                     log, "Failed to get prefixes from ddm";
-                    "err" => #%err,
+                    &err,
                 );
                 tokio::time::sleep(RETRY).await;
             }
@@ -164,7 +164,7 @@ async fn make_ddm_admin_client(log: &Logger) -> DdmAdminClient {
             Err(err) => {
                 warn!(
                     log, "Failed to construct DdmAdminClient";
-                    "err" => #%err,
+                    &err,
                 );
                 tokio::time::sleep(DDM_CONSTRUCT_RETRY).await;
             }