|
| 1 | +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package cli |
| 5 | + |
| 6 | +import ( |
| 7 | + "errors" |
| 8 | + "fmt" |
| 9 | + |
| 10 | + "github.com/aws/aws-sdk-go/aws" |
| 11 | + "github.com/aws/copilot-cli/internal/pkg/aws/sessions" |
| 12 | + "github.com/aws/copilot-cli/internal/pkg/config" |
| 13 | + "github.com/aws/copilot-cli/internal/pkg/deploy" |
| 14 | + "github.com/aws/copilot-cli/internal/pkg/logging" |
| 15 | + "github.com/aws/copilot-cli/internal/pkg/term/log" |
| 16 | + "github.com/aws/copilot-cli/internal/pkg/term/prompt" |
| 17 | + "github.com/aws/copilot-cli/internal/pkg/term/selector" |
| 18 | + "github.com/spf13/cobra" |
| 19 | +) |
| 20 | + |
| 21 | +const ( |
| 22 | + jobAppNamePrompt = "Which application does your job belong to?" |
| 23 | +) |
| 24 | + |
| 25 | +type jobLogsVars struct { |
| 26 | + wkldLogsVars |
| 27 | + |
| 28 | + includeStateMachineLogs bool // Whether to include the logs from the state machine log streams |
| 29 | +} |
| 30 | + |
| 31 | +type jobLogsOpts struct { |
| 32 | + jobLogsVars |
| 33 | + |
| 34 | + wkldLogOpts |
| 35 | +} |
| 36 | + |
| 37 | +func newJobLogOpts(vars jobLogsVars) (*jobLogsOpts, error) { |
| 38 | + configStore, err := config.NewStore() |
| 39 | + if err != nil { |
| 40 | + return nil, fmt.Errorf("connect to environment config store: %w", err) |
| 41 | + } |
| 42 | + deployStore, err := deploy.NewStore(configStore) |
| 43 | + if err != nil { |
| 44 | + return nil, fmt.Errorf("connect to deploy store: %w", err) |
| 45 | + } |
| 46 | + opts := &jobLogsOpts{ |
| 47 | + jobLogsVars: vars, |
| 48 | + wkldLogOpts: wkldLogOpts{ |
| 49 | + w: log.OutputWriter, |
| 50 | + configStore: configStore, |
| 51 | + deployStore: deployStore, |
| 52 | + sel: selector.NewDeploySelect(prompt.New(), configStore, deployStore), |
| 53 | + }, |
| 54 | + } |
| 55 | + opts.initLogsSvc = func() error { |
| 56 | + env, err := opts.configStore.GetEnvironment(opts.appName, opts.envName) |
| 57 | + if err != nil { |
| 58 | + return fmt.Errorf("get environment: %w", err) |
| 59 | + } |
| 60 | + sess, err := sessions.NewProvider().FromRole(env.ManagerRoleARN, env.Region) |
| 61 | + if err != nil { |
| 62 | + return err |
| 63 | + } |
| 64 | + opts.logsSvc, err = logging.NewServiceClient(&logging.NewServiceLogsConfig{ |
| 65 | + Sess: sess, |
| 66 | + App: opts.appName, |
| 67 | + Env: opts.envName, |
| 68 | + Svc: opts.name, |
| 69 | + }) |
| 70 | + if err != nil { |
| 71 | + return err |
| 72 | + } |
| 73 | + return nil |
| 74 | + } |
| 75 | + return opts, nil |
| 76 | +} |
| 77 | + |
| 78 | +// Validate returns an error if the values provided by flags are invalid. |
| 79 | +func (o *jobLogsOpts) Validate() error { |
| 80 | + if o.appName != "" { |
| 81 | + _, err := o.configStore.GetApplication(o.appName) |
| 82 | + if err != nil { |
| 83 | + return err |
| 84 | + } |
| 85 | + } |
| 86 | + |
| 87 | + if o.since != 0 && o.humanStartTime != "" { |
| 88 | + return errors.New("only one of --since or --start-time may be used") |
| 89 | + } |
| 90 | + |
| 91 | + if o.humanEndTime != "" && o.follow { |
| 92 | + return errors.New("only one of --follow or --end-time may be used") |
| 93 | + } |
| 94 | + |
| 95 | + if o.since != 0 { |
| 96 | + if o.since < 0 { |
| 97 | + return fmt.Errorf("--since must be greater than 0") |
| 98 | + } |
| 99 | + // round up to the nearest second |
| 100 | + o.startTime = parseSince(o.since) |
| 101 | + } |
| 102 | + |
| 103 | + if o.humanStartTime != "" { |
| 104 | + startTime, err := parseRFC3339(o.humanStartTime) |
| 105 | + if err != nil { |
| 106 | + return fmt.Errorf(`invalid argument %s for "--start-time" flag: %w`, o.humanStartTime, err) |
| 107 | + } |
| 108 | + o.startTime = aws.Int64(startTime) |
| 109 | + } |
| 110 | + |
| 111 | + if o.humanEndTime != "" { |
| 112 | + endTime, err := parseRFC3339(o.humanEndTime) |
| 113 | + if err != nil { |
| 114 | + return fmt.Errorf(`invalid argument %s for "--end-time" flag: %w`, o.humanEndTime, err) |
| 115 | + } |
| 116 | + o.endTime = aws.Int64(endTime) |
| 117 | + } |
| 118 | + |
| 119 | + if o.limit != 0 && (o.limit < cwGetLogEventsLimitMin || o.limit > cwGetLogEventsLimitMax) { |
| 120 | + return fmt.Errorf("--limit %d is out-of-bounds, value must be between %d and %d", o.limit, cwGetLogEventsLimitMin, cwGetLogEventsLimitMax) |
| 121 | + } |
| 122 | + |
| 123 | + return nil |
| 124 | +} |
| 125 | + |
| 126 | +// Ask asks for fields that are required but not passed in. |
| 127 | +func (o *jobLogsOpts) Ask() error { |
| 128 | + if err := o.askApp(); err != nil { |
| 129 | + return err |
| 130 | + } |
| 131 | + return nil |
| 132 | +} |
| 133 | + |
| 134 | +func (o *jobLogsOpts) askApp() error { |
| 135 | + if o.appName != "" { |
| 136 | + return nil |
| 137 | + } |
| 138 | + app, err := o.sel.Application(jobAppNamePrompt, svcAppNameHelpPrompt) |
| 139 | + if err != nil { |
| 140 | + return fmt.Errorf("select application: %w", err) |
| 141 | + } |
| 142 | + o.appName = app |
| 143 | + return nil |
| 144 | +} |
| 145 | + |
| 146 | +// Execute outputs logs of the job. |
| 147 | +func (o *jobLogsOpts) Execute() error { |
| 148 | + return nil |
| 149 | +} |
| 150 | + |
| 151 | +// buildJobLogsCmd builds the command for displaying job logs in an application. |
| 152 | +func buildJobLogsCmd() *cobra.Command { |
| 153 | + vars := jobLogsVars{} |
| 154 | + cmd := &cobra.Command{ |
| 155 | + Use: "logs", |
| 156 | + Short: "Displays logs of a deployed job.", |
| 157 | + Hidden: true, |
| 158 | + Example: ` |
| 159 | + Displays logs of the job "my-job" in environment "test". |
| 160 | + /code $ copilot job logs -n my-job -e test |
| 161 | + Displays logs in the last hour. |
| 162 | + /code $ copilot job logs --since 1h |
| 163 | + Displays logs from 2006-01-02T15:04:05 to 2006-01-02T15:05:05. |
| 164 | + /code $ copilot job logs --start-time 2006-01-02T15:04:05+00:00 --end-time 2006-01-02T15:05:05+00:00 |
| 165 | +Displays logs from specific task IDs. |
| 166 | + /code $ copilot job logs --tasks 709c7eae05f947f6861b150372ddc443,1de57fd63c6a4920ac416d02add891b9 |
| 167 | + Displays logs in real time. |
| 168 | + /code $ copilot job logs --follow |
| 169 | + Displays container logs and state machine execution logs from the last execution. |
| 170 | + /code $ copilot job logs --include-state-machine`, |
| 171 | + RunE: runCmdE(func(cmd *cobra.Command, args []string) error { |
| 172 | + opts, err := newJobLogOpts(vars) |
| 173 | + if err != nil { |
| 174 | + return err |
| 175 | + } |
| 176 | + if err := opts.Validate(); err != nil { |
| 177 | + return err |
| 178 | + } |
| 179 | + if err := opts.Ask(); err != nil { |
| 180 | + return err |
| 181 | + } |
| 182 | + return opts.Execute() |
| 183 | + }), |
| 184 | + } |
| 185 | + cmd.Flags().StringVarP(&vars.name, nameFlag, nameFlagShort, "", svcFlagDescription) |
| 186 | + cmd.Flags().StringVarP(&vars.envName, envFlag, envFlagShort, "", envFlagDescription) |
| 187 | + cmd.Flags().StringVarP(&vars.appName, appFlag, appFlagShort, tryReadingAppName(), appFlagDescription) |
| 188 | + cmd.Flags().StringVar(&vars.humanStartTime, startTimeFlag, "", startTimeFlagDescription) |
| 189 | + cmd.Flags().StringVar(&vars.humanEndTime, endTimeFlag, "", endTimeFlagDescription) |
| 190 | + cmd.Flags().BoolVar(&vars.shouldOutputJSON, jsonFlag, false, jsonFlagDescription) |
| 191 | + cmd.Flags().BoolVar(&vars.follow, followFlag, false, followFlagDescription) |
| 192 | + cmd.Flags().DurationVar(&vars.since, sinceFlag, 0, sinceFlagDescription) |
| 193 | + cmd.Flags().IntVar(&vars.limit, limitFlag, 0, limitFlagDescription) |
| 194 | + cmd.Flags().StringSliceVar(&vars.taskIDs, tasksFlag, nil, tasksLogsFlagDescription) |
| 195 | + cmd.Flags().BoolVar(&vars.includeStateMachineLogs, includeStateMachineLogsFlag, false, includeStateMachineLogsFlagDescription) |
| 196 | + return cmd |
| 197 | +} |
0 commit comments