Skip to content

Commit c6d2bd0

Browse files
committed
Document arguments of collector add_collector command
1 parent a792e46 commit c6d2bd0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

collector/src/bin/collector.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,20 +668,26 @@ enum Commands {
668668
modified: Option<String>,
669669
},
670670

671-
/// Registers a collector in the database
671+
/// Registers a new collector in the database.
672+
/// Use `--is_active` to immediately mark the collector as active.
672673
AddCollector {
673674
#[command(flatten)]
674675
db: DbOption,
675676

677+
/// Name of the collector.
676678
#[arg(long)]
677679
collector_name: String,
678680

681+
/// Target tuple which will the collector be benchmarking.
679682
#[arg(long)]
680683
target: String,
681684

685+
/// Should the collector be marked as active immediately?
686+
/// Only active collectors will receive jobs.
682687
#[arg(long)]
683688
is_active: bool,
684689

690+
/// The benchmark set index that the collector will be benchmarking.
685691
#[arg(long)]
686692
benchmark_set: u32,
687693
},

0 commit comments

Comments
 (0)