Skip to content
This repository has been archived by the owner on Jun 17, 2018. It is now read-only.

Command line utilities

Jump to bottom
Ben Merritt edited this page May 4, 2016 · 7 revisions

Standard options

Unless otherwise specified, every tool accepts these options:

  • -c CONFIG_FILE: specifies a configuration file to use for database parameters
    • The default location of the configuration file is /etc/bookie/database.rb.
  • -h or --help: displays the command's syntax

bookie-data

Retrieves summaries and other data from the database

Usage

bookie-data [options]

In addition to the standard options, the following options are available:

  • -d, --details: include a list of individual jobs in the data set
  • -p, --page PAGE: show the specified page of job details (implies -d)
  • -l, --limit COUNT: limit the number of job details per page (implies -d)
  • -u, --user NAME: filter by username
  • -m, --command COMMAND: filter by command
  • -s, --system HOSTNAME: filter by system
  • -t, --type TYPE: filter by system type
  • -r, --time BEGIN,END: filter by a time range
  • -o, --output-file FILENAME: send CSV formatted output to FILENAME

Notes

All statistics are calculated from the jobs that were entered into the database. If some of the jobs have not made it into the database (i.e. if the job is still running or belongs to a user whose jobs are excluded from tracking), those jobs will not appear in the statistics. Because of this, the statistics shown will probably be somewhat lower than the actual system load. If filters are applied to the data, the statistics will be calculated using only the jobs that pass through the filters, not all jobs that ran during the specified interval.

bookie-send

Sends data to the database and decommissions systems

Usage

bookie-send [filename] [options]

If filename is specified, the contents of that file will be sent to the database.

In addition to the standard options, the following options are available:

  • -s, --sender-config FILE: use the given sender configuration file (defaults to '/etc/bookie/sender.rb')
  • --create: Creates a system entry in the database using information from the configuration file

A filename and/or --create flag must be provided. Omitting both is an error.

bookie-migrate

Performs database migrations

Usage

bookie-migrate [options]

In addition to the standard options, the following options are available:

  • -v VERSION: specifies the target database version
Clone this wiki locally