Analyzes resource usage and performance characteristics of running containers.
Go JavaScript Other
Latest commit fc0bd7a Jun 18, 2018
Permalink
Failed to load latest commit information.
Godeps vendor: update docker import Jun 14, 2018
accelerators Initialize NVML on demand. Jun 18, 2018
api Add an API to get FsStats from filesystem UUID Aug 23, 2017
build cadvisor: build: fix broken build with Makefile Feb 5, 2018
cache reduce labels for container info Jan 11, 2018
client new client with http timeout Apr 14, 2017
collector update testify dependency Nov 18, 2017
container container: fix concurrent map acccess Jun 13, 2018
deploy Update Dockerfile and dependencies May 29, 2018
devicemapper update runc godep Aug 25, 2017
docs Update docs - go 1.7 needed for building Apr 14, 2018
events Don't create a EventStore if the event limit is set to 0 Apr 25, 2016
fs vendor: update docker import Jun 14, 2018
healthz Fix imported package names to not use mixedCaps or under_scores Oct 22, 2015
http Clean up cAdvisor logging Nov 28, 2017
info Adding /proc/<pid>/schedstat (#1872) Mar 8, 2018
integration migrate to prow, which uses node-e2e to run tests Feb 1, 2018
machine use more robust docker os-release parser Apr 20, 2018
manager dont watch .mount cgroups Jun 14, 2018
metrics Adding /proc/<pid>/schedstat (#1872) Mar 8, 2018
pages Merge pull request #1845 from dashpole/fix_ui Jan 2, 2018
storage Enable kafka logs Apr 17, 2018
summary Export type to calculate percentiles Jul 22, 2015
utils Revert "Switch from Inotify to Fsnotify" Jun 11, 2018
validate add check for cpu cfs bandwidth in validate endpoint Mar 23, 2018
vendor vendor: update docker import Jun 14, 2018
version Simplify cAdvisor release versioning Jun 30, 2016
zfs Add watcher for zfs similar to devicemapper Mar 15, 2017
.gitignore Gitignore Files generated by JetBrains IDEs Mar 18, 2017
AUTHORS Remove mention of contributors file. We don't have one. Dec 30, 2014
CHANGELOG.md changelog for v0.30.1 Jun 11, 2018
CONTRIBUTING.md Add CONTRIBUTING.md Jun 10, 2014
LICENSE Migrating cAdvisor code from lmctfy Jun 9, 2014
Makefile migrate to prow, which uses node-e2e to run tests Feb 1, 2018
README.md Minor cleanup. Sep 27, 2017
cadvisor.go Adding /proc/<pid>/schedstat (#1872) Mar 8, 2018
cadvisor_test.go Add udp and udp6 network statistics Apr 10, 2017
logo.png Run PNG crusher on logo.png Feb 10, 2016
storagedriver.go Clean up cAdvisor logging Nov 28, 2017
test.htdigest Added HTTP Auth and HTTP Digest authentication #302 Dec 11, 2014
test.htpasswd Added HTTP Auth and HTTP Digest authentication #302 Dec 11, 2014

README.md

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 \
  --volume=/dev/disk/:/dev/disk: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, 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.

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.

Community

Contributions, questions, and comments are all welcomed and encouraged! cAdvisor developers hang out on Slack in the #sig-node channel (get an invitation here). We also have the kubernetes-users Google Groups mailing list.