Start

Getting started with Carbonaut

⚠️

Docs for this page are under construction.

Welcome to Carbonaut! Carbonaut is cloud-native monitoring software for collecting environmental sustainability metrics from your IT infrastructure. This guide will show you how to install, configure, and monitor our first resource using Carbonaut. You will download, install, and run Carbonaut. You will also download and install an official Carbonaut plugin to collect energy metrics from your local machine.

Download Carbonaut

Download the latest release (opens in a new tab) of Carbonaut for your platform, then extract it.

tar xvfz carbonaut-*.tar.gz
cd carbonaut-*

The Carbonaut Connector is a single binary called carbonaut. We can run the binary and see help on its options by passing the --help flag.

./carbonaut --help
usage: carbonaut [<flags>]

Before starting Carbonaut, let's configure it.

Configure Carbonaut

An example configuration file is available in the examples folder example/carbonaut.yaml (opens in a new tab). Copy this file to a location of your choice, and edit it to suit your needs. Without edits this file will work fine for a local test and measure your machine's energy consumption.

Run Carbonaut as Container locally

With Carbonaut downloaded and configured, we can start it up. We'll run it in the foreground so we can see its logs.

carbonaut -c=carbonaut.yaml --debug

more info tbd

Caronaut is running and measures energy consumption through the Scaphandre plugin 🎉.

Carbonaut excels on a larger scale by integrating different types of plugins, automatically blending data from multiple sources, and integrating all of this into a common data format while extending the existing monitoring stack.