Skip to content

Commit

Permalink
feat(cli): add metrics server to iroh doctor (#2292)
Browse files Browse the repository at this point in the history
## Description

Folks try to look at metrics while doctor alone is running (note this
clashes by default with the iroh node if both are running locally on
port :9090). Also kind of inconvenient given if you want to look at a
running iroh node when doctor is running.

Suggestions welcome, maybe default off metrics on `doctor`?

Also most metrics are not really used in the `doctor` path, but we can
fix that as we figure out what's cool to measure.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->

## Change checklist

- [x] Self-review.
- [ ] Documentation updates if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
  • Loading branch information
Arqu committed May 22, 2024
1 parent 98d45f3 commit d635d93
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
10 changes: 8 additions & 2 deletions iroh-cli/src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pub(crate) struct Cli {
#[clap(long, global = true)]
start: bool,

/// Port to serve metrics on. -1 to disable.
/// Port to serve metrics on. Disabled by default.
#[clap(long)]
pub(crate) metrics_port: Option<MetricsPort>,
}
Expand Down Expand Up @@ -184,7 +184,13 @@ impl Cli {
.await
}
Commands::Doctor { command } => {
let config = NodeConfig::load(self.config.as_deref()).await?;
let mut config = NodeConfig::load(self.config.as_deref()).await?;
if let Some(metrics_port) = self.metrics_port {
config.metrics_addr = match metrics_port {
MetricsPort::Disabled => None,
MetricsPort::Port(port) => Some(([127, 0, 0, 1], port).into()),
};
}
self::doctor::run(command, &config).await
}
}
Expand Down
7 changes: 6 additions & 1 deletion iroh-cli/src/commands/doctor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1068,7 +1068,8 @@ fn inspect_ticket(ticket: &str, zbase32: bool) -> anyhow::Result<()> {
pub async fn run(command: Commands, config: &NodeConfig) -> anyhow::Result<()> {
let data_dir = iroh_data_root()?;
let _guard = crate::logging::init_terminal_and_file_logging(&config.file_logs, &data_dir)?;
match command {
let metrics_fut = super::start::start_metrics_server(config.metrics_addr);
let cmd_res = match command {
Commands::Report {
stun_host,
stun_port,
Expand Down Expand Up @@ -1200,7 +1201,11 @@ pub async fn run(command: Commands, config: &NodeConfig) -> anyhow::Result<()> {

Ok(())
}
};
if let Some(metrics_fut) = metrics_fut {
metrics_fut.abort();
}
cmd_res
}

async fn run_plotter<B: Backend>(
Expand Down

0 comments on commit d635d93

Please sign in to comment.