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 InitSentry(opts ...SentryOption)
• func Must(err error)
• func NewLogger(opts ...LogrusOption) *logrus.Entry
• func NewRaven(opts ...SentryOption) *raven.Client
• func NewSentry(opts ...SentryOption) *sentry.Client
• type LogrusConfig
• type LogrusOption
  • func WithSentryHook(rc *raven.Client) LogrusOption
• type SentryConfig
• type SentryOption
  • func WithRelease(release string) SentryOption

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 InitSentry

func InitSentry(opts ...SentryOption)

InitSentry initializes the current sentry.Hub.

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 ...SentryOption) *raven.Client

NewRaven creates a new raven.Client.

func NewSentry

func NewSentry(opts ...SentryOption) *sentry.Client

NewSentry creates a new sentry.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 WithSentryHook

func WithSentryHook(rc *raven.Client) LogrusOption

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

type SentryConfig

type SentryConfig struct {
	Release string
}

SentryConfig configures a raven.Client.

type SentryOption

type SentryOption func(*SentryConfig)

A SentryOption modifies a RavenConfig.

func WithRelease

func WithRelease(release string) SentryOption

WithRelease sets the release tag for a sentry.Client.