args

Documentation

Index

• Constants
• type Arguments
  • func Parse() Arguments
  • func (a Arguments) Equals(other Arguments) bool
  • func (a *Arguments) Validate() []ValidationError
• type ValidationError
  • func (ve *ValidationError) Error() string

Constants

const OperationKeyValidation = "Validation"

OperationKeyValidation represents the key for the Operation field of an ValidationError

Types

type Arguments

type Arguments struct {
	CPU       bool   `short:"c" long:"cpu" description:"Include the total CPU consumption"`
	Mem       bool   `short:"m" long:"mem" description:"Include the total RAM consumption"`
	Disk      bool   `short:"d" long:"disk" description:"Include the total CPU consumption"`
	Processes bool   `short:"p" long:"proc" description:"Include the top 10 processes"`
	Health    string `long:"health" description:"Make a healthcheck call against the URI"`
	// contains filtered or unexported fields
}

Arguments represent the flags given at program start.

func Parse

func Parse() Arguments

Parse the flags to the Arguments struct.

func (Arguments) Equals

func (a Arguments) Equals(other Arguments) bool

Equals checks for field equality

func (*Arguments) Validate

func (a *Arguments) Validate() []ValidationError

Validate the arguments.

type ValidationError

type ValidationError struct {
	e.BaseError
	Arguments
}

ValidationError is a struct to wrap the error with more information.

func (*ValidationError) Error

func (ve *ValidationError) Error() string