README
¶
Circonus Unified Agent
The Circonus Unified Agent, affectionately referred to as CUA [see-you-ey], is an agent for collecting metrics and writing them to the Circonus service.
CUA collects metrics through various input plugins, allowing Circonus customers to monitor systems, services, and 3rd party APIs.
These input plugins are designed to be easy to develop and contribute. Pull requests are very welcome, as we seek to expand support for and incorporate support for many technologies.
Documentation
The user documentation, including instructions for installation and administration, is located at https://docs.circonus.com/circonus/agents/circonus-unified-agent/
The developer guide, covering concepts and development details, is located under the docs directory of the present repo.
Getting Started
Minimum Requirements
CUA shares the same minimum requirements as Go:
- Linux kernel 2.6.23 or later
- Windows 7 or later
- FreeBSD 11.2 or later
- MacOS 10.11 El Capitan or later
Changelog
View the changelog for the latest updates and changes by version.
Contributing
There are many ways to contribute:
- Fix and report bugs
- Improve documentation
- Review code and feature proposals
- Answer questions and discuss here on github and on the Circonus Lab's Slack
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
choice
Package choice provides basic functions for working with plugin options that must be one of several values.
|
Package choice provides basic functions for working with plugin options that must be one of several values. |
|
plugins
|
|
|
inputs/docker
Helper functions copied from https://github.com/docker/cli/blob/master/cli/command/container/stats_helpers.go
|
Helper functions copied from https://github.com/docker/cli/blob/master/cli/command/container/stats_helpers.go |
|
inputs/jti_openconfig_telemetry/auth
Package authentication is a generated protocol buffer package.
|
Package authentication is a generated protocol buffer package. |
|
inputs/jti_openconfig_telemetry/oc
Package telemetry is a generated protocol buffer package.
|
Package telemetry is a generated protocol buffer package. |
|
inputs/lustre2
Lustre 2.x plugin
|
Lustre 2.x plugin |
|
inputs/minecraft/internal/rcon
Package rcon implements the communication protocol for communicating with RCON servers.
|
Package rcon implements the communication protocol for communicating with RCON servers. |
|
inputs/neptune_apex
Package neptuneapex implements an input plugin for the Neptune Apex aquarium controller.
|
Package neptuneapex implements an input plugin for the Neptune Apex aquarium controller. |
|
inputs/phpfpm
Package fcgi implements the FastCGI protocol.
|
Package fcgi implements the FastCGI protocol. |
|
inputs/uwsgi
Package uwsgi implements a plugin for collecting uwsgi stats from the uwsgi stats server.
|
Package uwsgi implements a plugin for collecting uwsgi stats from the uwsgi stats server. |
|
inputs/win_eventlog
Package win_eventlog Input plugin to collect Windows Event Log messages
|
Package win_eventlog Input plugin to collect Windows Event Log messages |
|
inputs/x509_cert
Package x509_cert reports metrics from an SSL certificate.
|
Package x509_cert reports metrics from an SSL certificate. |
|
inputs/zipkin/cmd/thrift_serialize
A small cli utility meant to convert json to zipkin thrift binary format, and vice versa.
|
A small cli utility meant to convert json to zipkin thrift binary format, and vice versa. |
|
outputs/circonus
Package circonus contains the output plugin used to output metric data to the Circonus platform.
|
Package circonus contains the output plugin used to output metric data to the Circonus platform. |
|
parsers/influx
nolint
|
nolint |
|
selfstat is a package for tracking and collecting internal statistics about the agent.
|
selfstat is a package for tracking and collecting internal statistics about the agent. |