* Revert "Use test helper. (#1977)"
This reverts commit e498cab239
.
* Avoid duplicate newlines
Ensure that we print exactly one trailing newline per log entry.
204 lines
6.2 KiB
Go
204 lines
6.2 KiB
Go
// Copyright 2016-2018, Pulumi Corporation.
|
|
//
|
|
// 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 cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
mobytime "github.com/docker/docker/api/types/time"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/pulumi/pulumi/pkg/backend/display"
|
|
"github.com/pulumi/pulumi/pkg/diag/colors"
|
|
"github.com/pulumi/pulumi/pkg/operations"
|
|
"github.com/pulumi/pulumi/pkg/util/cmdutil"
|
|
)
|
|
|
|
// We use RFC 5424 timestamps with millisecond precision for displaying time stamps on log entries. Go does not
|
|
// pre-define a format string for this format, though it is similar to time.RFC3339Nano.
|
|
//
|
|
// See https://tools.ietf.org/html/rfc5424#section-6.2.3.
|
|
const timeFormat = "2006-01-02T15:04:05.000Z07:00"
|
|
|
|
func newLogsCmd() *cobra.Command {
|
|
var stack string
|
|
var follow bool
|
|
var since string
|
|
var resource string
|
|
var jsonOut bool
|
|
|
|
logsCmd := &cobra.Command{
|
|
Use: "logs",
|
|
Short: "[PREVIEW] Show aggregated logs for a stack",
|
|
Args: cmdutil.NoArgs,
|
|
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
|
|
opts := display.Options{
|
|
Color: cmdutil.GetGlobalColorization(),
|
|
}
|
|
|
|
s, err := requireStack(stack, false, opts, true /*setCurrent*/)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
sm, err := getStackSecretsManager(s)
|
|
if err != nil {
|
|
return errors.Wrap(err, "getting secrets manager")
|
|
}
|
|
|
|
cfg, err := getStackConfiguration(s, sm)
|
|
if err != nil {
|
|
return errors.Wrap(err, "getting stack configuration")
|
|
}
|
|
|
|
startTime, err := parseSince(since, time.Now())
|
|
if err != nil {
|
|
return errors.Wrapf(err, "failed to parse argument to '--since' as duration or timestamp")
|
|
}
|
|
var resourceFilter *operations.ResourceFilter
|
|
if resource != "" {
|
|
var rf = operations.ResourceFilter(resource)
|
|
resourceFilter = &rf
|
|
}
|
|
|
|
if !jsonOut {
|
|
fmt.Printf(
|
|
opts.Color.Colorize(colors.BrightMagenta+"Collecting logs for stack %s since %s.\n\n"+colors.Reset),
|
|
s.Ref().String(),
|
|
startTime.Format(timeFormat),
|
|
)
|
|
}
|
|
|
|
// IDEA: This map will grow forever as new log entries are found. We may need to do a more approximate
|
|
// approach here to ensure we don't grow memory unboundedly while following logs.
|
|
//
|
|
// Note: Just tracking latest log date is not sufficient - as stale logs may show up which should have been
|
|
// displayed before previously rendered log entries, but weren't available at the time, so still need to be
|
|
// rendered now even though they are technically out of order.
|
|
shown := map[operations.LogEntry]bool{}
|
|
for {
|
|
logs, err := s.GetLogs(commandContext(), cfg, operations.LogQuery{
|
|
StartTime: startTime,
|
|
ResourceFilter: resourceFilter,
|
|
})
|
|
if err != nil {
|
|
return errors.Wrapf(err, "failed to get logs")
|
|
}
|
|
|
|
// When we are emitting a fixed number of log entries, and outputing JSON, wrap them in an array.
|
|
if !follow && jsonOut {
|
|
entries := make([]logEntryJSON, 0, len(logs))
|
|
|
|
for _, logEntry := range logs {
|
|
if _, shownAlready := shown[logEntry]; !shownAlready {
|
|
eventTime := time.Unix(0, logEntry.Timestamp*1000000)
|
|
|
|
entries = append(entries, logEntryJSON{
|
|
ID: logEntry.ID,
|
|
Timestamp: eventTime.UTC().Format(timeFormat),
|
|
Message: logEntry.Message,
|
|
})
|
|
|
|
shown[logEntry] = true
|
|
}
|
|
}
|
|
|
|
return printJSON(entries)
|
|
}
|
|
|
|
for _, logEntry := range logs {
|
|
if _, shownAlready := shown[logEntry]; !shownAlready {
|
|
eventTime := time.Unix(0, logEntry.Timestamp*1000000)
|
|
|
|
if !jsonOut {
|
|
fmt.Printf(
|
|
"%30.30s[%30.30s] %v\n",
|
|
eventTime.Format(timeFormat),
|
|
logEntry.ID,
|
|
strings.TrimRight(logEntry.Message, "\n"),
|
|
)
|
|
} else {
|
|
err = printJSON(logEntryJSON{
|
|
ID: logEntry.ID,
|
|
Timestamp: eventTime.UTC().Format(timeFormat),
|
|
Message: logEntry.Message,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
shown[logEntry] = true
|
|
}
|
|
}
|
|
|
|
if !follow {
|
|
return nil
|
|
}
|
|
|
|
time.Sleep(time.Second)
|
|
}
|
|
}),
|
|
}
|
|
|
|
logsCmd.PersistentFlags().StringVarP(
|
|
&stack, "stack", "s", "",
|
|
"The name of the stack to operate on. Defaults to the current stack")
|
|
logsCmd.PersistentFlags().StringVar(
|
|
&stackConfigFile, "config-file", "",
|
|
"Use the configuration values in the specified file rather than detecting the file name")
|
|
logsCmd.PersistentFlags().BoolVarP(
|
|
&jsonOut, "json", "j", false, "Emit output as JSON")
|
|
logsCmd.PersistentFlags().BoolVarP(
|
|
&follow, "follow", "f", false,
|
|
"Follow the log stream in real time (like tail -f)")
|
|
logsCmd.PersistentFlags().StringVar(
|
|
&since, "since", "1h",
|
|
"Only return logs newer than a relative duration ('5s', '2m', '3h') or absolute timestamp. "+
|
|
"Defaults to returning the last 1 hour of logs.")
|
|
logsCmd.PersistentFlags().StringVarP(
|
|
&resource, "resource", "r", "",
|
|
"Only return logs for the requested resource ('name', 'type::name' or full URN). Defaults to returning all logs.")
|
|
|
|
return logsCmd
|
|
}
|
|
|
|
func parseSince(since string, reference time.Time) (*time.Time, error) {
|
|
startTimestamp, err := mobytime.GetTimestamp(since, reference)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
startTimeSec, startTimeNs, err := mobytime.ParseTimestamps(startTimestamp, 0)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if startTimeSec == 0 && startTimeNs == 0 {
|
|
return nil, nil
|
|
}
|
|
startTime := time.Unix(startTimeSec, startTimeNs)
|
|
return &startTime, nil
|
|
}
|
|
|
|
// logEntryJSON is the shape of the --json output of this command. When --json is passed, if we are not following the
|
|
// log stream, we print an array of logEntry objects. If we are following the log stream, we instead print each object
|
|
// at top level.
|
|
type logEntryJSON struct {
|
|
ID string
|
|
Timestamp string
|
|
Message string
|
|
}
|