.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
.TH CADVISOR "1" "January 2021" "cAdvisor version 0.38.7+ds1 (0.38.7+ds1-1)" "User Commands"
.SH NAME
cAdvisor \- manual page for cAdvisor version 0.38.7+ds1 (0.38.7+ds1-1)
.SH DESCRIPTION
.SS "Usage of /usr/bin/cadvisor:"
.HP
\fB\-add_dir_header\fR
.IP
If true, adds the file directory to the header of the log messages
.HP
\fB\-allow_dynamic_housekeeping\fR
.IP
Whether to allow the housekeeping interval to be dynamic (default true)
.HP
\fB\-alsologtostderr\fR
.IP
log to standard error as well as files
.HP
\fB\-application_metrics_count_limit\fR int
.IP
Max number of application metrics to store (per container) (default 100)
.HP
\fB\-boot_id_file\fR string
.IP
Comma\-separated list of files to check for boot\-id. Use the first one that exists. (default "/proc/sys/kernel/random/boot_id")
.HP
\fB\-bq_account\fR string
.IP
Service account email
.HP
\fB\-bq_credentials_file\fR string
.IP
Credential Key file (pem)
.HP
\fB\-bq_id\fR string
.IP
Client ID
.HP
\fB\-bq_project_id\fR string
.IP
Bigquery project ID
.HP
\fB\-bq_secret\fR string
.IP
Client Secret (default "notasecret")
.HP
\fB\-collector_cert\fR string
.IP
Collector's certificate, exposed to endpoints for certificate based authentication.
.HP
\fB\-collector_key\fR string
.IP
Key for the collector's certificate
.HP
\fB\-container_hints\fR string
.IP
location of the container hints file (default "/etc/cadvisor/container_hints.json")
.HP
\fB\-containerd\fR string
.IP
containerd endpoint (default "/run/containerd/containerd.sock")
.HP
\fB\-containerd\-namespace\fR string
.IP
containerd namespace (default "k8s.io")
.HP
\fB\-disable_metrics\fR metrics
.IP
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)
.HP
\fB\-disable_root_cgroup_stats\fR
.IP
Disable collecting root Cgroup stats
.HP
\fB\-docker\fR string
.IP
docker endpoint (default "unix:///var/run/docker.sock")
.HP
\fB\-docker\-tls\fR
.IP
use TLS to connect to docker
.HP
\fB\-docker\-tls\-ca\fR string
.IP
path to trusted CA (default "ca.pem")
.HP
\fB\-docker\-tls\-cert\fR string
.IP
path to client certificate (default "cert.pem")
.HP
\fB\-docker\-tls\-key\fR string
.IP
path to private key (default "key.pem")
.HP
\fB\-docker_env_metadata_whitelist\fR string
.IP
a comma\-separated list of environment variable keys matched with specified prefix that needs to be collected for docker containers
.HP
\fB\-docker_only\fR
.IP
Only report docker containers in addition to root stats
.HP
\fB\-docker_root\fR string
.IP
DEPRECATED: docker root is read from docker info (this is a fallback, default: \fI\,/var/lib/docker\/\fP) (default "/var/lib/docker")
.HP
\fB\-enable_load_reader\fR
.IP
Whether to enable cpu load reader
.HP
\fB\-event_storage_age_limit\fR string
.IP
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")
.HP
\fB\-event_storage_event_limit\fR string
.IP
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")
.HP
\fB\-global_housekeeping_interval\fR duration
.IP
Interval between global housekeepings (default 1m0s)
.HP
\fB\-housekeeping_interval\fR duration
.IP
Interval between container housekeepings (default 1s)
.HP
\fB\-http_auth_file\fR string
.IP
HTTP auth file for the web UI
.HP
\fB\-http_auth_realm\fR string
.IP
HTTP auth realm for the web UI (default "localhost")
.HP
\fB\-http_digest_file\fR string
.IP
HTTP digest file for the web UI
.HP
\fB\-http_digest_realm\fR string
.IP
HTTP digest file for the web UI (default "localhost")
.HP
\fB\-listen_ip\fR string
.IP
IP to listen on, defaults to all IPs
.HP
\fB\-log_backtrace_at\fR value
.IP
when logging hits line file:N, emit a stack trace
.HP
\fB\-log_cadvisor_usage\fR
.IP
Whether to log the usage of the cAdvisor container
.HP
\fB\-log_dir\fR string
.IP
If non\-empty, write log files in this directory
.HP
\fB\-log_file\fR string
.IP
If non\-empty, use this log file
.HP
\fB\-log_file_max_size\fR uint
.IP
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)
.HP
\fB\-logtostderr\fR
.IP
log to standard error instead of files (default true)
.HP
\fB\-machine_id_file\fR string
.IP
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")
.HP
\fB\-max_housekeeping_interval\fR duration
.IP
Largest interval to allow between container housekeepings (default 1m0s)
.HP
\fB\-max_procs\fR int
.IP
max number of CPUs that can be used simultaneously. Less than 1 for default (number of cores).
.HP
\fB\-mesos_agent\fR string
.IP
Mesos agent address (default "127.0.0.1:5051")
.HP
\fB\-mesos_agent_timeout\fR duration
.IP
Mesos agent timeout (default 10s)
.HP
\fB\-perf_events_config\fR string
.IP
Path to a JSON file containing configuration of perf events to measure. Empty value disabled perf events measuring.
.HP
\fB\-port\fR int
.IP
port to listen (default 8080)
.HP
\fB\-profiling\fR
.IP
Enable profiling via web interface host:port/debug/pprof/
.HP
\fB\-prometheus_endpoint\fR string
.IP
Endpoint to expose Prometheus metrics on (default "/metrics")
.HP
\fB\-raw_cgroup_prefix_whitelist\fR string
.IP
A comma\-separated list of cgroup path prefix that needs to be collected even when \fB\-docker_only\fR is specified
.HP
\fB\-referenced_reset_interval\fR uint
.IP
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)
.HP
\fB\-skip_headers\fR
.IP
If true, avoid header prefixes in the log messages
.HP
\fB\-skip_log_headers\fR
.IP
If true, avoid headers when opening log files
.HP
\fB\-stderrthreshold\fR value
.IP
logs at or above this threshold go to stderr (default 2)
.HP
\fB\-storage_driver\fR driver
.IP
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, kafka, redis, statsd, stdout
.HP
\fB\-storage_driver_buffer_duration\fR duration
.IP
Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction (default 1m0s)
.HP
\fB\-storage_driver_db\fR string
.IP
database name (default "cadvisor")
.HP
\fB\-storage_driver_es_enable_sniffer\fR
.IP
ElasticSearch uses a sniffing process to find all nodes of your cluster by default, automatically
.HP
\fB\-storage_driver_es_host\fR string
.IP
ElasticSearch host:port (default "http://localhost:9200")
.HP
\fB\-storage_driver_es_index\fR string
.IP
ElasticSearch index name (default "cadvisor")
.HP
\fB\-storage_driver_es_type\fR string
.IP
ElasticSearch type name (default "stats")
.HP
\fB\-storage_driver_host\fR string
.IP
database host:port (default "localhost:8086")
.HP
\fB\-storage_driver_kafka_broker_list\fR string
.IP
kafka broker(s) csv (default "localhost:9092")
.HP
\fB\-storage_driver_kafka_ssl_ca\fR string
.IP
optional certificate authority file for TLS client authentication
.HP
\fB\-storage_driver_kafka_ssl_cert\fR string
.IP
optional certificate file for TLS client authentication
.HP
\fB\-storage_driver_kafka_ssl_key\fR string
.IP
optional key file for TLS client authentication
.HP
\fB\-storage_driver_kafka_ssl_verify\fR
.IP
verify ssl certificate chain (default true)
.HP
\fB\-storage_driver_kafka_topic\fR string
.IP
kafka topic (default "stats")
.HP
\fB\-storage_driver_password\fR string
.IP
database password (default "root")
.HP
\fB\-storage_driver_secure\fR
.IP
use secure connection with database
.HP
\fB\-storage_driver_table\fR string
.IP
table name (default "stats")
.HP
\fB\-storage_driver_user\fR string
.IP
database username (default "root")
.HP
\fB\-storage_duration\fR duration
.IP
How long to keep data stored (Default: 2min). (default 2m0s)
.HP
\fB\-store_container_labels\fR
.IP
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)
.HP
\fB\-update_machine_info_interval\fR duration
.IP
Interval between machine info updates. (default 5m0s)
.HP
\fB\-url_base_prefix\fR string
.IP
prefix path that will be prepended to all paths to support some reverse proxies
.HP
\fB\-v\fR value
.IP
number for the log level verbosity
.HP
\fB\-version\fR
.IP
print cAdvisor version and exit
.HP
\fB\-vmodule\fR value
.IP
comma\-separated list of pattern=N settings for file\-filtered logging
.HP
\fB\-whitelisted_container_labels\fR string
.IP
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.