cadvisor README

The project's README from github.com/google/cadvisor. As one markdown file: README.md.

cAdvisor

test status

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.

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:

VERSION=0.55.1 # use the latest release version from https://github.com/google/cadvisor/releases
sudo docker run \
  --volume=/:/rootfs:ro \
  --volume=/var/run:/var/run:ro \
  --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 \
  --privileged \
  --device=/dev/kmsg \
  ghcr.io/google/cadvisor:$VERSION # for versions prior to v0.53.0, use gcr.io/cadvisor/cadvisor instead

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, or 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.

For Kubernetes users, cAdvisor can be run as a daemonset. See the instructions for how to get started, and for how to kustomize it to fit your needs.

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:

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 discuss.kubernetes.io.

Please reach out and get involved in the project, we're actively looking for more contributors to bring on board!

Core Team

Frequent Collaborators

Emeritus

cadvisor (google/cadvisor)

Searching Database…

19.5K ·GitHub
Cadvisor
What is this?cAdvisor (Container Advisor) is a daemon that collects, aggregates and exports resource usage and performance data for running containers, such as CPU, memory, network and historical usage statistics.
Is this a standalone agent or does it need something else to work?It's a standalone daemon that runs per-machine, exposing a web UI and a versioned REST API; it has native Docker support and can also run on a machine without Docker.
How do I get it running?The quickest way is running the official cAdvisor Docker image, which includes everything needed to monitor the whole machine; it can also run standalone outside Docker, or as a Kubernetes DaemonSet.
Do I need Docker to use it?No, Docker is the easiest path but not required; cAdvisor has native Docker support but should work with just about any other container type, and has separate instructions for CentOS/Fedora/RHEL/LXC and for standalone runs.
Any install pitfalls I should know about?If you're on CentOS, Fedora, RHEL, or using LXC, you need to follow special running instructions instead of the default Docker quick start.
Does it run on Kubernetes clusters too?Yes, cAdvisor can be deployed as a Kubernetes DaemonSet, with Kustomize support to adapt it to your cluster's needs.
Can I export the stats to external storage systems?Yes, cAdvisor supports exporting stats to various storage plugins, with documentation and examples for the different backends.
Is there an API I can use to pull container stats programmatically?Yes, cAdvisor exposes a versioned remote REST API for raw and processed stats, and provides an official Go client implementation.
What does the project actually track per container?For each container it keeps resource isolation parameters, historical resource usage with histograms, and network statistics, exported both per-container and machine-wide.
Does cAdvisor do anything beyond just showing stats?Currently it only gathers and exposes usage data, but the roadmap includes performance advising, auto-tuning containers, and usage prediction for cluster schedulers.
What are similar projects?glances, beszel, node_exporter, k9s, telegraf, lazydocker, prometheus, sampler
Which topics is it in?metrics, containers, sysadmin, observability, kubernetes, dashboard, monitoring, rest-api, devops, performance, go, api
Creator
google
Size
52.1 MB
Stars
19.5K
Updated
CommitOct 12Releasev0.60.6Sep 18
Age
12y
Commits · 90 Days