aboutsummaryrefslogtreecommitdiffstats
path: root/client/go/internal/cli/cmd/log.go
blob: 77ef7f68130626dcf45662ad6718860fac0225cc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package cmd

import (
	"fmt"
	"time"

	"github.com/spf13/cobra"
	"github.com/vespa-engine/vespa/client/go/internal/vespa"
)

func newLogCmd(cli *CLI) *cobra.Command {
	var (
		fromArg    string
		toArg      string
		levelArg   string
		followArg  bool
		dequoteArg bool
	)
	cmd := &cobra.Command{
		Use:   "log [relative-period]",
		Short: "Show the Vespa log",
		Long: `Show the Vespa log.

The logs shown can be limited to a relative or fixed period. All timestamps are shown in UTC.

Logs for the past hour are shown if no arguments are given.
`,
		Example: `$ vespa log 1h
$ vespa log --nldequote=false 10m
$ vespa log --from 2021-08-25T15:00:00Z --to 2021-08-26T02:00:00Z
$ vespa log --follow`,
		DisableAutoGenTag: true,
		SilenceUsage:      true,
		Args:              cobra.MaximumNArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			target, err := cli.target(targetOptions{logLevel: levelArg, supportedType: cloudTargetOnly})
			if err != nil {
				return err
			}
			options := vespa.LogOptions{
				Level:   vespa.LogLevel(levelArg),
				Follow:  followArg,
				Writer:  cli.Stdout,
				Dequote: dequoteArg,
			}
			if options.Follow {
				if fromArg != "" || toArg != "" || len(args) > 0 {
					return fmt.Errorf("cannot combine --from/--to or relative time with --follow")
				}
				options.From = time.Now().Add(-5 * time.Minute)
			} else {
				from, to, err := parsePeriod(fromArg, toArg, args)
				if err != nil {
					return fmt.Errorf("invalid period: %w", err)
				}
				options.From = from
				options.To = to
			}
			if err := target.PrintLog(options); err != nil {
				return fmt.Errorf("could not retrieve logs: %w", err)
			}
			return nil
		},
	}
	cmd.Flags().StringVarP(&fromArg, "from", "F", "", "Include logs since this timestamp (RFC3339 format)")
	cmd.Flags().StringVarP(&toArg, "to", "T", "", "Include logs until this timestamp (RFC3339 format)")
	cmd.Flags().StringVarP(&levelArg, "level", "l", "debug", `The maximum log level to show. Must be "error", "warning", "info" or "debug"`)
	cmd.Flags().BoolVarP(&followArg, "follow", "f", false, "Follow logs")
	cmd.Flags().BoolVarP(&dequoteArg, "nldequote", "n", true, "Dequote LF and TAB characters in log messages")
	return cmd
}

func parsePeriod(from, to string, args []string) (time.Time, time.Time, error) {
	relativePeriod := from == "" || to == ""
	if relativePeriod {
		period := "1h"
		if len(args) > 0 {
			period = args[0]
		}
		d, err := time.ParseDuration(period)
		if err != nil {
			return time.Time{}, time.Time{}, err
		}
		if d > 0 {
			d = -d
		}
		to := time.Now()
		from := to.Add(d)
		return from, to, nil
	} else if len(args) > 0 {
		return time.Time{}, time.Time{}, fmt.Errorf("cannot combine --from/--to with relative value: %s", args[0])
	}
	t1, err := time.Parse(time.RFC3339, from)
	if err != nil {
		return time.Time{}, time.Time{}, err
	}
	t2, err := time.Parse(time.RFC3339, to)
	if err != nil {
		return time.Time{}, time.Time{}, err
	}
	if !t2.After(t1) {
		return time.Time{}, time.Time{}, fmt.Errorf("--to must specify a time after --from")
	}
	return t1, t2, nil
}