Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.89 KB

README.md

File metadata and controls

44 lines (31 loc) · 2.89 KB
Raw

Circonus One Step Install

Circonus One Step Install (cosi) is comprised of two separate pieces.

  1. cosi-tool contains the command line tool used to register a system with Circonus and manage the local registration.
  2. cosi-server, this repository, contains the server used during the installation and registration process. It serves the installation script, whether a specific OS is supported, what circonus-agent package to use, and templates for creating assets in the Circonus system (checks, dashboards, graphs, rulesets, and worksheets).

The circonus-agent is comprised of:

  • replacement for NAD, written in go, with builtin plugins for the common metrics needed for cosi visuals (graphs, worksheets, & dashboards)
  • includes (if OS supports) protocol_observer, no longer needs to be built/installed manually
  • includes (if OS supports) circonus-logwatch, no longer needs to be installed manually
  • includes OS/version/architecture-specific NAD plugins (non-javascript only) -- Note: the circonus-agent is not capable of using NAD native plugins since they require NodeJS

The cosi-tool does not currently include a functional cosi plugin command. This capability will be included in a future release, as the individual cosi plugin ... sub-commands (postgres and cassandra) are completed.

Supported Operating Systems (x86_64 and/or amd64):

  • RHEL7 (CentOS, RedHat, Oracle)
  • RHEL6 (CentOS, RedHat, amzn)
  • Ubuntu18
  • Ubuntu16
  • Ubuntu14
  • Debian9
  • Debian8
  • FreeBSD 12
  • FreeBSD 11

Please continue to use the original cosi(w/NAD) for OmniOS and Raspian - cosi v2 support for these is TBD. Note: after installing NAD a binary circonus-agent can be used as a drop-in replacement (configure circonus-agent plugins directory to be NAD plugins directory -- javascript plugins will not function). Binaries for OmniOS (solaris_x86_64) and Raspian (linux_arm) are available in the circonus-agent repository.

Circonus One Step Install Server

Installation

  1. Download from latest release
  2. Create an installation directory (e.g. mkdir -p /opt/circonus/cosi-server)
  3. Unpack release archive into installation directory
  4. See sbin/cosi-serverd --help
    1. Configure etc/example-cosi-server.yaml (edit, rename cosi-server.yaml)
    2. Configure etc/example-circonus-packages.yaml (edit, rename circonus-packages.yaml)

Unless otherwise noted, the source files are distributed under the BSD-style license found in the LICENSE file.