Circonus One Step Installer
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
docker
example
provision
src
test
.gitignore
LICENSE
README.md
Vagrantfile

README.md

COSI - The Circonus One Step Installer

The purpose of COSI is to simplify the task of getting metrics flowing from a new host into Circonus, consisting of:

  1. Install and configure the Circonus monitoring agent nad

  2. Create and configure a Circonus check that receives data from the agent

  3. 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.

Quickstart

In most cases, you will want to use the Circonus UI to install COSI on your host:

  1. Log into your Circonus Account

  2. Go to the Checks page, click [NEW HOST+] on the top right.

  3. Copy and run the command displayed on the host to be setup.

Add Host Screenshot

Content

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.