OS Manuals

/usr/bin/amazon-cloudwatch-agent

CloudWatch Agent enables you to collect and export host-level metrics and logs on instances running Linux or Windows server.

From amazon-cloudwatch-agent 1.300069.0-r1 (os), captured 2026-11-05 by running amazon-cloudwatch-agent --help (exit 0). permalink

Usage of /usr/bin/amazon-cloudwatch-agent:
  -aggregator-filter string
    	filter the aggregators to enable, separator is :
  -allow_dynamic_housekeeping
    	Whether to allow the housekeeping interval to be dynamic (default 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")
  -config string
    	configuration file to load
  -config-directory string
    	directory containing additional *.conf files
  -console
    	run as console application (windows only)
  -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.
  -debug
    	turn on debug logging
  -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
  -envconfig string
    	env configuration file to load
  -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)
  -input-filter string
    	filter the inputs to enable, separator is :
  -input-list
    	print available input plugins.
  -log_cadvisor_usage
    	Whether to log the usage of the cAdvisor container
  -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)
  -otelconfig value
    	YAML configuration files to run OTel pipeline
  -output-filter string
    	filter the outputs to enable, separator is :
  -output-list
    	print available output plugins.
  -pidfile string
    	file to write our pid to
  -pprof-addr string
    	pprof address to listen on, disabled by default, examples: 'localhost:1234', ':4567' (restricted to localhost)
  -processor-filter string
    	filter the processors to enable, separator is :
  -quiet
    	run in quiet mode
  -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)
  -sample-config
    	print out full sample configuration
  -schematest
    	validate the toml file schema
  -section-filter string
    	filter the sections to print, separator is ':'. Valid values are 'agent', 'global_tags', 'outputs', 'processors', 'aggregators' and 'inputs'
  -service string
    	operate on the service (windows only)
  -service-display-name string
    	service display name (windows only) (default "Telegraf Data Collector Service")
  -service-name string
    	service name (windows only) (default "telegraf")
  -setenv string
    	set an env in the configuration file in the format of KEY=VALUE
  -startup-error-file string
    	file to touch if agent can't start
  -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_host string
    	database host:port (default "localhost:8086")
  -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")
  -test
    	enable test mode: gather metrics, print them out, and exit
  -test-wait int
    	wait up to this many seconds for service inputs to complete in test mode
  -update_machine_info_interval duration
    	Interval between machine info updates. (default 5m0s)
  -version
    	display the version and exit

Available subcommands:
  config-translator		Translate configuration files
  config-downloader		Download configuration from remote sources
  config-wizard			Interactive configuration wizard

Use '/usr/bin/amazon-cloudwatch-agent <subcommand> --help' for more information about a subcommand.
Options (60)
OptionDescriptionSource
-aggregator-filter stringfilter the aggregators to enable, separator is :help
-allow_dynamic_housekeepingWhether to allow the housekeeping interval to be dynamic (default 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
-config stringconfiguration file to loadhelp
-config-directory stringdirectory containing additional *.conf fileshelp
-consolerun as console application (windows only)help
-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
-debugturn on debug logginghelp
-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
-envconfig stringenv configuration file to loadhelp
-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
-input-filter stringfilter the inputs to enable, separator is :help
-input-listprint available input plugins.help
-log_cadvisor_usageWhether to log the usage of the cAdvisor containerhelp
-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
-otelconfig valueYAML configuration files to run OTel pipelinehelp
-output-filter stringfilter the outputs to enable, separator is :help
-output-listprint available output plugins.help
-pidfile stringfile to write our pid tohelp
-pprof-addr stringpprof address to listen on, disabled by default, examples: 'localhost:1234', ':4567' (restricted to localhost)help
-processor-filter stringfilter the processors to enable, separator is :help
-quietrun in quiet modehelp
-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
-sample-configprint out full sample configurationhelp
-schematestvalidate the toml file schemahelp
-section-filter stringfilter the sections to print, separator is ':'.help
-service stringoperate on the service (windows only)help
-service-display-name stringservice display name (windows only) (default "Telegraf Data Collector Service")help
-service-name stringservice name (windows only) (default "telegraf")help
-setenv stringset an env in the configuration file in the format of KEY=VALUEhelp
-startup-error-file stringfile to touch if agent can't starthelp
-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_host stringdatabase host:port (default "localhost:8086")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
-testenable test mode: gather metrics, print them out, and exithelp
-test-wait intwait up to this many seconds for service inputs to complete in test modehelp
-update_machine_info_interval durationInterval between machine info updates.help
-versiondisplay the version and exithelp

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