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 forDocker containers and should support just about any other container type out of the box. We strive for support accross the board so feel free to open an issue if that is not the case. cAdvisor's container abstraction is based onlmctfy's so containers are inherently nested hierarchically.
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. 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 / google/cadvisor: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, RHEL, or are using LXC take a look at ourrunning instructions.
We have detailedinstructions on running cAdvisor standalone outside of Docker. cAdvisorrunning options may also be interesting for advanced usecases. If you want to build your own cAdvisor Docker image see ourdeployment page.
Building and Testing
See the more detailed instructions in thebuild page. This includes instructions for building and deploying the cAdvisor Docker image.
InfluxDB and Cluster Monitoring
cAdvisor supports exporting stats to InfluxDB . See thedocumentation for more information and examples.
Heapster enables cluster wide monitoring of containers using cAdvisor.
cAdvisor exposes a web UI at its port:
http://<hostname>:<port>/
See thedocumentation for more details.
Remote REST API & Clients
cAdvisor exposes its raw and processed stats via a versioned remote REST API. See the API'sdocumentation for more information.
There is also an official Go client implementation in theclient directory. See thedocumentation for more information.
Roadmap
cAdvisor aims to improve the resource usage and performance characteristics of running containers. Today, we gather and expose this information to users. In our roadmap:
- Advise on the performance of a container (e.g.: when it is being negatively affected by another, when it is not receiving the resources it requires, etc)
- Auto-tune the performance of the container based on previous advise.
- Provide usage prediction to cluster schedulers and orchestration layers.