cmdutil

Documentation

Overview

Package cmdutil contains utility methods that are useful for command-line programs.

Index

• Constants
• Variables
• func Err(a ...zero.Interface) (n int, err error)
• func Errf(format string, a ...zero.Interface) (n int, err error)
• func Errln(a ...zero.Interface) (n int, err error)
• func Fatal(a ...zero.Interface)
• func Fatalf(format string, a ...zero.Interface)
• func Fatalln(a ...zero.Interface)
• func Must(err error)
• func NewLogger(opts ...LogrusOption) *logrus.Entry
• func NewRaven(opts ...RavenOption) *raven.Client
• type LogrusConfig
• type LogrusOption
  • func WithLogrusSentryHook(rc *raven.Client) LogrusOption
• type RavenConfig
• type RavenOption
  • func WithRavenRelease(release string) RavenOption

Constants

const (
	EnvLogrusLevel  = "LOGRUS_LEVEL"
	EnvLogrusFormat = "LOGRUS_FORMAT"
)

Logrus-related environment keys.

const (
	LogrusFormatJSON = "json"
	LogrusFormatText = "text"
)

Valid environment values for the key EnvLogrusFormat.

const (
	EnvSentryDSN = "SENTRY_DSN"
)

Raven and Sentry-related environment variables.

Variables

var FatalExitCode = 1

FatalExitCode is the exit code that all Fatal* methods exit with after printing.

Functions

func Err

func Err(a ...zero.Interface) (n int, err error)

Err is like fmt.Print, but writes to standard error.

func Errf

func Errf(format string, a ...zero.Interface) (n int, err error)

Errf is like fmt.Printf, but writes to standard error.

func Errln

func Errln(a ...zero.Interface) (n int, err error)

Errln is like fmt.Println, but writes to standard error.

func Fatal

func Fatal(a ...zero.Interface)

Fatal is like Err, but exits with an error code after printing.

func Fatalf

func Fatalf(format string, a ...zero.Interface)

Fatalf is like Errf, but exits with an error code after printing.

func Fatalln

func Fatalln(a ...zero.Interface)

Fatalln is like Errln, but exits with an error code after printing.

func Must

func Must(err error)

Must panics if err is not nil.

It is used to wrap side-effect-inducing function calls that return an error.

func NewLogger

func NewLogger(opts ...LogrusOption) *logrus.Entry

NewLogger creates an application-level logrus.Entry.

func NewRaven

func NewRaven(opts ...RavenOption) *raven.Client

NewRaven creates a new raven.Client.

Types

type LogrusConfig

type LogrusConfig struct {
	// Logging-related options.
	Output        io.Writer
	TextFormatter logrus.TextFormatter
	JSONFormatter logrus.JSONFormatter

	// Extensions-related options.
	Raven *raven.Client
}

A LogrusConfig configures a logrus.Logger.

type LogrusOption

type LogrusOption func(*LogrusConfig)

A LogrusOption modifies a LogrusConfig.

func WithLogrusSentryHook

func WithLogrusSentryHook(rc *raven.Client) LogrusOption

WithLogrusSentryHook adds a Sentry reporting hook to a logrus.Logger.

type RavenConfig

type RavenConfig struct {
	Release string
}

RavenConfig configures a raven.Client.

type RavenOption

type RavenOption func(*RavenConfig)

A RavenOption modifies a RavenConfig.

func WithRavenRelease

func WithRavenRelease(release string) RavenOption

WithRavenRelease sets the release tag for a raven.Client.