---
title: UPSC
description: UPSC stats collector for UPS batteries
breadcrumbs: Docs > Integrations > UPSC
---

# UPSC
Supported OS Integration version1.0.1
## Overview{% #overview %}

Get metrics from UPSD service through UPSC in real time to:

- Visualize and monitor UPS battery health and states
- Be notified about UPS failovers and events.

## Setup{% #setup %}

The UPSC 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 UPSC 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
   datadog-agent integration install -t datadog-upsc==<INTEGRATION_VERSION>
   ```

1. Configure your integration similar to core [integrations](https://docs.datadoghq.com/getting_started/integrations.md).

### Configuration{% #configuration %}

1. Edit the `upsc.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory) to start collecting your UPSC metrics. See the [sample upsc.d/conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/upsc/datadog_checks/upsc/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#service-status) and look for `upsc` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **upsc.status**(gauge)                  | UPS status                                                                      |
| **upsc.battery.charge**(gauge)          | UPS battery charge*Shown as percent*                                            |
| **upsc.battery.charge.low**(gauge)      | UPS remaining battery level when UPS switches to Low Battery*Shown as percent*  |
| **upsc.battery.charge.warning**(gauge)  | UPS battery level when UPS switches to Warning state*Shown as percent*          |
| **upsc.battery.runtime**(gauge)         | UPS battery runtime*Shown as second*                                            |
| **upsc.battery.runtime.low**(gauge)     | UPS remaining battery runtime when UPS switches to Low Battery*Shown as second* |
| **upsc.battery.voltage**(gauge)         | UPS Battery Voltage*Shown as volt*                                              |
| **upsc.battery.voltage.nominal**(gauge) | UPS Nominal battery voltage*Shown as volt*                                      |
| **upsc.input.voltage**(gauge)           | UPS input voltage*Shown as volt*                                                |
| **upsc.input.voltage.nominal**(gauge)   | UPS nominal input voltage*Shown as volt*                                        |
| **upsc.output.voltage**(gauge)          | UPS output voltage*Shown as volt*                                               |
| **upsc.load**(gauge)                    | UPS load*Shown as percent*                                                      |

### Events{% #events %}

The UPSC check does not include any events.

### Service Checks{% #service-checks %}

The UPSC check does not include any service checks.

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](http://docs.datadoghq.com/help).
