Scaphandre

Supported OS Linux Windows Mac OS

Integration version1.0.0

Overview

This check monitors 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

Installation

To install the Scaphandre check on your host:

Install the developer toolkit on any machine. The specific developer toolkit that you need to install depends on your platform and architecture.
Run the following command to build the package:
```
ddev release build scaphandre
```
Download the Datadog Agent.

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

Edit the scaphandre.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample scaphandre.d/conf.yaml 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 to start sending Scaphandre metrics to Datadog.

Validation

Run the Agent’s status subcommand and look for scaphandre in the Checks section.

Data Collected

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

Scaphandre does not include any service checks.

Events

Scaphandre does not include any events.

Troubleshooting

Need help? Contact Datadog support.