Ключи запуска

Параметры, с которыми может быть запущен cadvisor_exporter.

-add_dir_header: Если значение этого параметра равно true, в заголовки сообщений лога добавляется название директории.

-allow_dynamic_housekeeping: Динамический интервал между проверками housekeeping.

Значение по умолчанию: true.

-alsologtostderr

Вывод сообщений об ошибках не только в файл, но и в стандартный поток stderr.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true.

-application_metrics_count_limit: Максимальное количество хранимых метрик приложений для каждого контейнера.

Значение по умолчанию: 100.

-audit.fileMaxAge: Продолжительность хранения файлов аудита в днях.

Значение по умолчанию: 7.

-audit.fileMaxSize: Максимальный размер одного файла аудита в МБ.

Значение по умолчанию: 100.

-audit.filePath

Путь к файлу аудита.

Пустое значение отключает аудит.

-boot_id_file: Список имён файлов для проверки boot-id. В качестве разделителя используется запятая. Значение boot-id берётся из первого найденного файла.

Значение по умолчанию: /proc/sys/kernel/random/boot_id.

-bq_account: Адрес электронной почты сервисной учётной записи.

-bq_credentials_file: Путь к PEM-файлу с учётными данными.

-bq_id: Идентификатор клиента.

-bq_project_id: Идентификатор проекта в контексте Docker.

-bq_secret: Секрет клиента.

Значение по умолчанию: notasecret.

-collector_cert: Сертификат коллектора, доступный конечным точкам при аутентификации с использованием сертификатов.

-collector_key: Ключ сертификата коллектора.

-container_hints: Путь к hints-файлу контейнеров.

Значение по умолчанию: /etc/cadvisor/container_hints.json.

-containerd: Точка доступа к containerd.

Значение по умолчанию: /run/containerd/containerd.sock.

-containerd-namespace: Пространство имён containerd.

Значение по умолчанию: k8s.io.

-containerd_env_metadata_whitelist

Это устаревший ключ, который будет удалён в одном из следующих обновлений. Вместо него используйте env_metadata_whitelist.

Список разделённых запятыми имён переменных окружения, соответствующих указанному префиксу, значения которых необходимо собрать для контейнеров containerd.

-crio_client_timeout: Время ожидания клиента CRI-O.

По умолчанию время ожидания не ограничено.

-disable_metrics

Список разделённых запятыми названий метрик, которые не нужно собирать.

Возможные значения:

advtcp;
app;
cpu;
cpuLoad;
cpu_topology;
cpuset;
disk;
diskIO;
hugetlb;
memory;
memory_numa;
network;
oom_event;
percpu;
perf_event;
pressure;
process;
referenced_memory;
resctrl;
sched;
tcp;
udp.

Значение по умолчанию:

advtcp,cpu_topology,cpuset,hugetlb,memory_numa,process,referenced_memory,resctrl,sched,tcp,udp

-disable_root_cgroup_stats: Отключение сбора статистики root cgroup.

-docker: Точка доступа к Docker.

Значение по умолчанию: unix:///var/run/docker.sock.

-docker-tls: Использование TLS при подключении к Docker.

-docker-tls-ca: Путь к корневому сертификату, используемому при подключении к Docker.

Значение по умолчанию: ca.pem.

-docker-tls-cert: Путь к клиентскому сертификату, используемому при подключении к Docker.

Значение по умолчанию: cert.pem.

-docker-tls-key: Путь к приватному ключу TLS, используемому при подключении к Docker.

Значение по умолчанию: key.pem.

-docker_env_metadata_whitelist

Список разделённых запятыми имён переменных окружения, соответствующих указанному префиксу, значения которых необходимо собрать для контейнеров Docker.

-docker_only: Сбор метрик только контейнеров Docker в дополнение к статистике root.

-docker_root

Значение этого ключа читается из информации, которую выдаёт о себе сам Docker.

Путь к корневой директории Docker.

Значение по умолчанию: /var/lib/docker.

-enable_load_reader: Сбор метрик утилизации CPU.

-enable_metrics

Список разделённых запятыми названий метрик, сбор которых разрешён.

Если значение ключа задано, оно переопределяет значение ключа disable_metrics.

