CUA for MacOS

This page outlines the installation and configuration of CUA for MacOS.

Installation

A one-step installer script is provided on the CUA configuration page within Circonus.

The MacOS installer may be easily executed by running the following command as root:

curl -sSL "https://raw.githubusercontent.com/circonus-labs/circonus-unified-agent/master/install/install_macos.sh" | bash -s -- --key <circonus api key>

Notably, the provided API key should be set to “allow” to allow the creation of the associated check(s) when executing the above command.

Alternatively, download links for the latest releases can be found on this page, which can be manually placed on a given host.

Configuration

CUA’s configuration file is written using TOML and is composed of three sections: global tags, agent settings, and plugins.

By default, the CUA configuration file is expected to be placed at: /opt/circonus/unified-agent/etc/circonus-unified-agent.conf. All integration configuration is controlled via this single configuration file.

A sample configuration file can be found here.

The only required argument is your Circonus API Key, which will be auto-populated by the one-step installer referenced above. CUA will collect CUA health metrics default on macOS systems.

If you make changes to the configuration file, you must restart CUA. To restart CUA open a terminal window and enter the following:

sudo launchctl kickstart -k system/com.circonus.circonus-unified-agent

Dashboard

CUA for MacOS includes a turnkey service dashboard.

Image: ‘macos-dashboard-system.png’