--- name: "cadvisor" section: "1" platform: "linux" package: "cadvisor" version: "0.38.7+ds1-2+b7" release: "Debian 11 (Bullseye)" platforms: ["linux"] url: "https://carta.tech/man/cadvisor" --- # cadvisor(1) manual page for cAdvisor version 0.38.7+ds1 (0.38.7+ds1-1) ## NAME cAdvisor - manual page for cAdvisor version 0.38.7+ds1 (0.38.7+ds1-1) ## DESCRIPTION ### Usage of /usr/bin/cadvisor: - **-add\_dir\_header** If true, adds the file directory to the header of the log messages - **-allow\_dynamic\_housekeeping** Whether to allow the housekeeping interval to be dynamic (default true) - **-alsologtostderr** log to standard error as well as files - **-application\_metrics\_count\_limit** int Max number of application metrics to store (per container) (default 100) - **-boot\_id\_file** string Comma-separated list of files to check for boot-id. Use the first one that exists. (default "/proc/sys/kernel/random/boot\_id") - **-bq\_account** string Service account email - **-bq\_credentials\_file** string Credential Key file (pem) - **-bq\_id** string Client ID - **-bq\_project\_id** string Bigquery project ID - **-bq\_secret** string Client Secret (default "notasecret") - **-collector\_cert** string Collector's certificate, exposed to endpoints for certificate based authentication. - **-collector\_key** string Key for the collector's certificate - **-container\_hints** string location of the container hints file (default "/etc/cadvisor/container\_hints.json") - **-containerd** string containerd endpoint (default "/run/containerd/containerd.sock") - **-containerd-namespace** string containerd namespace (default "k8s.io") - **-disable\_metrics** metrics comma-separated list of metrics to be disabled. Options are 'accelerator', 'cpu\_topology','disk', 'diskIO', 'memory\_numa', 'network', 'tcp', 'udp', 'percpu', 'sched', 'process', 'hugetlb', 'referenced\_memory', 'resctrl'. (default memory\_numa,sched,hugetlb,referenced\_memory,cpu\_topology,resctrl,tcp,udp,advtcp,process) - **-disable\_root\_cgroup\_stats** Disable collecting root Cgroup stats - **-docker** string docker endpoint (default "unix:///var/run/docker.sock") - **-docker-tls** use TLS to connect to docker - **-docker-tls-ca** string path to trusted CA (default "ca.pem") - **-docker-tls-cert** string path to client certificate (default "cert.pem") - **-docker-tls-key** string path to private key (default "key.pem") - **-docker\_env\_metadata\_whitelist** string a comma-separated list of environment variable keys matched with specified prefix that needs to be collected for docker containers - **-docker\_only** Only report docker containers in addition to root stats - **-docker\_root** string DEPRECATED: docker root is read from docker info (this is a fallback, default: */var/lib/docker*) (default "/var/lib/docker") - **-enable\_load\_reader** Whether to enable cpu load reader - **-event\_storage\_age\_limit** string Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types (default "default=24h") - **-event\_storage\_event\_limit** string Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types (default "default=100000") - **-global\_housekeeping\_interval** duration Interval between global housekeepings (default 1m0s) - **-housekeeping\_interval** duration Interval between container housekeepings (default 1s) - **-http\_auth\_file** string HTTP auth file for the web UI - **-http\_auth\_realm** string HTTP auth realm for the web UI (default "localhost") - **-http\_digest\_file** string HTTP digest file for the web UI - **-http\_digest\_realm** string HTTP digest file for the web UI (default "localhost") - **-listen\_ip** string IP to listen on, defaults to all IPs - **-log\_backtrace\_at** value when logging hits line file:N, emit a stack trace - **-log\_cadvisor\_usage** Whether to log the usage of the cAdvisor container - **-log\_dir** string If non-empty, write log files in this directory - **-log\_file** string If non-empty, use this log file - **-log\_file\_max\_size** uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) - **-logtostderr** log to standard error instead of files (default true) - **-machine\_id\_file** string Comma-separated list of files to check for machine-id. Use the first one that exists. (default "/etc/machine-id,/var/lib/dbus/machine-id") - **-max\_housekeeping\_interval** duration Largest interval to allow between container housekeepings (default 1m0s) - **-max\_procs** int max number of CPUs that can be used simultaneously. Less than 1 for default (number of cores). - **-mesos\_agent** string Mesos agent address (default "127.0.0.1:5051") - **-mesos\_agent\_timeout** duration Mesos agent timeout (default 10s) - **-perf\_events\_config** string Path to a JSON file containing configuration of perf events to measure. Empty value disabled perf events measuring. - **-port** int port to listen (default 8080) - **-profiling** Enable profiling via web interface host:port/debug/pprof/ - **-prometheus\_endpoint** string Endpoint to expose Prometheus metrics on (default "/metrics") - **-raw\_cgroup\_prefix\_whitelist** string A comma-separated list of cgroup path prefix that needs to be collected even when **-docker\_only** is specified - **-referenced\_reset\_interval** uint Reset interval for referenced bytes (container\_referenced\_bytes metric), number of measurement cycles after which referenced bytes are cleared, if set to 0 referenced bytes are never cleared (default: 0) - **-skip\_headers** If true, avoid header prefixes in the log messages - **-skip\_log\_headers** If true, avoid headers when opening log files - **-stderrthreshold** value logs at or above this threshold go to stderr (default 2) - **-storage\_driver** driver Storage driver to use. Data is always cached shortly in memory, this controls where data is pushed besides the local cache. Empty means none, multiple separated by commas. Options are: \, bigquery, elasticsearch, kafka, redis, statsd, stdout - **-storage\_driver\_buffer\_duration** duration Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction (default 1m0s) - **-storage\_driver\_db** string database name (default "cadvisor") - **-storage\_driver\_es\_enable\_sniffer** ElasticSearch uses a sniffing process to find all nodes of your cluster by default, automatically - **-storage\_driver\_es\_host** string ElasticSearch host:port (default "http://localhost:9200") - **-storage\_driver\_es\_index** string ElasticSearch index name (default "cadvisor") - **-storage\_driver\_es\_type** string ElasticSearch type name (default "stats") - **-storage\_driver\_host** string database host:port (default "localhost:8086") - **-storage\_driver\_kafka\_broker\_list** string kafka broker(s) csv (default "localhost:9092") - **-storage\_driver\_kafka\_ssl\_ca** string optional certificate authority file for TLS client authentication - **-storage\_driver\_kafka\_ssl\_cert** string optional certificate file for TLS client authentication - **-storage\_driver\_kafka\_ssl\_key** string optional key file for TLS client authentication - **-storage\_driver\_kafka\_ssl\_verify** verify ssl certificate chain (default true) - **-storage\_driver\_kafka\_topic** string kafka topic (default "stats") - **-storage\_driver\_password** string database password (default "root") - **-storage\_driver\_secure** use secure connection with database - **-storage\_driver\_table** string table name (default "stats") - **-storage\_driver\_user** string database username (default "root") - **-storage\_duration** duration How long to keep data stored (Default: 2min). (default 2m0s) - **-store\_container\_labels** convert container labels and environment variables into labels on prometheus metrics for each container. If flag set to false, then only metrics exported are container name, first alias, and image name (default true) - **-update\_machine\_info\_interval** duration Interval between machine info updates. (default 5m0s) - **-url\_base\_prefix** string prefix path that will be prepended to all paths to support some reverse proxies - **-v** value number for the log level verbosity - **-version** print cAdvisor version and exit - **-vmodule** value comma-separated list of pattern=N settings for file-filtered logging - **-whitelisted\_container\_labels** string comma separated list of container labels to be converted to labels on prometheus metrics for each container. store\_container\_labels must be set to false for this to take effect.