Autorun

# 目录

• 介绍
• 用法
• Create
  • 用法
  • 示例
• List
  • 用法
  • 示例
• Modify
  • 用法
  • 示例
• Delete
  • 用法
  • 示例

# 介绍

自动运行功能，可以设定自动运行任务，每隔一段时间都会在指定的机器上运行分析任务。

回到目录

# 用法

Usage: orxray autorun command [OPTIONS]

COMMAND:
    create
    list
    modify
    delete

GLOBAL OPTIONS:
    --help
    --config                           specify the config file, default is ~/.orxray/config.

回到目录

# Create

这个命令创建一个新的自动运行任务。

回到目录

# 用法

Usage: orxray autorun create [OPTIONS]

OPTIONS:
    --target-type string               Specify the type of the autorun, it must be app, pid or pgid.
    --period integer                   The running period of the task.
    --stack string                     Specify the application you want to analyze, can add multiple times.
    --pid integer                      PID of the application you want to analyze.
    --pgid integer                     PGID of the applications you want to analyze.
    --agent, -a integer                The agent you want run on. 
    --tool string                      The tool name you want to run.


GLOBAL OPTIONS:
    --help
    --config                           specify the config file, default is ~/.orxray/config.

--target-type "type"

自动运行的类型，可以是 app, pid 或者 pgid 这三种类型。

--period "time"

运行周期，指定每隔多长的时间运行一次自动任务, 单位秒。

--stack "application"

当类型为 app 时, 这个参数指定要分析的应用, 可以多次指定多个应用。

--pid 'pid'

当类型为 pid 时， 这个参数指定要分析的程序 pid。

--pgid 'pgid'

当类型为 pgid 时，这个参数指定要分析的程序的 pgid。

--agent 'agent id'

指定要在那个代理上运行自动任务, 如果不指定则是在所有的代理上运行。

--tool 'tool name'

指定自动运行任务运行的分析工具。

回到目录

# 示例

$ orxray autorun create --target-type app --stacks nginx --period 60 --tool c-on-cpu --agent 54
ID: 10075

回到目录

# List

列出所有的自动运行任务。

回到目录

# 用法

Usage: orxray autorun list

OPTIONS:

GLOBAL OPTIONS:
    --help
    --config                           specify config file, default is ~/.orxray/config.

回到目录

# 示例

$ orxray autorun list
ID      TARGET TYPE     PERIOD  STACKS          PID     PGID    TOOL ID CREATE TIME             MODIFY TIME
10      app             300     *                               10      2022-04-01 22:49:26     2022-04-01 22:58:00
11      app             300     openresty                       11      2022-04-01 22:49:26     2022-04-01 22:58:00
                                openresty-edge
9       app             86400   openresty                       13      2022-04-01 22:20:58     2022-04-01 22:58:00
                                openresty-edge

回到目录

# Modify

修改自动运行任务。

回到目录

# 用法

Usage: orxray autorun modify ID

OPTIONS:
    --target-type string               Specify the type of the autorun, it must be app, pid or pgid.
    --period integer                   The running period of the task.
    --stack string                     Specify the application you want to analyze, can add multiple times.
    --pid integer                      PID of the application you want to analyze.
    --pgid integer                     PGID of the applications you want to analyze.
    --agent, -a integer                The agent you want run on. 
    --all-agents                       The autorun task will be run on all agents.
    --tool string                      The tool name you want to run.

GLOBAL OPTIONS:
    --help
    --config                           specify the config file, default is ~/.orxray/config.

ID

要修改的自动运行任务的ID。

--target-type "type"

自动运行的类型，可以是 app, pid 或者 pgid 这三种类型。

--period "time"

运行周期，指定每隔多长的时间运行一次自动任务, 单位秒。

--stack "application"

当类型为 app 时, 这个参数指定要分析的应用, 可以多次指定多个应用。

--pid 'pid'

当类型为 pid 时， 这个参数指定要分析的程序 pid。

--pgid 'pgid'

当类型为 pgid 时，这个参数指定要分析的程序的 pgid。

--agent 'agent id'

指定要在那个代理上运行自动任务。

--all-agents

指定要在所有的代理上运行自动任务。

--tool 'tool name'

指定自动运行任务运行的分析工具。

回到目录

# 示例

$ orxray autorun modify 1 --target-type app --stacks nginx --period 60 --tool c-on-cpu --agent 54
OK

回到目录

# Delete

回到目录

# 用法

Usage: orxray autorun delete ID

GLOBAL OPTIONS:
    --help
    --config                           specify config file, default is ~/.orxray/config.

ID

指定你要删除的自动运行任务的ID

回到目录

# 示例

$ orxray autorun delete 1
OK

回到目录