Ubiquiti UniFi Network Monitoring

LogicMonitor offers out-of-the-box monitoring for Ubiquiti UniFi Network controllers. Our monitoring package uses the Ubiquiti UniFi Network API to query the UniFi Network controller for a variety of performance metrics, including temperature, memory, CPU usage, load averages on security gateways, wired and wireless traffic overviews, site throughput metrics, and individual access point metrics such as overall throughput, error, and packet count monitoring.

Setup Requirements

Add Resource into Monitoring

Add your Ubiquiti UniFi Network host into monitoring. Set a unifi.user and unifi.pass property for the resource that has adequate access permissions to your UniFi Network controller’s API. For more information about adding resources into monitoring, see Adding Devices.

Import LogicModules

From the LogicMonitor repository, import all Ubiquiti UniFi Network modules listed in the LogicModules in Package section. If these LogicModules are already present, ensure you have the most recent versions.

Once the LogicModules are imported (assuming all previous setup requirements have been met), the suite of Ubiquiti Unifi Network modules will automatically begin collecting data.

Considerations

• This suite was designed for monitoring on-prem controllers configured as UniFi Network systems directly.

LogicModules in Package

LogicMonitor’s package for Ubiquiti UniFi Network monitoring consists of the following LogicModules. For full coverage, please ensure that these LogicModules are imported into your LogicMonitor platform.

Display Name	Type	Description
addCategory_Ubiquiti_UniFi	PropertySource	Discovers if a host is a Ubiquiti UniFi Controller and sets the appropriate system category.
Ubiquiti_UniFi_AccessPoints	DataSource	Monitors Ubiquiti UniFi individual access point performance metrics.
Ubiquiti_UniFi_Sites	DataSource	Monitors UniFi site status, throughput metrics, connected users and associated access points.
Ubiquiti_UniFi_Clients_Wired	DataSource	Monitors Ubiquiti UniFi connected client’s throughput and uptime based on the UniFi API.
Ubiquiti_UniFi_Clients_Wireless	DataSource	Monitors Ubiquiti UniFi connected client’s throughput and uptime baseMonitors Ubiquiti UniFi wireless connected client’s throughput and uptime based on the UniFi API.
Ubiquiti_UniFi_Security_Gateways	DataSource	Monitors Ubiquiti UniFi performance metrics on the Security Gateway devices (USG’s).
Ubiquiti_UniFi_Switches	DataSource	Monitors Ubiquiti UniFi individual switch performance metrics.
addERI_Ubiquiti	PropertySource (required for portals with topology)	Sets device External Resource IDs (ERIs) for layer 2 topology mapping of Ubiquiti Unifi devices, including MAC address and an —-<ip_addrs_1>–<ip_addrs_2>… ERI for wireless mapping using the Ubiquiti Unifi API.
Ubiquiti_UniFi_Wireless	TopologySource	Maps Ubiquiti UniFi topologies.

When setting static datapoint thresholds on the various metrics tracked by this package’s DataSources, LogicMonitor follows the technology owner’s best practice KPI recommendations. If necessary, we encourage you to adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.