Home

Circonus One Step Install (cosi)

The purpose of COSI is to simplify the most rudimentary task both new and existing users face - getting metrics flowing from a new host into Circonus. The goal is to provide a cut-n-paste command that reduces the following to one step without inhibiting customization and orchestration/automation.

1. Select an agent
2. Install the agent
3. Configure the agent to expose metrics
4. Start the agent
5. Create a check to retrieve/accept the metrics from the agent
6. Enable basic system metrics
7. Create graphs for each of the basic metric groups (e.g. cpu, memory, disk, network, filesystem, etc.)
8. Optionally, create a worksheet containing the basic graphs so there is a unified view of the specific host

Given the objective, cosi must be opinionated regarding certain steps. The Circonus Node Agent (NAD), is the agent cosi supports. Much of cosi is template based to enable customization, the standard templates strive to provide sensible defaults.

There are two distinct components within the cosi repository. The site and the installer. The site is comprised of a node script providing a simple API to serve the installer itself, [check, graph, worksheet] configuration templates, and pointers to the NAD packages available form Circonus. The installer is composed of a shell script which interacts with the site to orchestrate the installation process.

A list of supported distributions can be retrieved via curl https://onestep.circonus.com/

The current list is as follows:

{
  "description": "Circonus One Step Install",
  "supported": [
    "Ubuntu 16.04 x86_64",
    "Ubuntu 14.04 i386",
    "Ubuntu 14.04 x86_64",
    "Ubuntu 12.04 i386",
    "Ubuntu 12.04 x86_64",
    "CentOS 5 x86_64",
    "CentOS 5 i386",
    "CentOS 6 x86_64",
    "CentOS 6 i686",
    "CentOS 7 x86_64",
    "RedHat 6 x86_64",
    "RedHat 7 x86_64",
    "Oracle 7 x86_64",
    "OmniOS 151014 amd64",
    "amzn 2016.03 x86_64",
    "amzn 2017.03 x86_64",
    "debian 7 x86_64",
    "debian 8 x86_64",
    "debian 9 x86_64",
    "FreeBSD 11.0 amd64",
    "FreeBSD 12.0 amd64",
    "raspbian 8 armv6l",
    "raspbian 8 armv7l",
    "raspbian 9 armv6l",
    "raspbian 9 armv7l"
  ],
  "version": "2.7.1"
}

Important note for NAT: If using the --agent pull cosi-install command line parameter - ensure the Circonus Broker will be able to connect to the host on TCP port 2609. (e.g. An AWS security group.) The default mode for a cosi NAD installation is --agent reverse - where the host connects to the Circonus Broker rather than the Circonus Broker connecting to the host.

Note that the Play functionality in the Circonus UI is limited when metrics are being sent(pushed) from a system to a Circonus Broker rather than being actively requested(pulled) from the system by the Broker.

In theory, the other point releases (of CentOS 5,6,7) and x86 architectures of the above releases are also supported but they have not been tested yet (2016-05-20). If you require that a specific OS distribution release/architecture be supported urgently, please post a message in the Circonus Labs Slack #tools channel(web|desktop) or send an email to [[email protected]](mailto:[email protected]?subject=COSI x86 support request) with specifics regarding the distribution and version.

The cosi site has been tested on:

• OmniOS r151014
• CentOS 7.2 x86_64
• Ubuntu 14.04 x86_64

Note: The cosi site is optional. It does not need to be installed unless customization to support a specific environment is needed, or, the hosts in the environment are not able to access the internet. Circonus provides, and maintains, a public cosi site at onestep.circonus.com.

Running into issues? Check out the Troubleshooting section.