Возможные значения:

advtcp;
app;
cpuLoad;
cpu_topology;
cpu;
cpuset;
diskIO;
disk;
hugetlb;
memory_numa;
memory;
network;
oom_event;
percpu;
perf_event;
pressure;
process;
referenced_memory;
resctrl;
sched;
tcp;
udp.

-env_metadata_whitelist: Список разделённых запятыми имён переменных окружения, соответствующих указанному префиксу, значения которых необходимо собрать для контейнеров containerd и Docker.

-event_storage_age_limit

Максимальная продолжительность хранения данных о событиях каждого типа.

Значением ключа должны быть разделённые запятыми пары следующего вида:

<event>=<duration>

Здесь:

<event> — название события, например, creation, oom;
<duration> — срок хранения, например, 24h (24 часа).

Особое событие default задаёт время хранения данных о событиях, не указанных в списке.

По умолчанию данные о каждом событии хранятся 24 часа.

Пусть данные о событиях commit хранятся 18 часов, о restart — 3 суток, а обо всех остальных — 7 суток. Тогда значение ключа будет иметь следующий вид:

-event_storage_age_limit commit=18h,restart=3d,default=7d

-event_storage_event_limit

Максимальное количество хранимых событий каждого типа.

Значением ключа должны быть разделённые запятыми пары следующего вида:

<event>=<duration>

Здесь:

<event> — название события, например, creation, oom;
<duration> — срок хранения, например, 24h (24 часа).

Особое событие default задаёт ограничение на количество хранимых событий, не указанных в списке.

По умолчанию хранится 100 000 записей о событиях каждого типа.

Пусть о событиях commit хранится 5 000 записей, о restart — 10 000, а обо всех остальных — 7 500. Тогда значение ключа будет иметь следующий вид:

-event_storage_event_limit commit=5000,restart=10000,default=7500

-global_housekeeping_interval: Общая периодичность запуска housekeeping.

Значение по умолчанию: 1m0s (1 минута).

-housekeeping_interval: Периодичность запуска housekeeping для контейнеров.

Значение по умолчанию: 1s (1 секунда).

-log_backtrace_at: Если количество строк в журнале достигает указанного значения, запускается трассировка стека.

-log_cadvisor_usage: Журналирование работы самого cAdvisor.

-log_dir

Путь к директории для записи журнала.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true.

-log_file

Путь к файлу для записи журнала.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true.

-log_file_max_size

Ограничение на размер файла журнала в Мб.

При значении 0 размер файла журнала не ограничивается.

Значение по умолчанию: 1800.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true.

-logtostderr: Вывод журнала в стандартный поток ошибок stderr, а не в файл.

Значение по умолчанию: true.

-machine_id_file: Разделённые запятыми имена файлов для проверки machine-id. Используется значение из первого найденного файла.

Значение по умолчанию: /etc/machine-id,/var/lib/dbus/machine-id.

-max_housekeeping_interval: Наибольшее значение длительности периода между запуском housekeeping для контейнеров.

Значение по умолчанию: 1m0s (1 минута).

-max_procs: Ограничение на количество одновременно используемых CPU.

Значение по умолчанию: количество ядер.

-one_output

Запись журналов в соответствии с уровнями их важности:

true — события каждого уровня важности записываются только на своём уровне;
false — все события записываются на своём и более низких уровнях важности.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true.

-perf_events_config: Путь к JSON-файлу с конфигурацией сбора метрик событий производительности.

Пустое значение отключает снятие метрик событий производительности.

-podman: Точка доступа к Podman.

Значение по умолчанию: unix:///var/run/podman/podman.sock.

-raw_cgroup_prefix_whitelist: Список разделённых запятыми префиксов путей cgroup, которые должны быть собраны, если используется ключ -docker_only.

-referenced_reset_interval: Количество циклов сбора метрики container_referenced_bytes, после которого значение метрики очищается.

При значении 0 значение метрики никогда не очищается.

Значение по умолчанию: 0.

-resctrl_interval: Период обновления MON-групп.

Значение 0 отключает обновление MON-групп.

Подробности о MON-группах см. в документации ядра Linux.

