Unifi Console

Supported OS Linux Mac OS Windows

Integration version1.2.0

Overview

This check monitors Unifi Console through the Datadog Agent.

Setup

The Unifi check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Unifi check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

  1. Run the following command to install the Agent integration:

    sudo -u dd-agent -- datadog-agent integration install -t datadog-unifi_console==1.2.0
    
  2. Configure your integration similar to core integrations.

Configuration

  1. Edit the unifi_console.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Unifi Console performance data. See the sample unifi_console.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for unifi_console under the Checks section.

Data Collected

Metrics

unifi.device.status
(gauge)
Device status
unifi.device.uptime
(gauge)
Device uptime
Shown as second
unifi.device.clients
(gauge)
Clients number
unifi.device.satisfaction
(gauge)
Device Satisfaction
Shown as percent
unifi.device.system.cpu.pct
(gauge)
% of CPU used
Shown as percent
unifi.device.system.mem.used
(gauge)
Memory used
Shown as byte
unifi.device.system.mem.total
(gauge)
Total Memory
Shown as byte
unifi.device.system.mem.buffer
(gauge)
Memory buffer
Shown as byte
unifi.device.system.mem.pct
(gauge)
% of memory used
Shown as percent
unifi.device.tx_packets
(gauge)
Number of transmitted packets
Shown as packet
unifi.device.tx_bytes
(gauge)
Number of transmitted Bytes
Shown as byte
unifi.device.tx_errors
(gauge)
Number of transmitted errors
unifi.device.tx_dropped
(gauge)
Number of transmitted dropped
unifi.device.tx_retries
(gauge)
Number of transmitted retries
unifi.device.rx_packets
(gauge)
Number of received packets
Shown as packet
unifi.device.rx_bytes
(gauge)
Number of received Bytes
Shown as byte
unifi.device.rx_errors
(gauge)
Number of received errors
unifi.device.rx_dropped
(gauge)
Number of received dropped
unifi.device.guests
(gauge)
Number of guests
unifi.device.uplink.rx_bytes
(gauge)
Uplink received bytes
Shown as byte
unifi.device.uplink.rx_dropped
(gauge)
Uplink number of received dropped
unifi.device.uplink.rx_errors
(gauge)
uplink number of received errors
unifi.device.uplink.rx_packets
(gauge)
Uplink received packets
Shown as packet
unifi.device.uplink.tx_bytes
(gauge)
Uplink transmitted bytes
Shown as byte
unifi.device.uplink.tx_dropped
(gauge)
Uplink number of transmitted dropped
unifi.device.uplink.tx_errors
(gauge)
Uplink number of transmitted errors
unifi.device.uplink.tx_packets
(gauge)
Uplink transmitted packets
Shown as packet
unifi.device.uplink.up
(gauge)
Uplink status
unifi.client.noise
(gauge)
Client noise in dBm
unifi.client.rx_bytes
(gauge)
Client received bytes
Shown as byte
unifi.client.rx_packets
(gauge)
Client received packets
Shown as packet
unifi.client.rx_rate
(gauge)
Client received rate
Shown as byte
unifi.client.satisfaction
(gauge)
Client satisfaction
Shown as percent
unifi.client.signal
(gauge)
Client signal in dBm
unifi.client.tx_bytes
(gauge)
Client transmitted bytes
Shown as byte
unifi.client.tx_packets
(gauge)
Client transmitted packets
Shown as packet
unifi.client.tx_rate
(gauge)
Client transmitted rate
Shown as byte
unifi.client.tx_retries
(gauge)
Client transmitted retry
unifi.client.uptime
(gauge)
Client uptime
Shown as second
unifi.client.up
(gauge)
Client up

Events

The Unifi Console integration does not include any events.

Service Checks

unifi.can_connect
Returns CRITICAL if the Agent fails to connect to the Unifi Console, otherwise OK.
Statuses: ok, critical

unifi.healthy
Returns CRITICAL if the Unifi Console is not up, otherwise OK.
Statuses: ok, critical

unifi.device
Returns CRITICAL if the device is not in state 1, otherwise OK.
Statuses: ok, critical

unifi.device.uplink
Returns CRITICAL if the device uplink is not up, otherwise OK.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.