1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl top pod - Display Resource (CPU/Memory/Storage) usage of pods
7
11 kubectl top pod [OPTIONS]
12
16 Display Resource (CPU/Memory/Storage) usage of pods.
17 The 'top pod' command allows you to see the resource consumption of
20 pods.
21 Due to the metrics pipeline delay, they may be unavailable for a few
24 minutes since pod creation.
25
29 -A, --all-namespaces=false
30 If present, list the requested object(s) across all namespaces.
31 Namespace in current context is ignored even if specified with
32 --namespace.
33 --containers=false
36 If present, print usage of containers within a pod.
37 --heapster-namespace="kube-system"
40 Namespace Heapster service is located in
41 --heapster-port=""
44 Port name in service to use
45 --heapster-scheme="http"
48 Scheme (http or https) to connect to Heapster as
49 --heapster-service="heapster"
52 Name of Heapster service
53 --no-headers=false
56 If present, print output without headers.
57 -l, --selector=""
60 Selector (label query) to filter on, supports '=', '==', and
61 '!='.(e.g. -l key1=value1,key2=value2)
62 --sort-by=""
65 If non-empty, sort pods list using specified field. The field can
66 be either 'cpu' or 'memory'.
67
71 --add-dir-header=false
72 If true, adds the file directory to the header
73 --alsologtostderr=false
76 log to standard error as well as files
77 --application-metrics-count-limit=100
80 Max number of application metrics to store (per container)
81 --as=""
84 Username to impersonate for the operation
85 --as-group=[]
88 Group to impersonate for the operation, this flag can be repeated
89 to specify multiple groups.
90 --azure-container-registry-config=""
93 Path to the file containing Azure container registry configuration
94 information.
95 --boot-id-file="/proc/sys/kernel/random/boot_id"
98 Comma-separated list of files to check for boot-id. Use the first
99 one that exists.
100 --cache-dir="/builddir/.kube/http-cache"
103 Default HTTP cache directory
104 --certificate-authority=""
107 Path to a cert file for the certificate authority
108 --client-certificate=""
111 Path to a client certificate file for TLS
112 --client-key=""
115 Path to a client key file for TLS
116 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
119 CIDRs opened in GCE firewall for L7 LB traffic proxy health checks
120 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
123 CIDRs opened in GCE firewall for L4 LB traffic proxy health checks
124 --cluster=""
127 The name of the kubeconfig cluster to use
128 --container-hints="/etc/cadvisor/container_hints.json"
131 location of the container hints file
132 --containerd="/run/containerd/containerd.sock"
135 containerd endpoint
136 --containerd-namespace="k8s.io"
139 containerd namespace
140 --context=""
143 The name of the kubeconfig context to use
144 --default-not-ready-toleration-seconds=300
147 Indicates the tolerationSeconds of the toleration for
148 notReady:NoExecute that is added by default to every pod that does not
149 already have such a toleration.
150 --default-unreachable-toleration-seconds=300
153 Indicates the tolerationSeconds of the toleration for
154 unreachable:NoExecute that is added by default to every pod that does
155 not already have such a toleration.
156 --disable-root-cgroup-stats=false
159 Disable collecting root Cgroup stats
160 --docker="unix:///var/run/docker.sock"
163 docker endpoint
164 --docker-env-metadata-whitelist=""
167 a comma-separated list of environment variable keys that needs to
168 be collected for docker containers
169 --docker-only=false
172 Only report docker containers in addition to root stats
173 --docker-root="/var/lib/docker"
176 DEPRECATED: docker root is read from docker info (this is a
177 fallback, default: /var/lib/docker)
178 --docker-tls=false
181 use TLS to connect to docker
182 --docker-tls-ca="ca.pem"
185 path to trusted CA
186 --docker-tls-cert="cert.pem"
189 path to client certificate
190 --docker-tls-key="key.pem"
193 path to private key
194 --enable-load-reader=false
197 Whether to enable cpu load reader
198 --event-storage-age-limit="default=0"
201 Max length of time for which to store events (per type). Value is a
202 comma separated list of key values, where the keys are event types
203 (e.g.: creation, oom) or "default" and the value is a duration. Default
204 is applied to all non-specified event types
205 --event-storage-event-limit="default=0"
208 Max number of events to store (per type). Value is a comma
209 separated list of key values, where the keys are event types (e.g.:
210 creation, oom) or "default" and the value is an integer. Default is
211 applied to all non-specified event types
212 --global-housekeeping-interval=1m0s
215 Interval between global housekeepings
216 --housekeeping-interval=10s
219 Interval between container housekeepings
220 --insecure-skip-tls-verify=false
223 If true, the server's certificate will not be checked for validity.
224 This will make your HTTPS connections insecure
225 --kubeconfig=""
228 Path to the kubeconfig file to use for CLI requests.
229 --log-backtrace-at=:0
232 when logging hits line file:N, emit a stack trace
233 --log-cadvisor-usage=false
236 Whether to log the usage of the cAdvisor container
237 --log-dir=""
240 If non-empty, write log files in this directory
241 --log-file=""
244 If non-empty, use this log file
245 --log-file-max-size=1800
248 Defines the maximum size a log file can grow to. Unit is megabytes.
249 If the value is 0, the maximum file size is unlimited.
250 --log-flush-frequency=5s
253 Maximum number of seconds between log flushes
254 --logtostderr=true
257 log to standard error instead of files
258 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
261 Comma-separated list of files to check for machine-id. Use the
262 first one that exists.
263 --match-server-version=false
266 Require server version to match client version
267 -n, --namespace=""
270 If present, the namespace scope for this CLI request
271 --password=""
274 Password for basic authentication to the API server
275 --profile="none"
278 Name of profile to capture. One of
279 (none|cpu|heap|goroutine|threadcreate|block|mutex)
280 --profile-output="profile.pprof"
283 Name of the file to write the profile to
284 --request-timeout="0"
287 The length of time to wait before giving up on a single server
288 request. Non-zero values should contain a corresponding time unit (e.g.
289 1s, 2m, 3h). A value of zero means don't timeout requests.
290 -s, --server=""
293 The address and port of the Kubernetes API server
294 --skip-headers=false
297 If true, avoid header prefixes in the log messages
298 --skip-log-headers=false
301 If true, avoid headers when opening log files
302 --stderrthreshold=2
305 logs at or above this threshold go to stderr
306 --storage-driver-buffer-duration=1m0s
309 Writes in the storage driver will be buffered for this duration,
310 and committed to the non memory backends as a single transaction
311 --storage-driver-db="cadvisor"
314 database name
315 --storage-driver-host="localhost:8086"
318 database host:port
319 --storage-driver-password="root"
322 database password
323 --storage-driver-secure=false
326 use secure connection with database
327 --storage-driver-table="stats"
330 table name
331 --storage-driver-user="root"
334 database username
335 --tls-server-name=""
338 Server name to use for server certificate validation. If it is not
339 provided, the hostname used to contact the server is used
340 --token=""
343 Bearer token for authentication to the API server
344 --update-machine-info-interval=5m0s
347 Interval between machine info updates.
348 --user=""
351 The name of the kubeconfig user to use
352 --username=""
355 Username for basic authentication to the API server
356 -v, --v=0
359 number for the log level verbosity
360 --version=false
363 Print version information and quit
364 --vmodule=
367 comma-separated list of pattern=N settings for file-filtered
368 logging
369
373 # Show metrics for all pods in the default namespace
374 kubectl top pod
375 # Show metrics for all pods in the given namespace
377 kubectl top pod --namespace=NAMESPACE
378 # Show metrics for a given pod and its containers
380 kubectl top pod POD_NAME --containers
381 # Show metrics for the pods defined by label name=myLabel
383 kubectl top pod -l name=myLabel
384
389 kubectl-top(1),
390
394 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
395 com) based on the kubernetes source material, but hopefully they have
396 been automatically generated since!
397Eric Paris kubernetes User Manuals KUBERNETES(1)