This repository has been archived by the owner on Oct 21, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Utility
matt maier edited this page Feb 23, 2017
·
8 revisions
COSI comes with a utility located at /opt/circonus/cosi/bin/cosi
$ /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