Report

# Table of Contents

• Introduction
• Usage
• Gen
  • Usage
  • Example
• List
  • Usage
  • Example

# Introduction

The report subcommand can generate summary reports and get a list of summary reports.

Back to TOC

# Usage

Usage: orxray report [COMMAND]

COMMAND:
    gen                                Generate a summary report.
    list                               List summary reports.

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

Back to TOC

# Generate

Generates the summary report.

Back to TOC

# Usage

Usage: orxray report gen [OPTIONS]

OPTIONS:
    -b, --batch                        batch id list, such as "1,2".
    -t, --time                         time, such as "2022-10-01~2022-10-02".
    -T, --type                         type, error_summary or main_summary(default).

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

Back to TOC

# Example

Generate the summary report for jobs with batch_id 10 and 11.

orxray report gen -b 10,11

Generate the summary report for jobs between 2022-10-01 and 2022-10-02.

orxray report gen -t 2022-10-01~2022-10-02

Back to TOC

# List

Outputs the list of summary reports.

# Usage

Usage: orxray report list [OPTIONS]

OPTIONS:
    -s, --page-size                        page size, 20(default).
    -p, --page                             page, 1(default).

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

Back to TOC

# Example

$ orxray report list
ID      TYPE            TIME                    BATCH   STATUS
224     main_summary                            10,11   finished
223     main_summary    2022-10-01 ~ 2022-10-02         finished
222     error_summary   2022-10-25 ~ 2022-11-01         finished
221     main_summary                                    errored
220     main_summary                            10      finished
219     main_summary                            10      finished
218     main_summary                            10      finished
217     main_summary                            10      finished
216     main_summary                            10,11   finished
215     main_summary    2022-10-18 ~ 2022-10-19         finished

Back to TOC