---
title: Scaphandre
description: Monitoring agent that measures power usage of bare metal machines
breadcrumbs: Docs > Integrations > Scaphandre
---

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

This check monitors [Scaphandre](https://github.com/hubblo-org/scaphandre), a monitoring agent that uses RAPL and MsrRAPL through powercap to measure power usage of bare metal machines. The goal of the project is to permit to any company or individual to measure the power consumption of its tech services and get this data in a convenient form, sending it through any monitoring or data analysis toolchain.

## Setup{% #setup %}

### Installation{% #installation %}

To install the Scaphandre check on your host:

1. Install the [developer toolkit](https://docs.datadoghq.com/developers/integrations/python/) on any machine. The specific developer toolkit that you need to install depends on your platform and architecture.

1. Run the following command to build the package:

   ```
   ddev release build scaphandre
   ```

1. [Download the Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest).

1. Upload the build artifact to any host with an Agent and run the following command:

   ```
   datadog-agent integration install -w path/to/scaphandre/dist/<ARTIFACT_NAME>.whl
   ```

### Configuration{% #configuration %}

Edit the `scaphandre.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/#agent-configuration-directory). See the [sample scaphandre.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/scaphandre/datadog_checks/scaphandre/data/conf.yaml.example) for all available configuration options. For example, to secure Scaphandre command line tags and prevent sensitive data from being pulled into Datadog, use the `exclude_labels` config option.

[Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent) to start sending Scaphandre metrics to Datadog.

### Validation{% #validation %}

Run the [Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information) and look for `scaphandre` in the **Checks** section.

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

### Metrics{% #metrics %}

|  |
|  |
| **scaphandre.host.cpu.frequency**(gauge)         | Global frequency of all the cpus on the host*Shown as megahertz* |
| **scaphandre.host.disk.available**(gauge)        | Available disk space on the host*Shown as byte*                  |
| **scaphandre.host.disk.total**(gauge)            | Total disk space on the host*Shown as byte*                      |
| **scaphandre.host.energy.count**(count)          | Energy count on the host                                         |
| **scaphandre.host.load.avg.15**(gauge)           | 15-minute average system load on the host*Shown as percent*      |
| **scaphandre.host.load.avg.1**(gauge)            | 1-minute average system load on the host*Shown as percent*       |
| **scaphandre.host.load.avg.5**(gauge)            | 5-minute average system load on the host*Shown as percent*       |
| **scaphandre.host.memory.available**(gauge)      | Available memory on the host*Shown as byte*                      |
| **scaphandre.host.memory.free**(gauge)           | Free memory on the host*Shown as byte*                           |
| **scaphandre.host.memory.total**(gauge)          | Total memory on the host*Shown as byte*                          |
| **scaphandre.host.power**(gauge)                 | Power consumption of the host*Shown as watt*                     |
| **scaphandre.host.swap.free**(gauge)             | Free swap space on the host*Shown as byte*                       |
| **scaphandre.host.swap.total**(gauge)            | Total swap space on the host*Shown as byte*                      |
| **scaphandre.process.cpu\_usage.pct**(gauge)     | CPU usage percentage of the process*Shown as percent*            |
| **scaphandre.process.disk.read**(gauge)          | Disk read for the process*Shown as byte*                         |
| **scaphandre.process.disk.total\_read**(gauge)   | Total disk read for the process*Shown as byte*                   |
| **scaphandre.process.disk.total\_write**(gauge)  | Total disk write for the process*Shown as byte*                  |
| **scaphandre.process.disk.write**(gauge)         | Disk write for the process*Shown as byte*                        |
| **scaphandre.process.memory.virtual**(gauge)     | Virtual memory used by the process*Shown as byte*                |
| **scaphandre.process.memory**(gauge)             | Memory used by the process*Shown as byte*                        |
| **scaphandre.process.power\_consumption**(gauge) | Power consumption of the process*Shown as watt*                  |
| **scaphandre.self.memory.virtual**(gauge)        | Virtual memory used by scaphandre itself*Shown as byte*          |
| **scaphandre.self.memory**(gauge)                | Memory used by scaphandre itself*Shown as byte*                  |
| **scaphandre.self.socket\_records**(gauge)       | Socket records collected by scaphandre                           |
| **scaphandre.self.socket\_stats**(gauge)         | Socket statistics collected by scaphandre                        |
| **scaphandre.self.topo\_procs**(gauge)           | Topology processes recorded by scaphandre                        |
| **scaphandre.self.topo\_records**(gauge)         | Topology records collected by scaphandre                         |
| **scaphandre.self.topo\_stats**(gauge)           | Topology statistics collected by scaphandre                      |
| **scaphandre.version**(gauge)                    | Current version number of scaphandre                             |

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

**scaphandre.openmetrics.health**

Returns `CRITICAL` if the Agent is unable to connect to the Scaphandre OpenMetrics endpoint, otherwise returns `OK`.

*Statuses: ok, critical*

### Events{% #events %}

Scaphandre does not include any events.

## Troubleshooting{% #troubleshooting %}

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