/cadvisor

Analyzes resource usage and performance characteristics of running containers.

Primary LanguageGoOtherNOASSERTION

This is a Fork!

The original can be found here. This fork is for arm support

Build the image yourself from scratch

Fist of all, you need to have Go installed (version 1.6). Then simply run go get -d github.com/Brain-Gamer/cadvisor to download this repo. Find the downloaded files on your system and navigate to them. To build cAdvisor and the docker image you only need to run deploy/build.sh. It will compile cAdvisor and build the docker image automatically (the image is named cadvisor:latest). The dockerfile is also in this directory. If you want to do it step by step you can run make build to build cAdvisor and make docker to build the docker image.

What was changed?

To fix the building for arm, I added GOARCH=arm to the build command here. This fixed the compiling of cAdvisor for arm (now only for arm). Next I needed to edit the dockerfile to run on arm devices. It uses the armhf version of alpine linux and some other packages because some of them are not available for arm. Also the glibc wasn't compiled for arm so I searched for a source with glibc for arm. Everything else isn't modified.

cAdvisor

cAdvisor (Container Advisor) provides container users an understanding of the resource usage and performance characteristics of their running containers. It is a running daemon that collects, aggregates, processes, and exports information about running containers. Specifically, for each container it keeps resource isolation parameters, historical resource usage, histograms of complete historical resource usage and network statistics. This data is exported by container and machine-wide.

cAdvisor has native support for Docker containers and should support just about any other container type out of the box. We strive for support across the board so feel free to open an issue if that is not the case. cAdvisor's container abstraction is based on lmctfy's so containers are inherently nested hierarchically.

cAdvisor

Quick Start: Running cAdvisor in a Docker Container

To quickly tryout cAdvisor on your machine with Docker, we have a Docker image that includes everything you need to get started. You can run a single cAdvisor to monitor the whole machine. Simply run:

sudo docker run \
  --volume=/:/rootfs:ro \
  --volume=/var/run:/var/run:rw \
  --volume=/sys:/sys:ro \
  --volume=/var/lib/docker/:/var/lib/docker:ro \
  --publish=8080:8080 \
  --detach=true \
  --name=cadvisor \
  braingamer/cadvisor-arm:latest

cAdvisor is now running (in the background) on http://localhost:8080. The setup includes directories with Docker state cAdvisor needs to observe.

Note: If you're running on CentOS, Fedora, RHEL, or are using LXC take a look at our running instructions.

We have detailed instructions on running cAdvisor standalone outside of Docker. cAdvisor running options may also be interesting for advanced usecases. If you want to build your own cAdvisor Docker image see our deployment page.

Building and Testing

See the more detailed instructions in the build page. This includes instructions for building and deploying the cAdvisor Docker image.

Exporting stats

cAdvisor supports exporting stats to various storage plugins. See the documentation for more details and examples.

Web UI

cAdvisor exposes a web UI at its port:

http://<hostname>:<port>/

See the documentation for more details.

Remote REST API & Clients

cAdvisor exposes its raw and processed stats via a versioned remote REST API. See the API's documentation for more information.

There is also an official Go client implementation in the client directory. See the documentation for more information.