--- title: Unifi Console description: This check collects metrics from the Unifi Controller breadcrumbs: Docs > Integrations > Unifi Console --- # Unifi Console Supported OS Integration version2.0.0 ## Overview{% #overview %} This check monitors [Unifi Console](https://ui.com/consoles) through the Datadog Agent. ## Setup{% #setup %} The Unifi check is not included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you need to install it. ### Installation{% #installation %} For Agent v7.21+ / v6.21+, follow the instructions below to install the Unifi check on your host. See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/use-community-integrations.md) to install with the Docker Agent or earlier versions of the Agent. 1. Run the following command to install the Agent integration: ```shell sudo -u dd-agent -- datadog-agent integration install -t datadog-unifi_console==1.3.0 ``` 1. Configure your integration similar to core [integrations](https://docs.datadoghq.com/getting_started/integrations.md). ### Configuration{% #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](https://github.com/DataDog/integrations-extras/blob/master/unifi_console/datadog_checks/unifi_console/data/conf.yaml.example) for all available configuration options. 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent). ### Validation{% #validation %} [Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `unifi_console` under the Checks section. ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **unifi\_console.device.status**(gauge) | Device status | | **unifi\_console.device.uptime**(gauge) | Device uptime*Shown as second* | | **unifi\_console.device.clients**(gauge) | Clients number | | **unifi\_console.device.satisfaction**(gauge) | Device Satisfaction*Shown as percent* | | **unifi\_console.device.system.cpu.pct**(gauge) | % of CPU used*Shown as percent* | | **unifi\_console.device.system.mem.used**(gauge) | Memory used*Shown as byte* | | **unifi\_console.device.system.mem.total**(gauge) | Total Memory*Shown as byte* | | **unifi\_console.device.system.mem.buffer**(gauge) | Memory buffer*Shown as byte* | | **unifi\_console.device.system.mem.pct**(gauge) | % of memory used*Shown as percent* | | **unifi\_console.device.tx\_packets**(gauge) | Number of transmitted packets*Shown as packet* | | **unifi\_console.device.tx\_bytes**(gauge) | Number of transmitted Bytes*Shown as byte* | | **unifi\_console.device.tx\_errors**(gauge) | Number of transmitted errors | | **unifi\_console.device.tx\_dropped**(gauge) | Number of transmitted dropped | | **unifi\_console.device.tx\_retries**(gauge) | Number of transmitted retries | | **unifi\_console.device.rx\_packets**(gauge) | Number of received packets*Shown as packet* | | **unifi\_console.device.rx\_bytes**(gauge) | Number of received bytes*Shown as byte* | | **unifi\_console.device.rx\_errors**(gauge) | Number of received errors | | **unifi\_console.device.rx\_dropped**(gauge) | Number of received dropped | | **unifi\_console.device.guests**(gauge) | Number of guests | | **unifi\_console.device.uplink.rx\_bytes**(gauge) | Uplink received bytes*Shown as byte* | | **unifi\_console.device.uplink.rx\_dropped**(gauge) | Uplink number of received dropped | | **unifi\_console.device.uplink.rx\_errors**(gauge) | uplink number of received errors | | **unifi\_console.device.uplink.rx\_packets**(gauge) | Uplink received packets*Shown as packet* | | **unifi\_console.device.uplink.tx\_bytes**(gauge) | Uplink transmitted bytes*Shown as byte* | | **unifi\_console.device.uplink.tx\_dropped**(gauge) | Uplink number of transmitted dropped | | **unifi\_console.device.uplink.tx\_errors**(gauge) | Uplink number of transmitted errors | | **unifi\_console.device.uplink.tx\_packets**(gauge) | Uplink transmitted packets*Shown as packet* | | **unifi\_console.device.uplink.up**(gauge) | Uplink status | | **unifi\_console.client.noise**(gauge) | Client noise in dBm | | **unifi\_console.client.rx\_bytes**(gauge) | Client received bytes*Shown as byte* | | **unifi\_console.client.rx\_packets**(gauge) | Client received packets*Shown as packet* | | **unifi\_console.client.rx\_rate**(gauge) | Client received rate*Shown as byte* | | **unifi\_console.client.satisfaction**(gauge) | Client satisfaction*Shown as percent* | | **unifi\_console.client.signal**(gauge) | Client signal in dBm | | **unifi\_console.client.tx\_bytes**(gauge) | Client transmitted bytes*Shown as byte* | | **unifi\_console.client.tx\_packets**(gauge) | Client transmitted packets*Shown as packet* | | **unifi\_console.client.tx\_rate**(gauge) | Client transmitted rate*Shown as byte* | | **unifi\_console.client.tx\_retries**(gauge) | Client transmitted retry | | **unifi\_console.client.uptime**(gauge) | Client uptime*Shown as second* | | **unifi\_console.client.up**(gauge) | Client up | | **unifi\_console.healthy**(gauge) | Health status | ### Events{% #events %} The Unifi Console integration does not include any events. ### Service Checks{% #service-checks %} **unifi\_console.can\_connect** Returns `CRITICAL` if the Agent fails to connect to the Unifi Console, otherwise `OK`. *Statuses: ok, critical* **unifi\_console.healthy** Returns `CRITICAL` if the Unifi Console is not up, otherwise `OK`. *Statuses: ok, critical* **unifi\_console.device** Returns `CRITICAL` if the device is not in state 1, otherwise `OK`. *Statuses: ok, critical* **unifi\_console.device.uplink** Returns `CRITICAL` if the device uplink is not up, otherwise `OK`. *Statuses: ok, critical* ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).