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
Что это такое?cAdvisor (Container Advisor) — это демон, который собирает, агрегирует и экспортирует данные об использовании ресурсов и производительности запущенных контейнеров, например процессора, памяти, сети и статистику использования за прошлое время.
Это самостоятельный агент или ему нужно что-то ещё для работы?Это самостоятельный демон, который работает на каждой машине и предоставляет веб-интерфейс и versioned REST API; у него есть нативная поддержка Docker, но он может работать и на машине без Docker.
Как его запустить?Самый быстрый способ — запустить официальный Docker-образ cAdvisor, в котором есть всё необходимое для мониторинга всей машины; также его можно запустить самостоятельно вне Docker или как DaemonSet в Kubernetes.
Нужен ли мне Docker, чтобы им пользоваться?Нет, Docker — самый простой путь, но не обязательный; у cAdvisor есть нативная поддержка Docker, но он должен работать почти с любым другим типом контейнеров, а для CentOS/Fedora/RHEL/LXC и для запуска вне Docker есть отдельные инструкции.
Есть ли подводные камни при установке, о которых стоит знать?Если вы используете CentOS, Fedora, RHEL или LXC, нужно следовать специальным инструкциям по запуску вместо стандартного быстрого старта с Docker.
Работает ли он и на кластерах Kubernetes?Да, cAdvisor можно развернуть как DaemonSet в Kubernetes, а с поддержкой Kustomize его можно адаптировать под потребности вашего кластера.
Можно ли экспортировать статистику во внешние системы хранения?Да, cAdvisor поддерживает экспорт статистики через различные плагины хранения, для разных бэкендов есть документация и примеры.
Есть ли API, с помощью которого можно программно получать статистику контейнеров?Да, cAdvisor предоставляет versioned удалённый REST API для сырой и обработанной статистики, а также официальную реализацию клиента на Go.
Что проект на самом деле отслеживает для каждого контейнера?Для каждого контейнера он хранит параметры изоляции ресурсов, историческое использование ресурсов с гистограммами и сетевую статистику, которые экспортируются как для отдельного контейнера, так и для всей машины.
Делает ли cAdvisor что-то помимо показа статистики?Сейчас он только собирает и показывает данные об использовании, но в дорожной карте есть советы по производительности, автонастройка контейнеров и прогнозирование использования для планировщиков кластера.
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