-skip_headers: При значении true префиксы заголовка не выводятся в сообщениях журнала.

-skip_log_headers

При значении true заголовки не выводятся при открытии файлов журнала.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true.

-stderrthreshold

Если настроен вывод журналов в файлы и stderr, в stderr выводятся сообщения с порогом не ниже указанного.

Значение по умолчанию: 2.

Этот ключ не имеет эффекта, если ключу -logtostderr присвоено значение true или ключу -alsologtostderr присвоено значение true.

-storage_driver

Используемый драйвер хранилища. Данные всегда кешируются в оперативной памяти, а этот ключ управляет их передачей из локального кеша.

Значением ключа может быть одно значение или несколько. Если значений несколько, в качестве разделителя используйте запятую.

Возможные значения:

пустая строка (хранилище не используется);
bigquery;
elasticsearch;
influxdb;
kafka;
redis;
statsd;
stdout.

-storage_driver_buffer_duration: Длительность периода хранения данных в буфере, после чего они передаются драйверу хранилища. Для бэкендов, не связанных с оперативной памятью, запись выполняется как одна транзакция.

Значение по умолчанию: 1m0s (1 минута).

-storage_driver_db: Название БД хранилища.

Значение по умолчанию: cadvisor.

-storage_driver_es_enable_sniffer: Использование сниффера для поиска узлов кластера ElasticSearch.

-storage_driver_es_host

Адрес сервера ElasticSearch в формате host:port.

Значение по умолчанию:

http://localhost:9200

-storage_driver_es_index: Название индекса ElasticSearch.

Значение по умолчанию: cadvisor.

-storage_driver_es_type: Название типа ElasticSearch.

Значение по умолчанию: stats.

-storage_driver_host: Адрес узла хранилища в формате host:port.

Значение по умолчанию: localhost:8086.

-storage_driver_influxdb_retention_policy: Политика удержания для InfluxDB.

-storage_driver_kafka_broker_list: Список брокеров Kafka.

Значение по умолчанию: localhost:9092.

-storage_driver_kafka_ssl_ca: Необязательный путь к файлу клиентского корневого сертификата для TLS-аутентификации в Kafka.

-storage_driver_kafka_ssl_cert: Необязательный путь к файлу клиентского сертификата для TLS-аутентификации в Kafka.

-storage_driver_kafka_ssl_key: Необязательный путь к файлу приватного ключа для TLS-аутентификации в Kafka.

-storage_driver_kafka_ssl_verify: Проверка цепочки SSL-сертификатов при подключении к Kafka.

Значение по умолчанию: true (включена).

-storage_driver_kafka_topic: Название топика Kafka.

Значение по умолчанию: stats.

-storage_driver_password: Пароль для подключения к хранилищу.

Значение по умолчанию: root.

-storage_driver_secure: Безопасное подключение к БД.

-storage_driver_table: Название таблицы БД в хранилище.

Значение по умолчанию: stats.

-storage_driver_user: Имя пользователя для подключения к хранилищу.

Значение по умолчанию: root.

-storage_duration: Длительность периода хранения данных.

Значение по умолчанию: 2m0s (2 минуты).

-store_container_labels: Преобразование меток контейнеров и переменных окружения в метки метрик Prometheus для каждого контейнера.

Если значение ключа равно false, в метрики передаются только название контейнера, его первый псевдоним и название образа.

Значение по умолчанию: true.

-update_machine_info_interval: Периодичность обновления данных о машине.

Значение по умолчанию: 5m0s (5 минут).

-v: Уровень подробности журнала.

-version: Вывод версии cAdvisor.

-vmodule: Список разделённых запятыми настроек пофайловой фильтрации журналов. Значения задаются в виде пар <шаблон>=<значение>.

-web.config.file: Путь к файлу веб-конфигурации плагина.

-web.listen-address: Адрес для прослушивания входящих HTTP-запросов.

Значение по умолчанию: :8080 (порт 8080 на всех адресах).

-whitelisted_container_labels

Список разделённых запятыми меток контейнеров, которые преобразуются в метки метрик Prometheus для каждого контейнера.

Этот ключ не имеет эффекта, если ключу -store_container_labels присвоено значение true.