fix: fixed integration tests and revise cmd flag doc.

Signed-off-by: colstuwjx <[email protected]>

Author: Colstuwjx

build/integration.sh

@@ -27,7 +27,7 @@ function start {
   set +e  # We want to handle errors if cAdvisor crashes.
   echo ">> starting cAdvisor locally"
   # This cpuset, percpu, memory, disk, diskIO, network, perf_event metrics should be enabled.
-  GORACE="halt_on_error=1" ./cadvisor --enable_metrics="cpuset,percpu,memory,disk,diskIO,network,perf_event" --docker_env_metadata_whitelist=TEST_VAR --v=6 --logtostderr $CADVISOR_ARGS &> "$log_file"
+  GORACE="halt_on_error=1" ./cadvisor --enable_metrics="cpuset,percpu,memory,disk,diskIO,network,perf_event" --env_metadata_whitelist=TEST_VAR --v=6 --logtostderr $CADVISOR_ARGS &> "$log_file"
   if [ $? != 0 ]; then
     echo "!! cAdvisor exited unexpectedly with Exit $?"
     kill $TEST_PID # cAdvisor crashed: abort testing.

cmd/cadvisor.go

@@ -65,7 +65,7 @@ var collectorKey = flag.String("collector_key", "", "Key for the collector's cer
 var storeContainerLabels = flag.Bool("store_container_labels", true, "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")
 var whitelistedContainerLabels = flag.String("whitelisted_container_labels", "", "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.")
 
-var envMetadataWhiteList = flag.String("env_metadata_whitelist", "", "a comma-separated list of environment variable keys matched with specified prefix that needs to be collected for containers")
+var envMetadataWhiteList = flag.String("env_metadata_whitelist", "", "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.")
 
 var urlBasePrefix = flag.String("url_base_prefix", "", "prefix path that will be prepended to all paths to support some reverse proxies")
 

docs/runtime_options.md

@@ -6,6 +6,10 @@ This document describes a set of runtime flags available in cAdvisor.
 * `--store_container_labels=false` - do not convert container labels and environment variables into labels on prometheus metrics for each container.
 * `--whitelisted_container_labels` - 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.
 
+## Container envs
+
+--env_metadata_whitelist="": a comma-separated list of environment variable keys that needs to be collected for containers, only support containerd and docker runtime for now.
+
 ## Limiting which containers are monitored 
 * `--docker_only=false` - do not report raw cgroup metrics, except the root cgroup.
 * `--raw_cgroup_prefix_whitelist` - a comma-separated list of cgroup path prefix that needs to be collected even when `--docker_only` is specified
@@ -52,7 +56,6 @@ From [glog](https://github.com/golang/glog) here are some flags we find useful:
 
 ```
 --docker="unix:///var/run/docker.sock": docker endpoint (default "unix:///var/run/docker.sock")
---docker_env_metadata_whitelist="": a comma-separated list of environment variable keys that needs to be collected for docker containers
 --docker_root="/var/lib/docker": DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker) (default "/var/lib/docker")
 --docker-tls: use TLS to connect to docker
 --docker-tls-cert="cert.pem": client certificate for TLS-connection with docker

integration/runner/runner.go

@@ -113,7 +113,7 @@ func PushAndRunTests(host, testDir string) (result error) {
 	portStr := strconv.Itoa(*port)
 	errChan := make(chan error, 1)
 	go func() {
-		err = RunSshCommand("ssh", host, "--", fmt.Sprintf("sudo GORACE='halt_on_error=1' %s --port %s --logtostderr --docker_env_metadata_whitelist=TEST_VAR  &> %s/log.txt", path.Join(testDir, cadvisorBinary), portStr, testDir))
+		err = RunSshCommand("ssh", host, "--", fmt.Sprintf("sudo GORACE='halt_on_error=1' %s --port %s --logtostderr --env_metadata_whitelist=TEST_VAR  &> %s/log.txt", path.Join(testDir, cadvisorBinary), portStr, testDir))
 		if err != nil {
 			errChan <- fmt.Errorf("error running cAdvisor: %v", err)
 		}