diff --git a/api/swagger-spec/v1.json b/api/swagger-spec/v1.json index adfce7c846e..65c142c20af 100644 --- a/api/swagger-spec/v1.json +++ b/api/swagger-spec/v1.json @@ -6062,6 +6062,46 @@ "required": false, "allowMultiple": false }, + { + "type": "*int64", + "paramType": "query", + "name": "sinceSeconds", + "description": "A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.", + "required": false, + "allowMultiple": false + }, + { + "type": "*unversioned.Time", + "paramType": "query", + "name": "sinceTime", + "description": "An RFC3339 timestamp from which to show logs. If this value preceeds the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.", + "required": false, + "allowMultiple": false + }, + { + "type": "boolean", + "paramType": "query", + "name": "timestamps", + "description": "If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.", + "required": false, + "allowMultiple": false + }, + { + "type": "*int64", + "paramType": "query", + "name": "tailLines", + "description": "If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime", + "required": false, + "allowMultiple": false + }, + { + "type": "*int64", + "paramType": "query", + "name": "limitBytes", + "description": "If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.", + "required": false, + "allowMultiple": false + }, { "type": "string", "paramType": "path", diff --git a/contrib/completions/bash/kubectl b/contrib/completions/bash/kubectl index a25685db766..3173c5bf5ba 100644 --- a/contrib/completions/bash/kubectl +++ b/contrib/completions/bash/kubectl @@ -533,8 +533,13 @@ _kubectl_logs() flags+=("--follow") flags+=("-f") flags+=("--interactive") + flags+=("--limit-bytes=") flags+=("--previous") flags+=("-p") + flags+=("--since=") + flags+=("--since-time=") + flags+=("--tail=") + flags+=("--timestamps") must_have_one_flag=() must_have_one_noun=() diff --git a/docs/man/man1/kubectl-logs.1 b/docs/man/man1/kubectl-logs.1 index ca4c7783538..69ff0b39225 100644 --- a/docs/man/man1/kubectl-logs.1 +++ b/docs/man/man1/kubectl-logs.1 @@ -29,10 +29,30 @@ Print the logs for a container in a pod. If the pod has only one container, the \fB\-\-interactive\fP=true If true, prompt the user for input when required. Default true. +.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 @@ -133,14 +153,20 @@ Print the logs for a container in a pod. If the pod has only one container, the .RS .nf -# Return snapshot of ruby\-container logs from pod 123456\-7890. -$ kubectl logs 123456\-7890 ruby\-container +# Return snapshot logs from pod nginx with only one container +$ kubectl logs nginx -# Return snapshot of previous terminated ruby\-container logs from pod 123456\-7890. -$ kubectl logs \-p 123456\-7890 ruby\-container +# Return snapshot of previous terminated ruby container logs from pod web\-1 +$ kubectl logs \-p \-c ruby web\-1 -# Start streaming of ruby\-container logs from pod 123456\-7890. -$ kubectl logs \-f 123456\-7890 ruby\-container +# 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 diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index 0a28240154b..9478225f848 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -47,14 +47,20 @@ kubectl logs [-f] [-p] POD [-c CONTAINER] ### Examples ``` -# Return snapshot of ruby-container logs from pod 123456-7890. -$ kubectl logs 123456-7890 ruby-container +# Return snapshot logs from pod nginx with only one container +$ kubectl logs nginx -# Return snapshot of previous terminated ruby-container logs from pod 123456-7890. -$ kubectl logs -p 123456-7890 ruby-container +# Return snapshot of previous terminated ruby container logs from pod web-1 +$ kubectl logs -p -c ruby web-1 -# Start streaming of ruby-container logs from pod 123456-7890. -$ kubectl logs -f 123456-7890 ruby-container +# 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 ``` ### Options @@ -63,7 +69,12 @@ $ kubectl logs -f 123456-7890 ruby-container -c, --container="": Container name -f, --follow[=false]: Specify if the logs should be streamed. --interactive[=true]: If true, prompt the user for input when required. Default true. + --limit-bytes=0: Maximum bytes of logs to return. Defaults to no limit. -p, --previous[=false]: If true, print the logs for the previous instance of the container in a pod if it exists. + --since=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. + --since-time="": Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. + --tail=-1: Lines of recent log file to display. Defaults to -1, showing all log lines. + --timestamps[=false]: Include timestamps on each line in the log output ``` ### Options inherited from parent commands @@ -98,7 +109,7 @@ $ kubectl logs -f 123456-7890 ruby-container * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-10 18:53:03.154570214 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-16 18:54:52.319210951 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]() diff --git a/hack/verify-flags/known-flags.txt b/hack/verify-flags/known-flags.txt index 48fb7fdc807..8f2ce74ca64 100644 --- a/hack/verify-flags/known-flags.txt +++ b/hack/verify-flags/known-flags.txt @@ -1,3 +1,4 @@ + accept-hosts accept-paths account-for-pod-resources @@ -142,6 +143,7 @@ kube-master label-columns last-release-pr legacy-userspace-proxy +limit-bytes load-balancer-ip log-flush-frequency long-running-request-regexp @@ -251,6 +253,8 @@ service-node-port-range service-node-ports service-sync-period session-affinity +since-seconds +since-time show-all shutdown-fd shutdown-fifo @@ -286,3 +290,4 @@ www-prefix retry_time file_content_in_loop cpu-cfs-quota + diff --git a/pkg/api/deep_copy_generated.go b/pkg/api/deep_copy_generated.go index 0953e7bcd5b..9ae65b19d99 100644 --- a/pkg/api/deep_copy_generated.go +++ b/pkg/api/deep_copy_generated.go @@ -1430,6 +1430,33 @@ func deepCopy_api_PodLogOptions(in PodLogOptions, out *PodLogOptions, c *convers out.Container = in.Container out.Follow = in.Follow out.Previous = in.Previous + if in.SinceSeconds != nil { + out.SinceSeconds = new(int64) + *out.SinceSeconds = *in.SinceSeconds + } else { + out.SinceSeconds = nil + } + if in.SinceTime != nil { + out.SinceTime = new(unversioned.Time) + if err := deepCopy_unversioned_Time(*in.SinceTime, out.SinceTime, c); err != nil { + return err + } + } else { + out.SinceTime = nil + } + out.Timestamps = in.Timestamps + if in.TailLines != nil { + out.TailLines = new(int64) + *out.TailLines = *in.TailLines + } else { + out.TailLines = nil + } + if in.LimitBytes != nil { + out.LimitBytes = new(int64) + *out.LimitBytes = *in.LimitBytes + } else { + out.LimitBytes = nil + } return nil } diff --git a/pkg/api/helpers.go b/pkg/api/helpers.go index 5117923a2c4..e113ffc2a0d 100644 --- a/pkg/api/helpers.go +++ b/pkg/api/helpers.go @@ -21,6 +21,7 @@ import ( "fmt" "reflect" "strings" + "time" "k8s.io/kubernetes/pkg/api/resource" "k8s.io/kubernetes/pkg/api/unversioned" @@ -235,3 +236,15 @@ func containsAccessMode(modes []PersistentVolumeAccessMode, mode PersistentVolum } return false } + +// ParseRFC3339 parses an RFC3339 date in either RFC3339Nano or RFC3339 format. +func ParseRFC3339(s string, nowFn func() unversioned.Time) (unversioned.Time, error) { + if t, timeErr := time.Parse(time.RFC3339Nano, s); timeErr == nil { + return unversioned.Time{t}, nil + } + t, err := time.Parse(time.RFC3339, s) + if err != nil { + return unversioned.Time{}, err + } + return unversioned.Time{t}, nil +} diff --git a/pkg/api/types.go b/pkg/api/types.go index 7d56e558cd3..c1bf6e3bfd8 100644 --- a/pkg/api/types.go +++ b/pkg/api/types.go @@ -1595,12 +1595,30 @@ type PodLogOptions struct { // Container for which to return logs Container string - // If true, follow the logs for the pod Follow bool - // If true, return previous terminated container logs Previous bool + // A relative time in seconds before the current time from which to show logs. If this value + // precedes the time a pod was started, only logs since the pod start will be returned. + // If this value is in the future, no logs will be returned. + // Only one of sinceSeconds or sinceTime may be specified. + SinceSeconds *int64 + // An RFC3339 timestamp from which to show logs. If this value + // preceeds the time a pod was started, only logs since the pod start will be returned. + // If this value is in the future, no logs will be returned. + // Only one of sinceSeconds or sinceTime may be specified. + SinceTime *unversioned.Time + // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line + // of log output. + Timestamps bool + // If set, the number of lines from the end of the logs to show. If not specified, + // logs are shown from the creation of the container or sinceSeconds or sinceTime + TailLines *int64 + // If set, the number of bytes to read from the server before terminating the + // log output. This may not display a complete final line of logging, and may return + // slightly more or slightly less than the specified limit. + LimitBytes *int64 } // PodAttachOptions is the query options to a Pod's remote attach call diff --git a/pkg/api/v1/conversion_generated.go b/pkg/api/v1/conversion_generated.go index 263f0056be1..9eb0a67670f 100644 --- a/pkg/api/v1/conversion_generated.go +++ b/pkg/api/v1/conversion_generated.go @@ -1648,6 +1648,32 @@ func convert_api_PodLogOptions_To_v1_PodLogOptions(in *api.PodLogOptions, out *P out.Container = in.Container out.Follow = in.Follow out.Previous = in.Previous + if in.SinceSeconds != nil { + out.SinceSeconds = new(int64) + *out.SinceSeconds = *in.SinceSeconds + } else { + out.SinceSeconds = nil + } + if in.SinceTime != nil { + if err := s.Convert(&in.SinceTime, &out.SinceTime, 0); err != nil { + return err + } + } else { + out.SinceTime = nil + } + out.Timestamps = in.Timestamps + if in.TailLines != nil { + out.TailLines = new(int64) + *out.TailLines = *in.TailLines + } else { + out.TailLines = nil + } + if in.LimitBytes != nil { + out.LimitBytes = new(int64) + *out.LimitBytes = *in.LimitBytes + } else { + out.LimitBytes = nil + } return nil } @@ -4057,6 +4083,32 @@ func convert_v1_PodLogOptions_To_api_PodLogOptions(in *PodLogOptions, out *api.P out.Container = in.Container out.Follow = in.Follow out.Previous = in.Previous + if in.SinceSeconds != nil { + out.SinceSeconds = new(int64) + *out.SinceSeconds = *in.SinceSeconds + } else { + out.SinceSeconds = nil + } + if in.SinceTime != nil { + if err := s.Convert(&in.SinceTime, &out.SinceTime, 0); err != nil { + return err + } + } else { + out.SinceTime = nil + } + out.Timestamps = in.Timestamps + if in.TailLines != nil { + out.TailLines = new(int64) + *out.TailLines = *in.TailLines + } else { + out.TailLines = nil + } + if in.LimitBytes != nil { + out.LimitBytes = new(int64) + *out.LimitBytes = *in.LimitBytes + } else { + out.LimitBytes = nil + } return nil } diff --git a/pkg/api/v1/deep_copy_generated.go b/pkg/api/v1/deep_copy_generated.go index 4b5333a037f..bed17127257 100644 --- a/pkg/api/v1/deep_copy_generated.go +++ b/pkg/api/v1/deep_copy_generated.go @@ -1450,6 +1450,33 @@ func deepCopy_v1_PodLogOptions(in PodLogOptions, out *PodLogOptions, c *conversi out.Container = in.Container out.Follow = in.Follow out.Previous = in.Previous + if in.SinceSeconds != nil { + out.SinceSeconds = new(int64) + *out.SinceSeconds = *in.SinceSeconds + } else { + out.SinceSeconds = nil + } + if in.SinceTime != nil { + out.SinceTime = new(unversioned.Time) + if err := deepCopy_unversioned_Time(*in.SinceTime, out.SinceTime, c); err != nil { + return err + } + } else { + out.SinceTime = nil + } + out.Timestamps = in.Timestamps + if in.TailLines != nil { + out.TailLines = new(int64) + *out.TailLines = *in.TailLines + } else { + out.TailLines = nil + } + if in.LimitBytes != nil { + out.LimitBytes = new(int64) + *out.LimitBytes = *in.LimitBytes + } else { + out.LimitBytes = nil + } return nil } diff --git a/pkg/api/v1/types.go b/pkg/api/v1/types.go index db4d37d4665..5ccd0d9a798 100644 --- a/pkg/api/v1/types.go +++ b/pkg/api/v1/types.go @@ -1979,14 +1979,30 @@ type PodLogOptions struct { // The container for which to stream logs. Defaults to only container if there is one container in the pod. Container string `json:"container,omitempty"` - - // Follow the log stream of the pod. - // Defaults to false. + // Follow the log stream of the pod. Defaults to false. Follow bool `json:"follow,omitempty"` - - // Return previous terminated container logs. - // Defaults to false. + // Return previous terminated container logs. Defaults to false. Previous bool `json:"previous,omitempty"` + // A relative time in seconds before the current time from which to show logs. If this value + // precedes the time a pod was started, only logs since the pod start will be returned. + // If this value is in the future, no logs will be returned. + // Only one of sinceSeconds or sinceTime may be specified. + SinceSeconds *int64 `json:"sinceSeconds,omitempty"` + // An RFC3339 timestamp from which to show logs. If this value + // preceeds the time a pod was started, only logs since the pod start will be returned. + // If this value is in the future, no logs will be returned. + // Only one of sinceSeconds or sinceTime may be specified. + SinceTime *unversioned.Time `json:"sinceTime,omitempty"` + // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line + // of log output. Defaults to false. + Timestamps bool `json:"timestamps,omitempty"` + // If set, the number of lines from the end of the logs to show. If not specified, + // logs are shown from the creation of the container or sinceSeconds or sinceTime + TailLines *int64 `json:"tailLines,omitempty"` + // If set, the number of bytes to read from the server before terminating the + // log output. This may not display a complete final line of logging, and may return + // slightly more or slightly less than the specified limit. + LimitBytes *int64 `json:"limitBytes,omitempty"` } // PodAttachOptions is the query options to a Pod's remote attach call. diff --git a/pkg/api/v1/types_swagger_doc_generated.go b/pkg/api/v1/types_swagger_doc_generated.go index 9a935558b14..fe9bf32cacd 100644 --- a/pkg/api/v1/types_swagger_doc_generated.go +++ b/pkg/api/v1/types_swagger_doc_generated.go @@ -949,10 +949,15 @@ func (PodList) SwaggerDoc() map[string]string { } var map_PodLogOptions = map[string]string{ - "": "PodLogOptions is the query options for a Pod's logs REST call.", - "container": "The container for which to stream logs. Defaults to only container if there is one container in the pod.", - "follow": "Follow the log stream of the pod. Defaults to false.", - "previous": "Return previous terminated container logs. Defaults to false.", + "": "PodLogOptions is the query options for a Pod's logs REST call.", + "container": "The container for which to stream logs. Defaults to only container if there is one container in the pod.", + "follow": "Follow the log stream of the pod. Defaults to false.", + "previous": "Return previous terminated container logs. Defaults to false.", + "sinceSeconds": "A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.", + "sinceTime": "An RFC3339 timestamp from which to show logs. If this value preceeds the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.", + "timestamps": "If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.", + "tailLines": "If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime", + "limitBytes": "If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.", } func (PodLogOptions) SwaggerDoc() map[string]string { diff --git a/pkg/api/validation/validation.go b/pkg/api/validation/validation.go index 9cd3628057a..db19eb4cf4c 100644 --- a/pkg/api/validation/validation.go +++ b/pkg/api/validation/validation.go @@ -1950,3 +1950,23 @@ func ValidateThirdPartyResource(obj *api.ThirdPartyResource) errs.ValidationErro func ValidateSchemaUpdate(oldResource, newResource *api.ThirdPartyResource) errs.ValidationErrorList { return errs.ValidationErrorList{fmt.Errorf("Schema update is not supported.")} } + +func ValidatePodLogOptions(opts *api.PodLogOptions) errs.ValidationErrorList { + allErrs := errs.ValidationErrorList{} + if opts.TailLines != nil && *opts.TailLines < 0 { + allErrs = append(allErrs, errs.NewFieldInvalid("tailLines", *opts.TailLines, "tailLines must be a non-negative integer or nil")) + } + if opts.LimitBytes != nil && *opts.LimitBytes < 1 { + allErrs = append(allErrs, errs.NewFieldInvalid("limitBytes", *opts.LimitBytes, "limitBytes must be a positive integer or nil")) + } + switch { + case opts.SinceSeconds != nil && opts.SinceTime != nil: + allErrs = append(allErrs, errs.NewFieldInvalid("sinceSeconds", *opts.SinceSeconds, "only one of sinceTime or sinceSeconds can be provided")) + allErrs = append(allErrs, errs.NewFieldInvalid("sinceTime", *opts.SinceTime, "only one of sinceTime or sinceSeconds can be provided")) + case opts.SinceSeconds != nil: + if *opts.SinceSeconds < 1 { + allErrs = append(allErrs, errs.NewFieldInvalid("sinceSeconds", *opts.SinceSeconds, "sinceSeconds must be a positive integer")) + } + } + return allErrs +} diff --git a/pkg/api/validation/validation_test.go b/pkg/api/validation/validation_test.go index 614d21079c8..4bf7bdbd621 100644 --- a/pkg/api/validation/validation_test.go +++ b/pkg/api/validation/validation_test.go @@ -3864,3 +3864,34 @@ func fakeValidSecurityContext(priv bool) *api.SecurityContext { Privileged: &priv, } } + +func TestValidPodLogOptions(t *testing.T) { + now := unversioned.Now() + negative := int64(-1) + zero := int64(0) + positive := int64(1) + tests := []struct { + opt api.PodLogOptions + errs int + }{ + {api.PodLogOptions{}, 0}, + {api.PodLogOptions{Previous: true}, 0}, + {api.PodLogOptions{Follow: true}, 0}, + {api.PodLogOptions{TailLines: &zero}, 0}, + {api.PodLogOptions{TailLines: &negative}, 1}, + {api.PodLogOptions{TailLines: &positive}, 0}, + {api.PodLogOptions{LimitBytes: &zero}, 1}, + {api.PodLogOptions{LimitBytes: &negative}, 1}, + {api.PodLogOptions{LimitBytes: &positive}, 0}, + {api.PodLogOptions{SinceSeconds: &negative}, 1}, + {api.PodLogOptions{SinceSeconds: &positive}, 0}, + {api.PodLogOptions{SinceSeconds: &zero}, 1}, + {api.PodLogOptions{SinceTime: &now}, 0}, + } + for i, test := range tests { + errs := ValidatePodLogOptions(&test.opt) + if test.errs != len(errs) { + t.Errorf("%d: Unexpected errors: %v", i, errs) + } + } +} diff --git a/pkg/kubectl/cmd/log.go b/pkg/kubectl/cmd/log.go index b182f3c9e4c..e67df4eaa3f 100644 --- a/pkg/kubectl/cmd/log.go +++ b/pkg/kubectl/cmd/log.go @@ -19,26 +19,35 @@ package cmd import ( "fmt" "io" + "math" "os" "strconv" "strings" + "time" "github.com/spf13/cobra" "k8s.io/kubernetes/pkg/api" + "k8s.io/kubernetes/pkg/api/unversioned" client "k8s.io/kubernetes/pkg/client/unversioned" cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util" "k8s.io/kubernetes/pkg/util/sets" ) const ( - log_example = `# Return snapshot of ruby-container logs from pod 123456-7890. -$ kubectl logs 123456-7890 ruby-container + log_example = `# Return snapshot logs from pod nginx with only one container +$ kubectl logs nginx -# Return snapshot of previous terminated ruby-container logs from pod 123456-7890. -$ kubectl logs -p 123456-7890 ruby-container +# Return snapshot of previous terminated ruby container logs from pod web-1 +$ kubectl logs -p -c ruby web-1 -# Start streaming of ruby-container logs from pod 123456-7890. -$ kubectl logs -f 123456-7890 ruby-container` +# 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` ) func selectContainer(pod *api.Pod, in io.Reader, out io.Writer) string { @@ -82,8 +91,13 @@ func NewCmdLog(f *cmdutil.Factory, out io.Writer) *cobra.Command { Aliases: []string{"log"}, } cmd.Flags().BoolP("follow", "f", false, "Specify if the logs should be streamed.") + cmd.Flags().Bool("timestamps", false, "Include timestamps on each line in the log output") cmd.Flags().Bool("interactive", true, "If true, prompt the user for input when required. Default true.") cmd.Flags().BoolP("previous", "p", false, "If true, print the logs for the previous instance of the container in a pod if it exists.") + cmd.Flags().Int("limit-bytes", 0, "Maximum bytes of logs to return. Defaults to no limit.") + cmd.Flags().Int("tail", -1, "Lines of recent log file to display. Defaults to -1, showing all log lines.") + cmd.Flags().String("since-time", "", "Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.") + cmd.Flags().Duration("since", 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.") cmd.Flags().StringVarP(¶ms.containerName, "container", "c", "", "Container name") return cmd } @@ -102,6 +116,12 @@ func RunLog(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string return cmdutil.UsageError(cmd, "log POD [CONTAINER]") } + sinceSeconds := cmdutil.GetFlagDuration(cmd, "since") + sinceTime := cmdutil.GetFlagString(cmd, "since-time") + if len(sinceTime) > 0 && sinceSeconds > 0 { + return cmdutil.UsageError(cmd, "only one of --since, --since-time may be specified") + } + namespace, _, err := f.DefaultNamespace() if err != nil { return err @@ -137,28 +157,57 @@ func RunLog(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string } } - follow := false - if cmdutil.GetFlagBool(cmd, "follow") { - follow = true + logOptions := &api.PodLogOptions{ + Container: container, + Follow: cmdutil.GetFlagBool(cmd, "follow"), + Previous: cmdutil.GetFlagBool(cmd, "previous"), + Timestamps: cmdutil.GetFlagBool(cmd, "timestamps"), + } + if sinceSeconds > 0 { + // round up to the nearest second + sec := int64(math.Ceil(float64(sinceSeconds) / float64(time.Second))) + logOptions.SinceSeconds = &sec + } + if t, err := api.ParseRFC3339(sinceTime, unversioned.Now); err == nil { + logOptions.SinceTime = &t + } + if limitBytes := cmdutil.GetFlagInt(cmd, "limit-bytes"); limitBytes != 0 { + i := int64(limitBytes) + logOptions.LimitBytes = &i + } + if tail := cmdutil.GetFlagInt(cmd, "tail"); tail >= 0 { + i := int64(tail) + logOptions.TailLines = &i } - previous := false - if cmdutil.GetFlagBool(cmd, "previous") { - previous = true - } - return handleLog(client, namespace, podID, container, follow, previous, out) + return handleLog(client, namespace, podID, logOptions, out) } -func handleLog(client *client.Client, namespace, podID, container string, follow, previous bool, out io.Writer) error { - readCloser, err := client.RESTClient.Get(). +func handleLog(client *client.Client, namespace, podID string, logOptions *api.PodLogOptions, out io.Writer) error { + // TODO: transform this into a PodLogOptions call + req := client.RESTClient.Get(). Namespace(namespace). Name(podID). Resource("pods"). SubResource("log"). - Param("follow", strconv.FormatBool(follow)). - Param("container", container). - Param("previous", strconv.FormatBool(previous)). - Stream() + Param("follow", strconv.FormatBool(logOptions.Follow)). + Param("container", logOptions.Container). + Param("previous", strconv.FormatBool(logOptions.Previous)). + Param("timestamps", strconv.FormatBool(logOptions.Timestamps)) + + if logOptions.SinceSeconds != nil { + req.Param("sinceSeconds", strconv.FormatInt(*logOptions.SinceSeconds, 10)) + } + if logOptions.SinceTime != nil { + req.Param("sinceTime", logOptions.SinceTime.Format(time.RFC3339)) + } + if logOptions.LimitBytes != nil { + req.Param("limitBytes", strconv.FormatInt(*logOptions.LimitBytes, 10)) + } + if logOptions.TailLines != nil { + req.Param("tailLines", strconv.FormatInt(*logOptions.TailLines, 10)) + } + readCloser, err := req.Stream() if err != nil { return err } diff --git a/pkg/kubectl/cmd/run.go b/pkg/kubectl/cmd/run.go index d79f40d3803..01db053040a 100644 --- a/pkg/kubectl/cmd/run.go +++ b/pkg/kubectl/cmd/run.go @@ -291,7 +291,7 @@ func handleAttachPod(c *client.Client, pod *api.Pod, opts *AttachOptions) error return err } if status == api.PodSucceeded || status == api.PodFailed { - return handleLog(c, pod.Namespace, pod.Name, pod.Spec.Containers[0].Name, false, false, opts.Out) + return handleLog(c, pod.Namespace, pod.Name, &api.PodLogOptions{Container: pod.Spec.Containers[0].Name}, opts.Out) } opts.Client = c opts.PodName = pod.Name diff --git a/pkg/kubectl/cmd/util/helpers.go b/pkg/kubectl/cmd/util/helpers.go index 5ee9e59b299..c75bc0c5fb8 100644 --- a/pkg/kubectl/cmd/util/helpers.go +++ b/pkg/kubectl/cmd/util/helpers.go @@ -260,6 +260,15 @@ func GetFlagInt(cmd *cobra.Command, flag string) int { return i } +// Assumes the flag has a default value. +func GetFlagInt64(cmd *cobra.Command, flag string) int64 { + i, err := cmd.Flags().GetInt64(flag) + if err != nil { + glog.Fatalf("err accessing flag %s for command %s: %v", flag, cmd.Name(), err) + } + return i +} + func GetFlagDuration(cmd *cobra.Command, flag string) time.Duration { d, err := cmd.Flags().GetDuration(flag) if err != nil { diff --git a/pkg/kubelet/container/fake_runtime.go b/pkg/kubelet/container/fake_runtime.go index f93f5926db0..30116c13562 100644 --- a/pkg/kubelet/container/fake_runtime.go +++ b/pkg/kubelet/container/fake_runtime.go @@ -251,7 +251,7 @@ func (f *FakeRuntime) RunInContainer(containerID string, cmd []string) ([]byte, return []byte{}, f.Err } -func (f *FakeRuntime) GetContainerLogs(pod *api.Pod, containerID, tail string, follow bool, stdout, stderr io.Writer) (err error) { +func (f *FakeRuntime) GetContainerLogs(pod *api.Pod, containerID string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) (err error) { f.Lock() defer f.Unlock() diff --git a/pkg/kubelet/container/runtime.go b/pkg/kubelet/container/runtime.go index 141216dce0a..e26a54d856f 100644 --- a/pkg/kubelet/container/runtime.go +++ b/pkg/kubelet/container/runtime.go @@ -79,7 +79,7 @@ type Runtime interface { // default, it returns a snapshot of the container log. Set 'follow' to true to // stream the log. Set 'follow' to false and specify the number of lines (e.g. // "100" or "all") to tail the log. - GetContainerLogs(pod *api.Pod, containerID, tail string, follow bool, stdout, stderr io.Writer) (err error) + GetContainerLogs(pod *api.Pod, containerID string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) (err error) // ContainerCommandRunner encapsulates the command runner interfaces for testability. ContainerCommandRunner // ContainerAttach encapsulates the attaching to containers for testability diff --git a/pkg/kubelet/dockertools/manager.go b/pkg/kubelet/dockertools/manager.go index 1e096b61d05..426fa62c798 100644 --- a/pkg/kubelet/dockertools/manager.go +++ b/pkg/kubelet/dockertools/manager.go @@ -259,20 +259,29 @@ func (sc *reasonInfoCache) Get(uid types.UID, name string) (reasonInfo, bool) { // stream the log. Set 'follow' to false and specify the number of lines (e.g. // "100" or "all") to tail the log. // TODO: Make 'RawTerminal' option flagable. -func (dm *DockerManager) GetContainerLogs(pod *api.Pod, containerID, tail string, follow bool, stdout, stderr io.Writer) (err error) { +func (dm *DockerManager) GetContainerLogs(pod *api.Pod, containerID string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) (err error) { + var since int64 + if logOptions.SinceSeconds != nil { + t := unversioned.Now().Add(-time.Duration(*logOptions.SinceSeconds) * time.Second) + since = t.Unix() + } + if logOptions.SinceTime != nil { + since = logOptions.SinceTime.Unix() + } opts := docker.LogsOptions{ Container: containerID, Stdout: true, Stderr: true, OutputStream: stdout, ErrorStream: stderr, - Timestamps: false, + Timestamps: logOptions.Timestamps, + Since: since, + Follow: logOptions.Follow, RawTerminal: false, - Follow: follow, } - if !follow { - opts.Tail = tail + if !logOptions.Follow && logOptions.TailLines != nil { + opts.Tail = strconv.FormatInt(*logOptions.TailLines, 10) } err = dm.client.Logs(opts) diff --git a/pkg/kubelet/kubelet.go b/pkg/kubelet/kubelet.go index 8ee8e283e72..f21df9c62f5 100644 --- a/pkg/kubelet/kubelet.go +++ b/pkg/kubelet/kubelet.go @@ -1916,7 +1916,7 @@ func (kl *Kubelet) validateContainerStatus(podStatus *api.PodStatus, containerNa // GetKubeletContainerLogs returns logs from the container // TODO: this method is returning logs of random container attempts, when it should be returning the most recent attempt // or all of them. -func (kl *Kubelet) GetKubeletContainerLogs(podFullName, containerName, tail string, follow, previous bool, stdout, stderr io.Writer) error { +func (kl *Kubelet) GetKubeletContainerLogs(podFullName, containerName string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) error { // TODO(vmarmol): Refactor to not need the pod status and verification. // Pod workers periodically write status to statusManager. If status is not // cached there, something is wrong (or kubelet just restarted and hasn't @@ -1940,13 +1940,13 @@ func (kl *Kubelet) GetKubeletContainerLogs(podFullName, containerName, tail stri // No log is available if pod is not in a "known" phase (e.g. Unknown). return fmt.Errorf("Pod %q in namespace %q : %v", name, namespace, err) } - containerID, err := kl.validateContainerStatus(&podStatus, containerName, previous) + containerID, err := kl.validateContainerStatus(&podStatus, containerName, logOptions.Previous) if err != nil { // No log is available if the container status is missing or is in the // waiting state. return fmt.Errorf("Pod %q in namespace %q: %v", name, namespace, err) } - return kl.containerRuntime.GetContainerLogs(pod, containerID, tail, follow, stdout, stderr) + return kl.containerRuntime.GetContainerLogs(pod, containerID, logOptions, stdout, stderr) } // GetHostname Returns the hostname as the kubelet sees it. diff --git a/pkg/kubelet/rkt/rkt.go b/pkg/kubelet/rkt/rkt.go index c1680ebcd1f..2d449f5523e 100644 --- a/pkg/kubelet/rkt/rkt.go +++ b/pkg/kubelet/rkt/rkt.go @@ -1054,23 +1054,20 @@ func (r *runtime) SyncPod(pod *api.Pod, runningPod kubecontainer.Pod, podStatus // See https://github.com/coreos/rkt/blob/master/Documentation/commands.md#logging for more details. // // TODO(yifan): If the rkt is using lkvm as the stage1 image, then this function will fail. -func (r *runtime) GetContainerLogs(pod *api.Pod, containerID string, tail string, follow bool, stdout, stderr io.Writer) error { +func (r *runtime) GetContainerLogs(pod *api.Pod, containerID string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) error { id, err := parseContainerID(containerID) if err != nil { return err } cmd := exec.Command("journalctl", "-M", fmt.Sprintf("rkt-%s", id.uuid), "-u", id.appName) - if follow { + if logOptions.Follow { cmd.Args = append(cmd.Args, "-f") } - if tail == "all" { + if logOptions.TailLines == nil { cmd.Args = append(cmd.Args, "-a") } else { - _, err := strconv.Atoi(tail) - if err == nil { - cmd.Args = append(cmd.Args, "-n", tail) - } + cmd.Args = append(cmd.Args, "-n", strconv.FormatInt(*logOptions.TailLines, 10)) } cmd.Stdout, cmd.Stderr = stdout, stderr return cmd.Run() diff --git a/pkg/kubelet/server.go b/pkg/kubelet/server.go index 58ad838a3ce..250ebadacc7 100644 --- a/pkg/kubelet/server.go +++ b/pkg/kubelet/server.go @@ -36,7 +36,11 @@ import ( cadvisorApi "github.com/google/cadvisor/info/v1" "github.com/prometheus/client_golang/prometheus" "k8s.io/kubernetes/pkg/api" + apierrs "k8s.io/kubernetes/pkg/api/errors" "k8s.io/kubernetes/pkg/api/latest" + "k8s.io/kubernetes/pkg/api/unversioned" + "k8s.io/kubernetes/pkg/api/v1" + "k8s.io/kubernetes/pkg/api/validation" "k8s.io/kubernetes/pkg/healthz" "k8s.io/kubernetes/pkg/httplog" kubecontainer "k8s.io/kubernetes/pkg/kubelet/container" @@ -44,6 +48,7 @@ import ( "k8s.io/kubernetes/pkg/util/flushwriter" "k8s.io/kubernetes/pkg/util/httpstream" "k8s.io/kubernetes/pkg/util/httpstream/spdy" + "k8s.io/kubernetes/pkg/util/limitwriter" ) // Server is a http.Handler which exposes kubelet functionality over HTTP. @@ -102,7 +107,7 @@ type HostInterface interface { RunInContainer(name string, uid types.UID, container string, cmd []string) ([]byte, error) ExecInContainer(name string, uid types.UID, container string, cmd []string, in io.Reader, out, err io.WriteCloser, tty bool) error AttachContainer(name string, uid types.UID, container string, in io.Reader, out, err io.WriteCloser, tty bool) error - GetKubeletContainerLogs(podFullName, containerName, tail string, follow, previous bool, stdout, stderr io.Writer) error + GetKubeletContainerLogs(podFullName, containerName string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) error ServeLogs(w http.ResponseWriter, req *http.Request) PortForward(name string, uid types.UID, port uint16, stream io.ReadWriteCloser) error StreamingConnectionIdleTimeout() time.Duration @@ -308,6 +313,7 @@ func (s *Server) getContainerLogs(request *restful.Request, response *restful.Re if len(podID) == 0 { // TODO: Why return JSON when the rest return plaintext errors? + // TODO: Why return plaintext errors? response.WriteError(http.StatusBadRequest, fmt.Errorf(`{"message": "Missing podID."}`)) return } @@ -322,9 +328,32 @@ func (s *Server) getContainerLogs(request *restful.Request, response *restful.Re return } - follow, _ := strconv.ParseBool(request.QueryParameter("follow")) - previous, _ := strconv.ParseBool(request.QueryParameter("previous")) - tail := request.QueryParameter("tail") + query := request.Request.URL.Query() + // backwards compatibility for the "tail" query parameter + if tail := request.QueryParameter("tail"); len(tail) > 0 { + query["tailLines"] = []string{tail} + // "all" is the same as omitting tail + if tail == "all" { + delete(query, "tailLines") + } + } + // container logs on the kubelet are locked to v1 + versioned := &v1.PodLogOptions{} + if err := api.Scheme.Convert(&query, versioned); err != nil { + response.WriteError(http.StatusBadRequest, fmt.Errorf(`{"message": "Unable to decode query."}`)) + return + } + out, err := api.Scheme.ConvertToVersion(versioned, "") + if err != nil { + response.WriteError(http.StatusBadRequest, fmt.Errorf(`{"message": "Unable to convert request query."}`)) + return + } + logOptions := out.(*api.PodLogOptions) + logOptions.TypeMeta = unversioned.TypeMeta{} + if errs := validation.ValidatePodLogOptions(logOptions); len(errs) > 0 { + response.WriteError(apierrs.StatusUnprocessableEntity, fmt.Errorf(`{"message": "Invalid request."}`)) + return + } pod, ok := s.host.GetPodByName(podNamespace, podID) if !ok { @@ -348,11 +377,15 @@ func (s *Server) getContainerLogs(request *restful.Request, response *restful.Re return } fw := flushwriter.Wrap(response.ResponseWriter) + if logOptions.LimitBytes != nil { + fw = limitwriter.New(fw, *logOptions.LimitBytes) + } response.Header().Set("Transfer-Encoding", "chunked") response.WriteHeader(http.StatusOK) - err := s.host.GetKubeletContainerLogs(kubecontainer.GetPodFullName(pod), containerName, tail, follow, previous, fw, fw) - if err != nil { - response.WriteError(http.StatusInternalServerError, err) + if err := s.host.GetKubeletContainerLogs(kubecontainer.GetPodFullName(pod), containerName, logOptions, fw, fw); err != nil { + if err != limitwriter.ErrMaximumWrite { + response.WriteError(http.StatusInternalServerError, err) + } return } } diff --git a/pkg/kubelet/server_test.go b/pkg/kubelet/server_test.go index 213b49cbda5..d4e130e9ed4 100644 --- a/pkg/kubelet/server_test.go +++ b/pkg/kubelet/server_test.go @@ -34,6 +34,7 @@ import ( cadvisorApi "github.com/google/cadvisor/info/v1" "k8s.io/kubernetes/pkg/api" + apierrs "k8s.io/kubernetes/pkg/api/errors" kubecontainer "k8s.io/kubernetes/pkg/kubelet/container" "k8s.io/kubernetes/pkg/kubelet/dockertools" "k8s.io/kubernetes/pkg/types" @@ -54,7 +55,7 @@ type fakeKubelet struct { execFunc func(pod string, uid types.UID, container string, cmd []string, in io.Reader, out, err io.WriteCloser, tty bool) error attachFunc func(pod string, uid types.UID, container string, in io.Reader, out, err io.WriteCloser, tty bool) error portForwardFunc func(name string, uid types.UID, port uint16, stream io.ReadWriteCloser) error - containerLogsFunc func(podFullName, containerName, tail string, follow, pervious bool, stdout, stderr io.Writer) error + containerLogsFunc func(podFullName, containerName string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) error streamingConnectionIdleTimeoutFunc func() time.Duration hostnameFunc func() string resyncInterval time.Duration @@ -101,8 +102,8 @@ func (fk *fakeKubelet) ServeLogs(w http.ResponseWriter, req *http.Request) { fk.logFunc(w, req) } -func (fk *fakeKubelet) GetKubeletContainerLogs(podFullName, containerName, tail string, follow, previous bool, stdout, stderr io.Writer) error { - return fk.containerLogsFunc(podFullName, containerName, tail, follow, previous, stdout, stderr) +func (fk *fakeKubelet) GetKubeletContainerLogs(podFullName, containerName string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) error { + return fk.containerLogsFunc(podFullName, containerName, logOptions, stdout, stderr) } func (fk *fakeKubelet) GetHostname() string { @@ -558,22 +559,16 @@ func setPodByNameFunc(fw *serverTestFramework, namespace, pod, container string) } } -func setGetContainerLogsFunc(fw *serverTestFramework, t *testing.T, expectedPodName, expectedContainerName, expectedTail string, expectedFollow, expectedPrevious bool, output string) { - fw.fakeKubelet.containerLogsFunc = func(podFullName, containerName, tail string, follow, previous bool, stdout, stderr io.Writer) error { +func setGetContainerLogsFunc(fw *serverTestFramework, t *testing.T, expectedPodName, expectedContainerName string, expectedLogOptions *api.PodLogOptions, output string) { + fw.fakeKubelet.containerLogsFunc = func(podFullName, containerName string, logOptions *api.PodLogOptions, stdout, stderr io.Writer) error { if podFullName != expectedPodName { t.Errorf("expected %s, got %s", expectedPodName, podFullName) } if containerName != expectedContainerName { t.Errorf("expected %s, got %s", expectedContainerName, containerName) } - if tail != expectedTail { - t.Errorf("expected %s, got %s", expectedTail, tail) - } - if follow != expectedFollow { - t.Errorf("expected %t, got %t", expectedFollow, follow) - } - if previous != expectedPrevious { - t.Errorf("expected %t, got %t", expectedPrevious, previous) + if !reflect.DeepEqual(expectedLogOptions, logOptions) { + t.Errorf("expected %#v, got %#v", expectedLogOptions, logOptions) } io.WriteString(stdout, output) @@ -581,6 +576,7 @@ func setGetContainerLogsFunc(fw *serverTestFramework, t *testing.T, expectedPodN } } +// TODO: I really want to be a table driven test func TestContainerLogs(t *testing.T) { fw := newServerTest() output := "foo bar" @@ -588,11 +584,8 @@ func TestContainerLogs(t *testing.T) { podName := "foo" expectedPodName := getPodName(podName, podNamespace) expectedContainerName := "baz" - expectedTail := "" - expectedFollow := false - expectedPrevious := false setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) - setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, expectedTail, expectedFollow, expectedPrevious, output) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{}, output) resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName) if err != nil { t.Errorf("Got error GETing: %v", err) @@ -609,6 +602,32 @@ func TestContainerLogs(t *testing.T) { } } +func TestContainerLogsWithLimitBytes(t *testing.T) { + fw := newServerTest() + output := "foo bar" + podNamespace := "other" + podName := "foo" + expectedPodName := getPodName(podName, podNamespace) + expectedContainerName := "baz" + bytes := int64(3) + setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{LimitBytes: &bytes}, output) + resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName + "?limitBytes=3") + if err != nil { + t.Errorf("Got error GETing: %v", err) + } + defer resp.Body.Close() + + body, err := ioutil.ReadAll(resp.Body) + if err != nil { + t.Errorf("Error reading container logs: %v", err) + } + result := string(body) + if result != output[:bytes] { + t.Errorf("Expected: '%v', got: '%v'", output[:bytes], result) + } +} + func TestContainerLogsWithTail(t *testing.T) { fw := newServerTest() output := "foo bar" @@ -616,11 +635,35 @@ func TestContainerLogsWithTail(t *testing.T) { podName := "foo" expectedPodName := getPodName(podName, podNamespace) expectedContainerName := "baz" - expectedTail := "5" - expectedFollow := false - expectedPrevious := false + expectedTail := int64(5) setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) - setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, expectedTail, expectedFollow, expectedPrevious, output) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{TailLines: &expectedTail}, output) + resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName + "?tailLines=5") + if err != nil { + t.Errorf("Got error GETing: %v", err) + } + defer resp.Body.Close() + + body, err := ioutil.ReadAll(resp.Body) + if err != nil { + t.Errorf("Error reading container logs: %v", err) + } + result := string(body) + if result != output { + t.Errorf("Expected: '%v', got: '%v'", output, result) + } +} + +func TestContainerLogsWithLegacyTail(t *testing.T) { + fw := newServerTest() + output := "foo bar" + podNamespace := "other" + podName := "foo" + expectedPodName := getPodName(podName, podNamespace) + expectedContainerName := "baz" + expectedTail := int64(5) + setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{TailLines: &expectedTail}, output) resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName + "?tail=5") if err != nil { t.Errorf("Got error GETing: %v", err) @@ -637,6 +680,50 @@ func TestContainerLogsWithTail(t *testing.T) { } } +func TestContainerLogsWithTailAll(t *testing.T) { + fw := newServerTest() + output := "foo bar" + podNamespace := "other" + podName := "foo" + expectedPodName := getPodName(podName, podNamespace) + expectedContainerName := "baz" + setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{}, output) + resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName + "?tail=all") + if err != nil { + t.Errorf("Got error GETing: %v", err) + } + defer resp.Body.Close() + + body, err := ioutil.ReadAll(resp.Body) + if err != nil { + t.Errorf("Error reading container logs: %v", err) + } + result := string(body) + if result != output { + t.Errorf("Expected: '%v', got: '%v'", output, result) + } +} + +func TestContainerLogsWithInvalidTail(t *testing.T) { + fw := newServerTest() + output := "foo bar" + podNamespace := "other" + podName := "foo" + expectedPodName := getPodName(podName, podNamespace) + expectedContainerName := "baz" + setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{}, output) + resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName + "?tail=-1") + if err != nil { + t.Errorf("Got error GETing: %v", err) + } + defer resp.Body.Close() + if resp.StatusCode != apierrs.StatusUnprocessableEntity { + t.Errorf("Unexpected non-error reading container logs: %#v", resp) + } +} + func TestContainerLogsWithFollow(t *testing.T) { fw := newServerTest() output := "foo bar" @@ -644,11 +731,8 @@ func TestContainerLogsWithFollow(t *testing.T) { podName := "foo" expectedPodName := getPodName(podName, podNamespace) expectedContainerName := "baz" - expectedTail := "" - expectedFollow := true - expectedPrevious := false setPodByNameFunc(fw, podNamespace, podName, expectedContainerName) - setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, expectedTail, expectedFollow, expectedPrevious, output) + setGetContainerLogsFunc(fw, t, expectedPodName, expectedContainerName, &api.PodLogOptions{Follow: true}, output) resp, err := http.Get(fw.testHTTPServer.URL + "/containerLogs/" + podNamespace + "/" + podName + "/" + expectedContainerName + "?follow=1") if err != nil { t.Errorf("Got error GETing: %v", err) diff --git a/pkg/registry/pod/etcd/etcd.go b/pkg/registry/pod/etcd/etcd.go index eb48bf7eda7..d00129da444 100644 --- a/pkg/registry/pod/etcd/etcd.go +++ b/pkg/registry/pod/etcd/etcd.go @@ -27,6 +27,7 @@ import ( etcderr "k8s.io/kubernetes/pkg/api/errors/etcd" "k8s.io/kubernetes/pkg/api/rest" "k8s.io/kubernetes/pkg/api/unversioned" + "k8s.io/kubernetes/pkg/api/validation" "k8s.io/kubernetes/pkg/capabilities" client "k8s.io/kubernetes/pkg/client/unversioned" "k8s.io/kubernetes/pkg/fields" @@ -211,6 +212,7 @@ func (r *StatusREST) Update(ctx api.Context, obj runtime.Object) (runtime.Object } // LogREST implements the log endpoint for a Pod +// TODO: move me into pod/rest - I'm generic to store type via ResourceGetter type LogREST struct { store *etcdgeneric.Etcd kubeletConn client.ConnectionInfoGetter @@ -231,6 +233,9 @@ func (r *LogREST) Get(ctx api.Context, name string, opts runtime.Object) (runtim if !ok { return nil, fmt.Errorf("Invalid options object: %#v", opts) } + if errs := validation.ValidatePodLogOptions(logOpts); len(errs) > 0 { + return nil, errors.NewInvalid("podlogs", name, errs) + } location, transport, err := pod.LogLocation(r.store, r.kubeletConn, ctx, name, logOpts) if err != nil { return nil, err @@ -249,6 +254,7 @@ func (r *LogREST) NewGetOptions() (runtime.Object, bool, string) { } // ProxyREST implements the proxy subresource for a Pod +// TODO: move me into pod/rest - I'm generic to store type via ResourceGetter type ProxyREST struct { store *etcdgeneric.Etcd } @@ -291,6 +297,7 @@ func (r *ProxyREST) Connect(ctx api.Context, id string, opts runtime.Object) (re var upgradeableMethods = []string{"GET", "POST"} // AttachREST implements the attach subresource for a Pod +// TODO: move me into pod/rest - I'm generic to store type via ResourceGetter type AttachREST struct { store *etcdgeneric.Etcd kubeletConn client.ConnectionInfoGetter @@ -328,6 +335,7 @@ func (r *AttachREST) ConnectMethods() []string { } // ExecREST implements the exec subresource for a Pod +// TODO: move me into pod/rest - I'm generic to store type via ResourceGetter type ExecREST struct { store *etcdgeneric.Etcd kubeletConn client.ConnectionInfoGetter @@ -365,6 +373,7 @@ func (r *ExecREST) ConnectMethods() []string { } // PortForwardREST implements the portforward subresource for a Pod +// TODO: move me into pod/rest - I'm generic to store type via ResourceGetter type PortForwardREST struct { store *etcdgeneric.Etcd kubeletConn client.ConnectionInfoGetter diff --git a/pkg/registry/pod/etcd/etcd_test.go b/pkg/registry/pod/etcd/etcd_test.go index 7622132eaf6..71038dc4022 100644 --- a/pkg/registry/pod/etcd/etcd_test.go +++ b/pkg/registry/pod/etcd/etcd_test.go @@ -734,3 +734,21 @@ func TestEtcdUpdateStatus(t *testing.T) { t.Errorf("unexpected object: %s", util.ObjectDiff(&expected, podOut)) } } + +func TestPodLogValidates(t *testing.T) { + etcdStorage, _ := registrytest.NewEtcdStorage(t, "") + storage := NewStorage(etcdStorage, false, nil) + + negativeOne := int64(-1) + testCases := []*api.PodLogOptions{ + {SinceSeconds: &negativeOne}, + {TailLines: &negativeOne}, + } + + for _, tc := range testCases { + _, err := storage.Log.Get(api.NewDefaultContext(), "test", tc) + if !errors.IsInvalid(err) { + t.Fatalf("unexpected error: %v", err) + } + } +} diff --git a/pkg/registry/pod/strategy.go b/pkg/registry/pod/strategy.go index 7d4c44f6307..cc721099a52 100644 --- a/pkg/registry/pod/strategy.go +++ b/pkg/registry/pod/strategy.go @@ -21,6 +21,8 @@ import ( "net" "net/http" "net/url" + "strconv" + "time" "k8s.io/kubernetes/pkg/api" "k8s.io/kubernetes/pkg/api/errors" @@ -253,6 +255,21 @@ func LogLocation(getter ResourceGetter, connInfo client.ConnectionInfoGetter, ct if opts.Previous { params.Add("previous", "true") } + if opts.Timestamps { + params.Add("timestamps", "true") + } + if opts.SinceSeconds != nil { + params.Add("sinceSeconds", strconv.FormatInt(*opts.SinceSeconds, 10)) + } + if opts.SinceTime != nil { + params.Add("sinceTime", opts.SinceTime.Format(time.RFC3339)) + } + if opts.TailLines != nil { + params.Add("tailLines", strconv.FormatInt(*opts.TailLines, 10)) + } + if opts.LimitBytes != nil { + params.Add("limitBytes", strconv.FormatInt(*opts.LimitBytes, 10)) + } loc := &url.URL{ Scheme: nodeScheme, Host: fmt.Sprintf("%s:%d", nodeHost, nodePort), diff --git a/pkg/util/limitwriter/doc.go b/pkg/util/limitwriter/doc.go new file mode 100644 index 00000000000..7daff9c079a --- /dev/null +++ b/pkg/util/limitwriter/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2015 The Kubernetes Authors All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package limitwriter provides a writer that only allows a certain number of bytes to be +// written. +package limitwriter diff --git a/pkg/util/limitwriter/limitwriter.go b/pkg/util/limitwriter/limitwriter.go new file mode 100644 index 00000000000..88890a9fa24 --- /dev/null +++ b/pkg/util/limitwriter/limitwriter.go @@ -0,0 +1,53 @@ +/* +Copyright 2015 The Kubernetes Authors All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package limitwriter + +import ( + "errors" + "io" +) + +// New creates a writer that is limited to writing at most n bytes to w. This writer is not +// thread safe. +func New(w io.Writer, n int64) io.Writer { + return &limitWriter{ + w: w, + n: n, + } +} + +// ErrMaximumWrite is returned when all bytes have been written. +var ErrMaximumWrite = errors.New("maximum write") + +type limitWriter struct { + w io.Writer + n int64 +} + +func (w *limitWriter) Write(p []byte) (n int, err error) { + if int64(len(p)) > w.n { + p = p[:w.n] + } + if len(p) > 0 { + n, err = w.w.Write(p) + w.n -= int64(n) + } + if w.n == 0 { + err = ErrMaximumWrite + } + return +} diff --git a/test/e2e/kubectl.go b/test/e2e/kubectl.go index 4ab198f463c..82fe45e62be 100644 --- a/test/e2e/kubectl.go +++ b/test/e2e/kubectl.go @@ -464,18 +464,57 @@ var _ = Describe("Kubectl client", func() { }) Describe("Kubectl logs", func() { - It("should find a string in pod logs", func() { + var rcPath string + var nsFlag string + containerName := "redis-master" + BeforeEach(func() { mkpath := func(file string) string { return filepath.Join(testContext.RepoRoot, "examples/guestbook-go", file) } - controllerJson := mkpath("redis-master-controller.json") - nsFlag := fmt.Sprintf("--namespace=%v", ns) - By("creating Redis RC") - runKubectl("create", "-f", controllerJson, nsFlag) - By("checking logs") + rcPath = mkpath("redis-master-controller.json") + By("creating an rc") + nsFlag = fmt.Sprintf("--namespace=%v", ns) + runKubectl("create", "-f", rcPath, nsFlag) + }) + AfterEach(func() { + cleanup(rcPath, ns, simplePodSelector) + }) + + It("should be able to retrieve and filter logs", func() { forEachPod(c, ns, "app", "redis", func(pod api.Pod) { - _, err := lookForStringInLog(ns, pod.Name, "redis-master", "The server is now ready to accept connections", podStartTimeout) + By("checking for a matching strings") + _, err := lookForStringInLog(ns, pod.Name, containerName, "The server is now ready to accept connections", podStartTimeout) Expect(err).NotTo(HaveOccurred()) + + By("limiting log lines") + out := runKubectl("log", pod.Name, containerName, nsFlag, "--tail=1") + Expect(len(out)).NotTo(BeZero()) + Expect(len(strings.Split(out, "\n"))).To(Equal(1)) + + By("limiting log bytes") + out = runKubectl("log", pod.Name, containerName, nsFlag, "--limit-bytes=1") + Expect(len(strings.Split(out, "\n"))).To(Equal(1)) + Expect(len(out)).To(Equal(1)) + + By("exposing timestamps") + out = runKubectl("log", pod.Name, containerName, nsFlag, "--tail=1", "--timestamps") + lines := strings.Split(out, "\n") + Expect(len(lines)).To(Equal(1)) + words := strings.Split(lines[0], " ") + Expect(len(words)).To(BeNumerically(">", 1)) + if _, err := time.Parse(time.RFC3339Nano, words[0]); err != nil { + if _, err := time.Parse(time.RFC3339, words[0]); err != nil { + Failf("expected %q to be RFC3339 or RFC3339Nano", words[0]) + } + } + + By("restricting to a time range") + time.Sleep(1500 * time.Millisecond) // ensure that startup logs on the node are seen as older than 1s + out = runKubectl("log", pod.Name, containerName, nsFlag, "--since=1s") + recent := len(strings.Split(out, "\n")) + out = runKubectl("log", pod.Name, containerName, nsFlag, "--since=24h") + older := len(strings.Split(out, "\n")) + Expect(recent).To(BeNumerically("<", older)) }) }) })