README

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=v0.36.0 # 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 \
  gcr.io/cadvisor/cadvisor:$VERSION

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:

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

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
This is an implementation of a cAdvisor REST API in Go.
This is an implementation of a cAdvisor REST API in Go.
v2
Client library to programmatically access cAdvisor API.
Client library to programmatically access cAdvisor API.
cmd module
Package container defines types for sub-container events and also defines an interface for container operation handlers.
Package container defines types for sub-container events and also defines an interface for container operation handlers.
common
Unmarshal's a Containers description json file.
Unmarshal's a Containers description json file.
containerd
This code has been taken from containerd repo to avoid large library import Handler for containerd containers.
This code has been taken from containerd repo to avoid large library import Handler for containerd containers.
containerd/install
The install package registers containerd.NewPlugin() as the "containerd" container provider when imported
The install package registers containerd.NewPlugin() as the "containerd" container provider when imported
crio
Handler for CRI-O containers.
Handler for CRI-O containers.
crio/install
The install package registers crio.NewPlugin() as the "crio" container provider when imported
The install package registers crio.NewPlugin() as the "crio" container provider when imported
docker
Provides global docker information.
Provides global docker information.
docker/install
The install package registers docker.NewPlugin() as the "docker" container provider when imported
The install package registers docker.NewPlugin() as the "docker" container provider when imported
raw
Handler for "raw" containers.
Handler for "raw" containers.
systemd/install
The install package registers systemd.NewPlugin() as the "systemd" container provider when imported
The install package registers systemd.NewPlugin() as the "systemd" container provider when imported
Provides Filesystem Stats
Provides Filesystem Stats
info
v1
Types used for docker containers.
Types used for docker containers.
v2
integration
The machine package contains functions that extract machine-level specs.
The machine package contains functions that extract machine-level specs.
Manager of cAdvisor-monitored containers.
Manager of cAdvisor-monitored containers.
Collector of perf events for a container.
Collector of perf events for a container.
Collector of resctrl for a container.
Collector of resctrl for a container.
Noop perf Manager and Collector.
Noop perf Manager and Collector.
Maintains the summary of aggregated minute, hour, and day stats.
Maintains the summary of aggregated minute, hour, and day stats.
Package container defines types for sub-container events and also defines an interface for container operation handlers.
Package container defines types for sub-container events and also defines an interface for container operation handlers.