logs

Documentation

Overview

Example (Logs_help)

package main

import (
	"os"

	"github.com/aws-cloudformation/rain/internal/cmd/logs"
)

func main() {
	os.Args = []string{
		os.Args[0],
		"--help",
	}

	logs.Cmd.Execute()
}

Output:

Shows the event log for a stack and its nested stack. Optionally, filter by a specific resource by name.

By default, only show log entries that contain a useful message (e.g. a failure message).
You can use the --all flag to change this behaviour.

Usage:
  logs <stack> (<resource>)

Aliases:
  logs, log

Flags:
  -a, --all    include uninteresting logs
  -h, --help   help for logs

Index

• Variables

Examples

• Package (Logs_help)

Variables

var Cmd = &cobra.Command{
	Use:   "logs <stack> (<resource>)",
	Short: "Show the event log for the named stack",
	Long: `Shows the event log for a stack and its nested stack. Optionally, filter by a specific resource by name.

By default, only show log entries that contain a useful message (e.g. a failure message).
You can use the --all flag to change this behaviour.`,
	Args:                  cobra.RangeArgs(1, 2),
	Aliases:               []string{"log"},
	DisableFlagsInUseLine: true,
	Run: func(cmd *cobra.Command, args []string) {
		stackName := args[0]
		resourceName := ""
		if len(args) > 1 {
			resourceName = args[1]
		}

		logs, err := getLogs(stackName, resourceName)
		if err != nil {
			panic(ui.Errorf(err, "failed to get logs for stack '%s'", stackName))
		}

		if len(logs) == 0 {
			if allLogs {
				fmt.Println("No interesting log messages to display.")
			} else {
				fmt.Println("No interesting log messages to display. To see everything, use the --all flag")
			}
		} else {
			printLogs(logs)
		}
	},
}

Cmd is the logs command's entrypoint