NAME¶

openqa-mon - CLI client for monitoring status of openQA jobs

SYNOPSIS¶

openqa-mon [OPTIONS] REMOTE [JOBS]

DESCRIPTION¶

openqa-mon is a command line tool for monitoring and live monitoring of jobs on an openQA instance. The tool periodically queries one or multiple instances and gives or an overview of the currently running jobs or monitors a set of given job IDs.

OPTIONS¶

-h|--help

Print help message

-j|--jobs JOBS

Monitor given job IDs instead of overview on the REMOTE instance. Supported input is a single job ID, multiple comma-separated job IDs or a job ID range (See examples). The -j parameter can be omitted, openqa-mon detects an integer, set of interger or integer range automatically and treats them as job IDs

-c|--continuous SECONDS

Enable live monitor and refresh at the given SECONDS intervals

-b|--bell

Enable bell notifications (terminal bell sound)

-n|--notify

Enable desktop notifications (sent via notify-send)

--no-bell

Disable bell notifications

--no-notify

Disable desktop notifications

-m|--monitor

Enable bell and desktop notifications (alias for "--bell --notify")

--silent

Disable bell and desktop notifications (alias for "--no-bell --no-notify")

-f|--follow

Follow jobs, i.e. replace jobs by their clones if available. This setting is useful to track jobs if they are going to be restarted in openQA.

-p|--hierarchy

Display job hierarchy (i.e. children of the jobs). This is particulary useful for virtualization runs.

--config FILE

Reads additional config file FILE. See CONFIG FILES for details.

CONFIG FILES¶

openqa-mon reads by default the following configuration files:

/etc/openqa/openqa-mon.conf (global config) or in ~/.openqa-mon.conf (user config).

An example configuration file looks like the following:

## openqa-mon config file
##
## this is an example config file for openqa-mon. Modify and place this file in
## /etc/openqa/openqa-mon.conf (global) or in ~/.openqa-mon.conf (user config)
##
## Have a lot of fun ...
## Default remote to use, if nothing is defined
# DefaultRemote = http://openqa.opensuse.org
## Enable bell notifications
# Bell = true
## Enable desktop notifications
# Notification = true
## Follow jobs
# Follow = true

EXAMPLES¶

openqa-mon https://openqa.opensuse.org

List current overview of the instance at https://openqa.opensuse.org

openqa-mon https://openqa.opensuse.org -j 42

List the status of the job 42 on https://openqa.opensuse.org

openqa-mon https://openqa.opensuse.org -j 42..45

openqa-mon https://openqa.opensuse.org -j 42+3

List the status of the jobs 42,43,44 and 45 from https://openqa.opensuse.org

openqa-mon https://openqa.opensuse.org 42 1335..1339

openqa-mon https://openqa.opensuse.org 42 1335+4

List the status of the jobs 42 and the jobs from 1335 to 1339. The -j parameter can be omitted
openqa-mon detects integers, sets of integers and integer ranges and treats them as job IDs.

openqa-mon -c 5 -b https://openqa.opensuse.org 42,1335..1339

openqa-mon -c 5 -b https://openqa.opensuse.org/t42 https://openqa.opensuse.org/t1335..1339

Continuously monitor the jobs 42 and the jobs from 1335 to 1339. Refresh every 5 seconds. Ring bell on status changes

openqa-mon -b -n -f -c 5 https://openqa.opensuse.org 42

Continuously monitor the job 42. Refresh every 5 seconds. Ring bell and displays desktop notification on status changes.
Follow job, if it gets restarted.

openqa-mon http://openqa.opensuse.org/t1245

openqa-mon http://openqa.opensuse.org/tests/1245

Monitor job 1245 on instance http://openqa.opensuse.org/.

openqa-mon -mfp http://openqa.opensuse.org/t413

Monitor job 413 on instance http://openqa.opensuse.org/ with enabled notifications, follow the job and display the hierarchy

COPYRIGHT¶

Copyright (C) 2020 SUSE LLC

CREDITS¶

Creator: Felix Niederwanger <felix.niederwanger@suse.de>

Thanks for the constructive feedback to (in no particular order)

- Christian Dywan - Pavel Dostal - Oliver Kurz - George Gkioulis - Jozef Pupava -

This tool has been created to help me and my colleagues work better with openQA.