mirror of
				https://github.com/k3s-io/kubernetes.git
				synced 2025-10-30 21:30:16 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			183 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
			
		
		
	
	
			183 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
| .TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015"  ""
 | |
| 
 | |
| 
 | |
| .SH NAME
 | |
| .PP
 | |
| kubectl logs \- Print the logs for a container in a pod.
 | |
| 
 | |
| 
 | |
| .SH SYNOPSIS
 | |
| .PP
 | |
| \fBkubectl logs\fP [OPTIONS]
 | |
| 
 | |
| 
 | |
| .SH DESCRIPTION
 | |
| .PP
 | |
| Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
 | |
| 
 | |
| 
 | |
| .SH OPTIONS
 | |
| .PP
 | |
| \fB\-c\fP, \fB\-\-container\fP=""
 | |
|     Print the logs of this container
 | |
| 
 | |
| .PP
 | |
| \fB\-f\fP, \fB\-\-follow\fP=false
 | |
|     Specify if the logs should be streamed.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-interactive\fP=false
 | |
|     If true, prompt the user for input when required.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-limit\-bytes\fP=0
 | |
|     Maximum bytes of logs to return. Defaults to no limit.
 | |
| 
 | |
| .PP
 | |
| \fB\-p\fP, \fB\-\-previous\fP=false
 | |
|     If true, print the logs for the previous instance of the container in a pod if it exists.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-since\fP=0
 | |
|     Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since\-time / since may be used.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-since\-time\fP=""
 | |
|     Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since\-time / since may be used.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-tail\fP=\-1
 | |
|     Lines of recent log file to display. Defaults to \-1, showing all log lines.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-timestamps\fP=false
 | |
|     Include timestamps on each line in the log output
 | |
| 
 | |
| 
 | |
| .SH OPTIONS INHERITED FROM PARENT COMMANDS
 | |
| .PP
 | |
| \fB\-\-alsologtostderr\fP=false
 | |
|     log to standard error as well as files
 | |
| 
 | |
| .PP
 | |
| \fB\-\-api\-version\fP=""
 | |
|     The API version to use when talking to the server
 | |
| 
 | |
| .PP
 | |
| \fB\-\-certificate\-authority\fP=""
 | |
|     Path to a cert. file for the certificate authority.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-client\-certificate\fP=""
 | |
|     Path to a client certificate file for TLS.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-client\-key\fP=""
 | |
|     Path to a client key file for TLS.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-cluster\fP=""
 | |
|     The name of the kubeconfig cluster to use
 | |
| 
 | |
| .PP
 | |
| \fB\-\-context\fP=""
 | |
|     The name of the kubeconfig context to use
 | |
| 
 | |
| .PP
 | |
| \fB\-\-insecure\-skip\-tls\-verify\fP=false
 | |
|     If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-kubeconfig\fP=""
 | |
|     Path to the kubeconfig file to use for CLI requests.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-log\-backtrace\-at\fP=:0
 | |
|     when logging hits line file:N, emit a stack trace
 | |
| 
 | |
| .PP
 | |
| \fB\-\-log\-dir\fP=""
 | |
|     If non\-empty, write log files in this directory
 | |
| 
 | |
| .PP
 | |
| \fB\-\-log\-flush\-frequency\fP=5s
 | |
|     Maximum number of seconds between log flushes
 | |
| 
 | |
| .PP
 | |
| \fB\-\-logtostderr\fP=true
 | |
|     log to standard error instead of files
 | |
| 
 | |
| .PP
 | |
| \fB\-\-match\-server\-version\fP=false
 | |
|     Require server version to match client version
 | |
| 
 | |
| .PP
 | |
| \fB\-\-namespace\fP=""
 | |
|     If present, the namespace scope for this CLI request.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-password\fP=""
 | |
|     Password for basic authentication to the API server.
 | |
| 
 | |
| .PP
 | |
| \fB\-s\fP, \fB\-\-server\fP=""
 | |
|     The address and port of the Kubernetes API server
 | |
| 
 | |
| .PP
 | |
| \fB\-\-stderrthreshold\fP=2
 | |
|     logs at or above this threshold go to stderr
 | |
| 
 | |
| .PP
 | |
| \fB\-\-token\fP=""
 | |
|     Bearer token for authentication to the API server.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-user\fP=""
 | |
|     The name of the kubeconfig user to use
 | |
| 
 | |
| .PP
 | |
| \fB\-\-username\fP=""
 | |
|     Username for basic authentication to the API server.
 | |
| 
 | |
| .PP
 | |
| \fB\-\-v\fP=0
 | |
|     log level for V logs
 | |
| 
 | |
| .PP
 | |
| \fB\-\-vmodule\fP=
 | |
|     comma\-separated list of pattern=N settings for file\-filtered logging
 | |
| 
 | |
| 
 | |
| .SH EXAMPLE
 | |
| .PP
 | |
| .RS
 | |
| 
 | |
| .nf
 | |
| # Return snapshot logs from pod nginx with only one container
 | |
| $ kubectl logs nginx
 | |
| 
 | |
| # Return snapshot of previous terminated ruby container logs from pod web\-1
 | |
| $ kubectl logs \-p \-c ruby web\-1
 | |
| 
 | |
| # Begin streaming the logs of the ruby container in pod web\-1
 | |
| $ kubectl logs \-f \-c ruby web\-1
 | |
| 
 | |
| # Display only the most recent 20 lines of output in pod nginx
 | |
| $ kubectl logs \-\-tail=20 nginx
 | |
| 
 | |
| # Show all logs from pod nginx written in the last hour
 | |
| $ kubectl logs \-\-since=1h nginx
 | |
| 
 | |
| .fi
 | |
| .RE
 | |
| 
 | |
| 
 | |
| .SH SEE ALSO
 | |
| .PP
 | |
| \fBkubectl(1)\fP,
 | |
| 
 | |
| 
 | |
| .SH HISTORY
 | |
| .PP
 | |
| January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!
 |