获取帮助

启动调优程序之前，可以通过如下命令获取帮助信息：

  1. 源码方式：python main.py --help

输出帮助信息结果如下：

  1. usage:
  2.     python main.py start [--role {{agent,collector,monitor}}] # start local service.
  3.     python main.py stop [--role {{agent,collector,monitor}}] # stop local service.
  4.     python main.py start [--user USER] [--host HOST] [--project-path PROJECT_PATH] [--role {{agent,collector,monitor}}]
  5.     # start the remote service.
  6.     python main.py stop [--user USER] [--host HOST] [--project-path PROJECT_PATH] [--role {{agent,collector,
  7.     monitor}}] # stop the remote service.
  8.     python main.py deploy [--user USER] [--host HOST] [--project-path PROJECT_PATH] # deploy project in remote host.
  9.     python main.py diagnosis [--query] [--start_time] [--finish_time] # rca for slow SQL.
  10.     python main.py show_metrics # display all monitored metrics(can only be executed on 'detector' machine).
  11.     python main.py forecast [--metric-name METRIC_NAME] [--period] [--freq]
  12.      [--forecast-method {{auto_arima, fbprophet}}] [--save-path SAVE_PATH] # forecast future trend of
  13.      metric(can only be executed on 'detector' machine).
  15. Anomaly-detection: a time series forecast and anomaly detection tool.
  17. positional arguments:
  18.   {start,stop,deploy,show_metrics,forecast,diagnosis}
  20. optional arguments:
  21.   -h, --help            show this help message and exit
  22.   --user USER           User of remote server.
  23.   --host HOST           IP of remote server.
  24.   --project-path PROJECT_PATH
  25.                         Project location in remote server.
  26.   --role {agent,collector,monitor}
  27.                         Run as 'agent', 'collector', 'monitor'. Notes: ensure
  28.                         the normal operation of the openGauss in agent.
  29.   --metric-name METRIC_NAME
  30.                         Metric name to be predicted, you must provide an specified metric name.
  31. .
  32.   --query QUERY         target sql for RCA.
  33.                         Currently, the join operator is not supported, and the accuracy of the result 
  34.                         is not guaranteed for SQL syntax containing "not null and".
  35.   --start_time START_TIME
  36.                         start time of query
  37.   --finish_time FINISH_TIME
  38.                         finish time of query
  39.   --period PERIOD       Forecast periods of metric, it should be integernotes:
  40.                         the specific value should be determined to the
  41.                         trainnig data.if this parameter is not provided, the
  42.                         default value '100S' will be used.
  43.   --freq FREQ           forecast gap, time unit: S: Second, M: Minute, H:
  44.                         Hour, D: Day, W: Week.
  45.   --forecast-method FORECAST_METHOD
  46.                         Forecast method, default method is 'auto_arima',if
  47.                         want to use 'fbprophet', you should install fbprophet
  48.                         first.
  49.   --save-path SAVE_PATH
  50.                         Save the results to this path using csv format, if
  51.                         this parameter is not provided,, the result wil not be
  52.                         saved.
  53.   -v, --version         show program's version number and exit
  55. epilog:
  56.      the 'a-detection.conf' and 'metric_task.conf' will be read when the program is running,
  57.      the location of them is:
  58.      a-detection.conf: /openGauss-server/src/gausskernel/dbmind/tools/anomaly_detection/a-detection.conf.
  59.      metric_config: /openGauss-server/src/gausskernel/dbmind/tools/anomaly_detection/task/metric_task.conf.