OS Manuals

/usr/bin/cadvisor

Analyzes resource usage and performance characteristics of running containers.

From cadvisor-fips 0.60.6-r8 (enterprise-packages), captured 2026-11-09 by running cadvisor --help (exit 0). permalink

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 (no effect when -logtostderr=true)
  -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")
  -containerd_env_metadata_whitelist env_metadata_whitelist
    	DEPRECATED: this flag will be removed, please use env_metadata_whitelist. A comma-separated list of environment variable keys matched with specified prefix that needs to be collected for containerd containers
  -crio_client_timeout duration
    	CRI-O client timeout. Default is no timeout.
  -disable_metrics metrics
    	comma-separated list of metrics to be disabled. Options are 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. (default advtcp,cpu_topology,cpuset,hugetlb,memory_numa,process,referenced_memory,resctrl,sched,tcp,udp)
  -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 env_metadata_whitelist
    	DEPRECATED: this flag will be removed, please use env_metadata_whitelist. 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
  -enable_metrics metrics
    	comma-separated list of metrics to be enabled. If set, overrides 'disable_metrics'. Options are 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.
  -env_metadata_whitelist string
    	a comma-separated list of environment variable keys matched with specified prefix that needs to be collected for containers, only support containerd and docker runtime for now.
  -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")
  -initial_splay_factor float
    	Factor for the initial splay b/w the container housekeepings, default is 1.0. If negative value is passed, the value will be reset to default (default 1)
  -jitter_factor float
    	Factor for the jitters after the initial splay b/w the container housekeepings, default is 1.0. If negative value is passed, the value will be reset to default (default 1)
  -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 (no effect when -logtostderr=true)
  -log_file string
    	If non-empty, use this log file (no effect when -logtostderr=true)
  -log_file_max_size uint
    	Defines the maximum size a log file can grow to (no effect when -logtostderr=true). 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).
  -one_output
    	If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
  -perf_events_config string
    	Path to a JSON file containing configuration of perf events to measure. Empty value disabled perf events measuring.
  -podman string
    	podman endpoint (default "unix:///var/run/podman/podman.sock")
  -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)
  -resctrl_interval duration
    	Resctrl mon groups updating interval. Zero value disables updating mon groups.
  -skip_headers
    	If true, avoid header prefixes in the log messages
  -skip_log_headers
    	If true, avoid headers when opening log files (no effect when -logtostderr=true)
  -stderrthreshold value
    	logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (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: <empty>, bigquery, elasticsearch, influxdb, 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_influxdb_retention_policy string
    	retention policy
  -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.
Options (89)
OptionDescriptionSource
-add_dir_headerIf true, adds the file directory to the header of the log messageshelp
-allow_dynamic_housekeepingWhether to allow the housekeeping interval to be dynamic (default true)help
-alsologtostderrlog to standard error as well as files (no effect when -logtostderr=true)help
-application_metrics_count_limit intMax number of application metrics to store (per container) (default 100)help
-boot_id_file stringComma-separated list of files to check for boot-id.help
-bq_account stringService account emailhelp
-bq_credentials_file stringCredential Key file (pem)help
-bq_id stringClient IDhelp
-bq_project_id stringBigquery project IDhelp
-bq_secret stringClient Secret (default "notasecret")help
-collector_cert stringCollector's certificate, exposed to endpoints for certificate based authentication.help
-collector_key stringKey for the collector's certificatehelp
-container_hints stringlocation of the container hints file (default "/etc/cadvisor/container_hints.json")help
-containerd stringcontainerd endpoint (default "/run/containerd/containerd.sock")help
-containerd-namespace stringcontainerd namespace (default "k8s.io")help
-containerd_env_metadata_whitelist env_metadata_whitelistDEPRECATED: this flag will be removed, please use env_metadata_whitelist.help
-crio_client_timeout durationCRI-O client timeout.help
-disable_metrics metricscomma-separated list of metrics to be disabled.help
-disable_root_cgroup_statsDisable collecting root Cgroup statshelp
-docker stringdocker endpoint (default "unix:///var/run/docker.sock")help
-docker-tlsuse TLS to connect to dockerhelp
-docker-tls-ca stringpath to trusted CA (default "ca.pem")help
-docker-tls-cert stringpath to client certificate (default "cert.pem")help
-docker-tls-key stringpath to private key (default "key.pem")help
-docker_env_metadata_whitelist env_metadata_whitelistDEPRECATED: this flag will be removed, please use env_metadata_whitelist.help
-docker_onlyOnly report docker containers in addition to root statshelp
-docker_root stringDEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker) (default "/var/lib/docker")help
-enable_load_readerWhether to enable cpu load readerhelp
-enable_metrics metricscomma-separated list of metrics to be enabled.help
-env_metadata_whitelist stringa comma-separated list of environment variable keys matched with specified prefix that needs to be collected for containers, only support containerd and docker runtime for now.help
-event_storage_age_limit stringMax length of time for which to store events (per type).help
-event_storage_event_limit stringMax number of events to store (per type).help
-global_housekeeping_interval durationInterval between global housekeepings (default 1m0s)help
-housekeeping_interval durationInterval between container housekeepings (default 1s)help
-http_auth_file stringHTTP auth file for the web UIhelp
-http_auth_realm stringHTTP auth realm for the web UI (default "localhost")help
-http_digest_file stringHTTP digest file for the web UIhelp
-http_digest_realm stringHTTP digest file for the web UI (default "localhost")help
-initial_splay_factor floatFactor for the initial splay b/w the container housekeepings, default is 1.0.help
-jitter_factor floatFactor for the jitters after the initial splay b/w the container housekeepings, default is 1.0.help
-listen_ip stringIP to listen on, defaults to all IPshelp
-log_backtrace_at valuewhen logging hits line file:N, emit a stack tracehelp
-log_cadvisor_usageWhether to log the usage of the cAdvisor containerhelp
-log_dir stringIf non-empty, write log files in this directory (no effect when -logtostderr=true)help
-log_file stringIf non-empty, use this log file (no effect when -logtostderr=true)help
-log_file_max_size uintDefines the maximum size a log file can grow to (no effect when -logtostderr=true).help
-logtostderrlog to standard error instead of files (default true)help
-machine_id_file stringComma-separated list of files to check for machine-id.help
-max_housekeeping_interval durationLargest interval to allow between container housekeepings (default 1m0s)help
-max_procs intmax number of CPUs that can be used simultaneously.help
-one_outputIf true, only write logs to their native severity level (vs also writing to each lower severity level;help
-perf_events_config stringPath to a JSON file containing configuration of perf events to measure.help
-podman stringpodman endpoint (default "unix:///var/run/podman/podman.sock")help
-port intport to listen (default 8080)help
-profilingEnable profiling via web interface host:port/debug/pprof/help
-prometheus_endpoint stringEndpoint to expose Prometheus metrics on (default "/metrics")help
-raw_cgroup_prefix_whitelist stringA comma-separated list of cgroup path prefix that needs to be collected even when -docker_only is specifiedhelp
-referenced_reset_interval uintReset 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…help
-resctrl_interval durationResctrl mon groups updating interval.help
-skip_headersIf true, avoid header prefixes in the log messageshelp
-skip_log_headersIf true, avoid headers when opening log files (no effect when -logtostderr=true)help
-stderrthreshold valuelogs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)help
-storage_driver driverStorage driver to use.help
-storage_driver_buffer_duration durationWrites in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction (default 1m0s)help
-storage_driver_db stringdatabase name (default "cadvisor")help
-storage_driver_es_enable_snifferElasticSearch uses a sniffing process to find all nodes of your cluster by default, automaticallyhelp
-storage_driver_es_host stringElasticSearch host:port (default "http://localhost:9200")help
-storage_driver_es_index stringElasticSearch index name (default "cadvisor")help
-storage_driver_es_type stringElasticSearch type name (default "stats")help
-storage_driver_host stringdatabase host:port (default "localhost:8086")help
-storage_driver_influxdb_retention_policy stringretention policyhelp
-storage_driver_kafka_broker_list stringkafka broker(s) csv (default "localhost:9092")help
-storage_driver_kafka_ssl_ca stringoptional certificate authority file for TLS client authenticationhelp
-storage_driver_kafka_ssl_cert stringoptional certificate file for TLS client authenticationhelp
-storage_driver_kafka_ssl_key stringoptional key file for TLS client authenticationhelp
-storage_driver_kafka_ssl_verifyverify ssl certificate chain (default true)help
-storage_driver_kafka_topic stringkafka topic (default "stats")help
-storage_driver_password stringdatabase password (default "root")help
-storage_driver_secureuse secure connection with databasehelp
-storage_driver_table stringtable name (default "stats")help
-storage_driver_user stringdatabase username (default "root")help
-storage_duration durationHow long to keep data stored (Default: 2min).help
-store_container_labelsconvert container labels and environment variables into labels on prometheus metrics for each container.help
-update_machine_info_interval durationInterval between machine info updates.help
-url_base_prefix stringprefix path that will be prepended to all paths to support some reverse proxieshelp
-v valuenumber for the log level verbosityhelp
-versionprint cAdvisor version and exithelp
-vmodule valuecomma-separated list of pattern=N settings for file-filtered logginghelp
-whitelisted_container_labels stringcomma separated list of container labels to be converted to labels on prometheus metrics for each container.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.