circonus-agent

README

Circonus Agent

Version 1.x of the circonus-agent only supports metrics with stream tags (if it is dropped in an existing NAD install, the metric names will change). If metric name continuity is required, use the v0 circonus-agent releases.

Features

1. Replacement for NAD, written in Go - note, v0.x only
2. Builtin metric collectors -- the default Linux builtins emit the common metrics needed for cosi visuals (graphs, worksheets, & dashboards)
3. Plugin architecture for local metric collection
4. Local HTTP Receiver for POST/PUT metric collection
5. Local StatsD listener for application metrics
6. Prometheus format support
   1. Receive HTTP PUT|POST to /prom endpoint (e.g. PUT http://127.0.0.1:2609/prom)
   2. Fetch (see Prometheus collector for details)
   3. Extract HTTP GET of /prom endpoint will emit metrics in Prometheus format (e.g. GET http://127.0.0.1:2609/prom)

Releases

• Binary only releases provide pre-built binaries for Linux (arm and x86_64), FreeBSD (x86_64), Solaris (x86_64), and Windows (x86_64).
• RPM and DEB packages for manual installations with plugins included
• Docker images

Install

Automated via cosi

Note: installs v0 release of the circonus-agent, not the v1 release

curl -sSL https://setup.circonus.com/install | bash \
    -s -- \
    --cosiurl https://setup.circonus.com/ \
    --key <insert api key> \
    --app <insert api app>

Features of the COSI installed circonus-agent on Linux systems:

• 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

Operating Systems (x86_64 and/or amd64) supported by cosi:

• RHEL8 (CentOS, RedHat)
• RHEL7 (CentOS, RedHat, Oracle)
• RHEL6 (CentOS, RedHat, amzn)
• Ubuntu20
• Ubuntu18
• Ubuntu16
• Debian9
• Debian8
• FreeBSD 12 (build 12.1-STABLE)
• FreeBSD 11 (build 11.3-STABLE)

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 or illumos_x86_64) and Raspian (linux_arm or linux_arm64) are available in the circonus-agent repository.

Manual upgrade cosi installed NAD

Note: v1+ of the agent supports stream tags only. This will change metric names in any existing checks if a NAD install is updated. To maintain metric name continuity, use the v0 circonus-agent release packages.

1. mkdir -p /opt/circonus/agent
2. Download latest release from repository (v0 or v1 - see note above)
3. Extract archive into /opt/circonus/agent
4. Create a config (see minimal example below) or use command line parameters
5. Copy, edit, and install one of the service configurations in service/
6. Stop NAD (e.g. systemctl stop nad or /etc/init.d/nad stop)
7. Start the circonus-agent (e.g. systemctl start circonus-agent or /etc/init.d/circonus-agent start)
8. Disable NAD service so that it will not start at next reboot

Example, minimal, configuration using existing cosi install, configuration would be placed into /opt/circonus/agent/etc/circonus-agent.toml:

# enable debug for more verbose messages
#debug = true

# set the plugin directory to NAD's plugins
plugin-dir = "/opt/circonus/nad/etc/node-agent.d"

[api]
key = "cosi" # use cosi api configuration

[check]
bundle_id = "cosi" # use cosi system check bundle

[reverse]
enabled = true

Manual, stand-alone (non-windows)

1. mkdir -p /opt/circonus/agent
2. Download latest release from repository or RPM/DEB/TGZ package
3. Extract archive into /opt/circonus/agent or manually install os package
4. Create a config (see minimal example below) or use command line parameters
5. Optionally, modify and install a service configuration

Manual, stand-alone (windows)

1. Create a directory (e.g. md C:\agent)
2. Download latest release from repository
3. Unzip archive into directory created in step 1
4. Create a config (see minimal example below) or use command line parameters
5. Optionally, create a service (for example, using PowerShell)

Docker

This is one of many potential methods for collecting metrics from a Docker infrastructure. Which method is leveraged is infrastructure and solution dependent. The advantages of this more generic method would be that metrics from the host system, as well as, individual container metrics will be collected. Additionally, applications running in containers will be able to leverage common StatsD and/or JSON endpoints exposed by the circonus-agent running on the host system.

1. Install the circonus-agent on the host system (via cosi or manually)
2. Run cAdvisor
3. Configure cAdvisor to export metrics via StatsD to the circonus-agent or configure the circonus-agent to collect metrics from the cAdvisor Prometheus endpoint

Configuration Options

$ /opt/circonus/agent/sbin/circonus-agentd -h
Flags:
      --api-app string                    [ENV: CA_API_APP] Circonus API Token app (default "circonus-agent")
      --api-ca-file string                [ENV: CA_API_CA_FILE] Circonus API CA certificate file
      --api-key string                    [ENV: CA_API_KEY] Circonus API Token key
      --api-url string                    [ENV: CA_API_URL] Circonus API URL (default "https://api.circonus.com/v2/")
      --check-broker string               [ENV: CA_CHECK_BROKER] ID of Broker to use or 'select' for random selection of valid broker, if creating a check bundle (default "select")
  -C, --check-create                      [ENV: CA_CHECK_CREATE] Create check bundle
  -I, --check-id string                   [ENV: CA_CHECK_ID] Check Bundle ID or 'cosi' for cosi system check
      --check-metric-filter-file string   [ENV: CA_CHECK_METRIC_FILTER_FILE] JSON file with metric filters (default "/opt/circonus/agent/etc/metric_filters.json")
      --check-metric-filters string       [ENV: CA_CHECK_METRIC_FILTERS] List of filters used to manage which metrics are collected
  -S, --check-metric-streamtags           [ENV: CA_CHECK_METRIC_STREAMTAGS] Add check tags to metrics as stream tags
      --check-period uint                 [ENV: CA_CHECK_PERIOD] When broker requests metrics [10-300] seconds (default 60)
      --check-tags string                 [ENV: CA_CHECK_TAGS] Tags [comma separated list] to use, if creating a check bundle
  -T, --check-target string               [ENV: CA_CHECK_TARGET] Check target host (for creating a new check) (default host name from OS)
      --check-timeout float               [ENV: CA_CHECK_TIMEOUT] Timeout when broker requests metrics [0-300] seconds (default 10)
      --check-title string                [ENV: CA_CHECK_TITLE] Title [display name] to use, if creating a check bundle (default "<check-target> /agent")
  -U, --check-update                      [ENV: CA_CHECK_UPDATE] Force check bundle update at start (with all configurable check bundle attributes)
      --check-update-metric-filters       [ENV: CA_CHECK_UPDATE_METRIC_FILTERS] Update check bundle with configured metric filters when agent starts
      --cluster-enable                    [ENV: CA_CLUSTER_ENABLE] Enable cluster awareness mode
      --cluster-enable-builtins           [ENV: CA_CLUSTER_ENABLE_BUILTINS] Enable builtins in cluster awareness mode
      --cluster-statsd-histogram-gauges   [ENV: CA_CLUSTER_STATSD_HISTOGRAM_GAUGES] Represent StatsD gauges as histograms in cluster awareness mode
      --collectors strings                [ENV: CA_COLLECTORS] List of builtin collectors to enable (default based on OS)
  -c, --config string                     config file (default is /opt/circonus/agent/etc/circonus-agent.(json|toml|yaml)
  -d, --debug                             [ENV: CA_DEBUG] Enable debug messages
      --debug-api                         [ENV: CA_DEBUG_API] Enable Circonus API debug messages
      --debug-cgm                         [ENV: CA_DEBUG_CGM] Enable CGM debug messages
      --debug-dump-metrics string         [ENV: CA_DEBUG_DUMP_METRICS] Directory to dump sent metrics
  -h, --help                              help for circonus-agent
      --host-etc string                   [ENV: HOST_ETC] Host /etc directory
      --host-proc string                  [ENV: HOST_PROC] Host /proc directory
      --host-run string                   [ENV: HOST_RUN] Host /run directory
      --host-sys string                   [ENV: HOST_SYS] Host /sys directory
      --host-var string                   [ENV: HOST_VAR] Host /var directory
  -l, --listen strings                    [ENV: CA_LISTEN] Listen spec e.g. :2609, [::1], [::1]:2609, 127.0.0.1, 127.0.0.1:2609, foo.bar.baz, foo.bar.baz:2609 (default ":2609")
  -L, --listen-socket strings             [ENV: CA_LISTEN_SOCKET] Unix socket to create
      --log-level string                  [ENV: CA_LOG_LEVEL] Log level [(panic|fatal|error|warn|info|debug|disabled)] (default "info")
      --log-pretty                        [ENV: CA_LOG_PRETTY] Output formatted/colored log lines [ignored on windows]
  -m, --multi-agent                       [ENV: CA_MULTI_AGENT] Enable multi-agent mode
      --multi-agent-interval string       [ENV: CA_MULTI_AGENT_INTERVAL] Multi-agent mode interval (default "60s")
      --no-gzip                           Disable gzip HTTP responses
      --no-statsd                         [ENV: CA_NO_STATSD] Disable StatsD listener
  -p, --plugin-dir string                 [ENV: CA_PLUGIN_DIR] Plugin directory (/opt/circonus/agent/plugins)
      --plugin-list strings               [ENV: CA_PLUGIN_LIST] List of explicit plugin commands to run
      --plugin-ttl-units string           [ENV: CA_PLUGIN_TTL_UNITS] Default plugin TTL units (default "s")
  -r, --reverse                           [ENV: CA_REVERSE] Enable reverse connection
      --reverse-broker-ca-file string     [ENV: CA_REVERSE_BROKER_CA_FILE] Broker CA certificate file
      --show-config string                Show config (json|toml|yaml) and exit
      --ssl-cert-file string              [ENV: CA_SSL_CERT_FILE] SSL Certificate file (PEM cert and CAs concatenated together) (default "/opt/circonus/agent/etc/circonus-agent.pem")
      --ssl-key-file string               [ENV: CA_SSL_KEY_FILE] SSL Key file (default "/opt/circonus/agent/etc/circonus-agent.key")
      --ssl-listen string                 [ENV: CA_SSL_LISTEN] SSL listen address and port [IP]:[PORT] - setting enables SSL
      --ssl-verify                        [ENV: CA_SSL_VERIFY] Enable SSL verification (default true)
      --statsd-addr string                [ENV: CA_STATSD_ADDR] StatsD address to listen on (default "localhost")
      --statsd-enable-tcp                 [ENV: CA_STATSD_ENABLE_TCP] Enable StatsD TCP listener
      --statsd-group-cid string           [ENV: CA_STATSD_GROUP_CID] StatsD group check bundle ID
      --statsd-group-counters string      [ENV: CA_STATSD_GROUP_COUNTERS] StatsD group metric counter handling (average|sum) (default "sum")
      --statsd-group-gauges string        [ENV: CA_STATSD_GROUP_GAUGES] StatsD group gauge operator (default "average")
      --statsd-group-prefix string        [ENV: CA_STATSD_GROUP_PREFIX] StatsD group metric prefix (default "group.")
      --statsd-group-sets string          [ENV: CA_STATSD_GROPUP_SETS] StatsD group set operator (default "sum")
      --statsd-host-category string       [ENV: CA_STATSD_HOST_CATEGORY] StatsD host metric category (default "statsd")
      --statsd-host-prefix string         [ENV: CA_STATSD_HOST_PREFIX] StatsD host metric prefix
      --statsd-max-tcp-connections uint   [ENV: CA_STATSD_MAX_TCP_CONNS] StatsD maximum TCP connections (default 250)
      --statsd-port string                [ENV: CA_STATSD_PORT] StatsD port to listen on (default "8125")
  -V, --version                           Show version and exit

Configuration

The Circonus agent can be configured via the command line, environment variables, and/or a configuration file. For details on using configuration files, see the configuration section of etc/README.md

Collecting metrics with the agent

Builtin collectors

The circonus-agent has builtin collectors offering a higher level of efficiency over executing plugins. The circonus-agent --collectors command line option controls which collectors are enabled. Builtin collectors take precedence over plugins - if a builtin collector exists with the same ID as a plugin, the plugin will not be activated. For complete list of builtin collectors and details on collector specific configuration see etc/README.md.

Configuration:

• Command line --collectors (space delimited list)
• Environment CA_COLLECTORS (space delimited list)
• Config file collectors (array of strings)

To disable all default builtin collectors pass --collectors="" on the command line or configure collectors attribute in a configuration file.

Plugins

For documentation on plugins please refer to plugins/README.md.

Receiver

The Circonus agent provides a special handler for the endpoint /write which will accept HTTP POST and HTTP PUT requests containing structured JSON.

The structure of the JSON expected by the receiver is the same as the JSON format accepted from plugins. See the JSON section of the plugin documentation for details on the structure.

The URL syntax for sending metrics is /write/ID where ID is a prefix for all of the metrics being sent in the request.

For example:

HTTP POST http://127.0.0.1:2609/write/test with a payload of:

{
    "t1": {
        "_type": "i",
        "_value": 32
    },
    "t2": {
        "_tags": ["abc:123"],
        "_type": "s",
        "_value": "foo"
    }
}

Would result in metrics in the Circonus UI of:

test`t1 numeric 32
test`t2|ST[abc:123] text "foo"

StatsD

The Circonus agent provides a StatsD listener by default (disable: --no-statsd, configure port: --statsd-port). It accepts the basic StatsD metric types as well as, Circonus specific metric types h and t. In addition, the StatsD listener support adding stream tags to metrics via |#tag_list added to a metric (where tag_list is a comma separated list of key:value pairs).

Syntax: name:value|type[|@rate][|#tag_list]

Type	Note
c	Counter
g	Gauge
h	Histogram - Circonus specific
ms	Timing - treated as a Histogram
s	Sets - treated as a Counter
t	Text - Circonus specific

NOTE: the derivative metrics automatically generated with some StatsD types are not created by Circonus, as the data is already available within the Circonus UI.

Prometheus

The /prom endpoint will accept Prometheus style text formatted metrics sent via HTTP PUT or HTTP POST.

Multi-agent

In some specific use-cases having multiple agents send to a single check may be desirable. This type of configuration is supported with Enterprise brokers only. To enable ensure that multi_agent.enabled is set to true and that every agent uses the same configuration settings for the check. For example, to generate a basic configuration:

sbin/circonus-agentd \
  -m \                                  # enable multi-agent
  -C \                                  # enable check creation
  --collectors="" \                     # disable built-in collectors
  --api-key=... \                       # add your api key
  --check-target=common_id \            # use a common identifier on each agent instance
  --check-broker=enterprise_broker_id \ # enterprise broker id
  --show-config=yaml \                  # format for config
  >etc/circonus-agent.yaml              # redirect to config file

The above command would set the following options and then redirect the output in yaml format to a configuration file the agent could use. Copy the same configuration file to each of the systems desired.

• -m set multi_agent.enabled to true
• -C set check.create to true
• --collectors="" disable all built-in collectors (to prevent aggregating metrics such as cpu/memory/disk/etc.)
• --api-key= set api.key
• --check-target= set check.target use a common identifier for all of the agents, so that only ONE check will be created
• --check-broker= set check.broker to the enterprise broker id to use
• --show-config= in preferred format (json|toml|yaml)
• >etc/circonus-agent.yaml redirect to a file

Manual build

1. Clone repo git clone https://github.com/circonus-labs/circonus-agent.git
   1. circonus-agent uses go modules, go1.12+ is required
   2. clone oustide of GOPATH (or use GO111MODULE=on)
2. Build go build -o circonus-agentd
3. Install cp circonus-agentd /opt/circonus/agent/sbin

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