This version of cosi is no longer active. Please see cosi-server and cosi-tool for the up-to-date version of cosi.
The purpose of COSI is to simplify the task of getting metrics flowing from a new host into Circonus, consisting of:
-
Install and configure the Circonus monitoring agent nad
-
Create and configure a Circonus check that receives data from the agent
-
Create graphs and worksheets for each of the basic metric groups (e.g. cpu, memory, disk, network, filesystem, etc.)
COSI automates all these steps with a single cut-n-paste command without inhibiting customization and orchestration/automation. In addition it provides a command line utility command, for managing the Circonus check for the hosts.
In most cases, you will want to use the Circonus UI to install COSI on your host:
-
Log into your Circonus Account
-
Go to the Checks page, click
[NEW HOST+]on the top right. -
Copy and run the command displayed on the host to be setup.
This repository contains the following components:
-
COSI installer. A shell script that interacts with the COSI site API.
-
COSI utility. A command line utility for configuring metrics, checks, graphs and worksheets created by COSI.
-
COSI site. A Node.js-based service that serves the COSI installer itself, templates, and pointers to NAD packages. Most users will rely on the hosted COSI site provided by Circonus (https://onestep.circonus.com).
The COSI user documentation is in the wiki for this repository.