Skip to content

Commit f0ee0c3

Browse files
Benedikt Volkelsawenzel
authored andcommitted
Add more help for args
1 parent 217a205 commit f0ee0c3

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

MC/utils/o2dpg_sim_metrics.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -560,21 +560,21 @@ def main():
560560

561561
sub_parsers = parser.add_subparsers(dest="command")
562562

563-
extract_parser = sub_parsers.add_parser("extract")
563+
extract_parser = sub_parsers.add_parser("extract", help="Extract metrics as JSON format from metric_pipeline")
564564
extract_parser.set_defaults(func=extract)
565565
extract_parser.add_argument("--path", help="path to pipeline_metrics file to be evaluated", required=True)
566566
extract_parser.add_argument("--tags", help="key-value pairs, seperated by ;, example: alidist=1234567;o2=7654321;tag=someTag")
567567
extract_parser.add_argument("--output", "-o", help="output name", default="metrics.json")
568568

569-
plot_parser = sub_parsers.add_parser("plot")
569+
plot_parser = sub_parsers.add_parser("plot", help="Plot (multiple) metrcis from extracted metrics JSON file(s)")
570570
plot_parser.set_defaults(func=plot)
571571
plot_parser.add_argument("--metrics", nargs="+", help="metric JSON files")
572572
plot_parser.add_argument("--cpu-eff", dest="cpu_eff", action="store_true", help="run only cpu efficiency evaluation")
573573
plot_parser.add_argument("--mem-usage", dest="mem_usage", action="store_true", help="run mem usage evaluation")
574574
plot_parser.add_argument("--output", help="output_directory", default="metrics_summary")
575575
plot_parser.add_argument("--metrics-summary", dest="metrics_summary", action="store_true", help="create the metrics summary")
576576

577-
influx_parser = sub_parsers.add_parser("influx")
577+
influx_parser = sub_parsers.add_parser("influx", help="Derive a format which can be sent to InfluxDB")
578578
influx_parser.set_defaults(func=influx)
579579
influx_parser.add_argument("--metrics", help="pmetric JSON file to prepare for InfluxDB", required=True)
580580
influx_parser.add_argument("--table-base", dest="table_base", help="base name of InfluxDB table name", default="O2DPG_MC")

0 commit comments

Comments
 (0)