Utility

Overview

COSI comes with a utility located at /opt/circonus/cosi/bin/cosi. You can add /opt/circonus/cosi/bin to your PATH for easier access.

$ /opt/circonus/cosi/bin/cosi help

  Usage: cosi [options] [command]


  Commands:

    check       COSI check actions
    graph       COSI graph actions
    worksheet   COSI worksheet actions
    rulesets    Manage Alert rule sets
    plugin      Manage agent plugins
    template    COSI check & graph template actions
    broker      Circonus broker information actions
    register    Register host using COSI templates & configuration
    reset       Remove COSI checks, graphs, and worksheets
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

COSI Utilities

A suite of tools for working with COSI checks, graphs, and worksheets.
The context of these tools is this host. Meaning, limited to what checks,
metrics, graphs, and worksheets were created by COSI on this host.

For example:

	$ cosi check list

Will list the checks for this host which were created with this tool.
There may be other checks in Circonus which were not created by COSI.

Help for each command is accessed by passing help <cmd> on the command line, for example:

$ /opt/circonus/cosi/bin/cosi help check

  Usage: cosi-check [options] [command]


  Commands:

    create      create a check using a local config
    fetch       fetch checks for host using Circonus API
    list        list local checks for host
    update      update a check using a modified local config
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Or, by passing -h or --help to the command directly, for example:

$  /opt/circonus/cosi/bin/cosi reset -h

  Usage: cosi-reset [options]

  Options:

    -h, --help            output usage information
    -V, --version         output the version number
    -a, --all             Delete all COSI checks, graphs, and worksheets for this host
    -c, --check [id]      Delete COSI check with [id] or all checks for this host
    -g, --graph [id]      Delete COSI graph with [id] or all graphs for this host
    -d, --dashboard [id]  Delete COSI dashboard with [id] or all dashboards for this host
    -w, --worksheet [id]  Delete COSI worksheet with [id] or all worksheets for this host
    -r, --ruleset [id]    Delete COSI ruleset with [id] or all rulesets
    --notemplate          Keep template files, do not remove with registration and config files.
    --configs             Remove the COSI configuration files. Combine with --all for a re-install.
    -q, --quiet           Only error output

Commands

Check

Manage checks.

$  /opt/circonus/cosi/bin/cosi help check

  Usage: cosi-check [options] [command]


  Commands:

    create      create a check using a local config
    fetch       fetch checks for host using Circonus API
    list        list local checks for host
    update      update a check using a modified local config
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Graph

Manage graphs.

$ /opt/circonus/cosi/bin/cosi help graph

  Usage: cosi-graph [options] [command]


  Commands:

    create      create a graph using a local config
    list        list local graphs for host
    update      update a graph using a modified local config
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Worksheet

Manage worksheets.

$  /opt/circonus/cosi/bin/cosi help worksheet

  Usage: cosi-worksheet [options] [command]


  Commands:

    create      create a worksheet using a local config
    list        list local worksheets for host
    update      update a worksheet using a modified local config
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Rulesets

Manage rulesets.

$ /opt/circonus/cosi/bin/cosi help rulesets

  Usage: cosi-rulesets [options] [command]


  Commands:

    create      create a rulesets using a local config
    delete      delete local ruleset(s) for host
    list        list local rulesets for host
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Plugin

Manage NAD plugins with cosi support.

$ /opt/circonus/cosi/bin/cosi help plugin

  Usage: cosi-plugin [options] [command]


  Commands:

    cassandra   Manage Cassandra plugin
    postgres    Manage PostgreSQL plugin
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Tempalte

Fetch and display information about templates.

$  /opt/circonus/cosi/bin/cosi help template

  Usage: cosi-template [options] [command]


  Commands:

    fetch       fetch default templates from COSI site
    list        list local templates for check(s)/graph(s)
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Broker

Displays information about brokers which are available given the current configuration.

$ /opt/circonus/cosi/bin/cosi help broker

  Usage: cosi-broker [options] [command]


  Commands:

    default     show default broker
    list        list available brokers
    show        show information about a specific broker
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Register

Can be used to re-register a system, if the cosi configuration files exist. Or, in an orchestration scenario, pre-seeding a system with the needed packages, configs, and then running registration manually.

$ /opt/circonus/cosi/bin/cosi help register

  Usage: cosi-register [options]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
    -q, --quiet    only error output

Reset

Use to reset a system, deleting the check(s), graph(s), worksheet(s), etc. created during registration.

$ /opt/circonus/cosi/bin/cosi help reset

  Usage: cosi-reset [options]

  Options:

    -h, --help            output usage information
    -V, --version         output the version number
    -a, --all             Delete all COSI checks, graphs, and worksheets for this host
    -c, --check [id]      Delete COSI check with [id] or all checks for this host
    -g, --graph [id]      Delete COSI graph with [id] or all graphs for this host
    -d, --dashboard [id]  Delete COSI dashboard with [id] or all dashboards for this host
    -w, --worksheet [id]  Delete COSI worksheet with [id] or all worksheets for this host
    -r, --ruleset [id]    Delete COSI ruleset with [id] or all rulesets
    --notemplate          Keep template files, do not remove with registration and config files.
    --configs             Remove the COSI configuration files. Combine with --all for a re-install.
    -q, --quiet           Only error output