Fix clippy and documentation

- Update CLI flags in docs and clippy/lint errors

Author: SangJunBak

Cargo.lock

@@ -2,24 +2,16 @@ columns:
   - column: "Option"
   - column: "Description"
 rows:
-  - Option: "`--dump-docker <boolean>`"
-    Description: |
-
-      <a name="dump-docker"></a> If `true`, dump debug information from the Docker container.
-
-      Defaults to `true`.
-
   - Option: "`--docker-container-id <ID>`"
     Description: |
 
       <a name="docker-container-id"></a> The Docker container to dump.
 
-      Required if [`--dump-docker`](#dump-docker) is true.
+      Required.
 
-  - Option: "`--mz-connection-url <URL>`"
+  - Option: "`--dump-docker <boolean>`"
     Description: |
 
-      <a name="mz-connection-url"></a>The URL of the Materialize's SQL
-      connection.
+      <a name="dump-docker"></a> If `true`, dump debug information from the Docker container.
 
-      Defaults to `postgres://127.0.0.1:6875/materialize?sslmode=prefer`.
+      Defaults to `true`.

doc/user/data/mz-debug/emulator_options.yml

@@ -2,10 +2,36 @@ columns:
   - column: "Option"
   - column: "Description"
 rows:
+  - Option: "`--dump-heap-profiles <boolean>`"
+    Description: |
+
+      <a name="dump-heap-profiles"></a> If `true`, dump heap profiles (.pprof) from
+      your Materialize instance.
+
+      Defaults to `true`.
+  - Option: "`--dump-prometheus-metrics <boolean>`"
+    Description: |
+
+      <a name="dump-prometheus-metrics"></a> If `true`, dump prometheus metrics from
+      your Materialize instance.
+
+      Defaults to `true`.
+
+
   - Option: "`--dump-system-catalog <boolean>`"
     Description: |
 
       <a name="dump-system-catalog"></a> If `true`, dump the system catalog from
       your Materialize instance.
 
       Defaults to `true`.
+
+
+  - Option: "`--mz-connection-url <URL>`"
+    Description: |
+
+      <a name="mz-connection-url"></a>The Materialize instance's [PostgreSQL
+      connection
+      URL](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNSTRING).
+
+      Defaults to `postgres://127.0.0.1:6875/materialize?sslmode=prefer`.

doc/user/data/mz-debug/mz_debug_option.yml

@@ -57,18 +57,6 @@ rows:
 
       Defaults to `6875`.
 
-  - Option: "`--mz-connection-url <URL>`"
-    Description: |
-
-      <a name="mz-connection-url"></a>The Materialize instance's [PostgreSQL
-      connection
-      URL](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNSTRING).
-
-      Defaults to a connection URL constructed from:
-
-      [`--port-forward-local-address`](#port-forward-local-address) and
-      [`--port-forward-local-port`](#port-forward-local-port) values.
-
   - Option: "`-h`, `--help`"
     Description: |
 

doc/user/data/mz-debug/self_managed_options.yml

@@ -1,7 +1,7 @@
 [package]
 name = "mz-debug"
 description = "Debug tool for self-managed Materialize."
-version = "0.1.0"
+version = "0.2.0"
 edition.workspace = true
 rust-version.workspace = true
 publish = false

src/mz-debug/Cargo.toml

@@ -1,3 +1,13 @@
+// Copyright Materialize, Inc. and contributors. All rights reserved.
+//
+// Use of this software is governed by the Business Source License
+// included in the LICENSE file.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0.
+
+//! Dumps internal http debug information to files.
 use anyhow::{Context as AnyhowContext, Result};
 use futures::StreamExt;
 use k8s_openapi::api::core::v1::ServicePort;
@@ -95,7 +105,7 @@ impl<'n> InternalHttpDumpClient<'n> {
         let output_path = output_dir.join(format!("{}.memprof.pprof", service_name));
 
         self.dump_request_to_file(
-            &relative_url,
+            relative_url,
             {
                 let mut headers = HeaderMap::new();
                 headers.insert(
@@ -127,7 +137,7 @@ impl<'n> InternalHttpDumpClient<'n> {
 
         let output_path = output_dir.join(format!("{}.metrics.txt", service_name));
         self.dump_request_to_file(
-            &relative_url,
+            relative_url,
             {
                 let mut headers = HeaderMap::new();
                 headers.insert("Accept", HeaderValue::from_static("text/plain"));

src/mz-debug/src/internal_http_dumper.rs

@@ -202,7 +202,7 @@ pub async fn create_pg_wire_port_forwarder(
 ) -> Result<KubectlPortForwarder> {
     let service_info = find_environmentd_service(client, k8s_namespaces)
         .await
-        .with_context(|| format!("Cannot find ports for environmentd service"))?;
+        .with_context(|| "Cannot find ports for environmentd service")?;
 
     let maybe_internal_sql_port = service_info.service_ports.iter().find_map(|port_info| {
         if let Some(port_name) = &port_info.name {