model

Documentation

Index

• Constants
• func Between(min int, max int) int
• func InboxName(length int) (name string, err error)
• func NewLogger(out io.Writer, level log.Level) (logger *log.Logger)
• func TakeRandom(input []string, perc float64) (output []string)
• type ConfigDuration
  • func (d *ConfigDuration) UnmarshalJSON(b []byte) (err error)
• type ConfigLogLevel
  • func (d *ConfigLogLevel) UnmarshalJSON(b []byte) (err error)
• type UTCFormatter
  • func (u UTCFormatter) Format(e *log.Entry) ([]byte, error)

Constants

const (
	// InboxMinLength is the minimum size (in bytes) of an inbox
	InboxMinLength = 10

	// InboxMaxLength is the maximum size (in bytes) of an inbox
	InboxMaxLength = 20
)

Functions

func Between

func Between(min int, max int) int

Between returns a number between min and max inclusively.

func InboxName

func InboxName(length int) (name string, err error)

InboxName generates a cryptographically-secure random string which can be used as an inbox for orchestrators and agents during communication.

func NewLogger

func NewLogger(out io.Writer, level log.Level) (logger *log.Logger)

NewLogger returns a pointer to a new logrus logger with all sensible defaults configured.

func TakeRandom

func TakeRandom(input []string, perc float64) (output []string)

TakeRandom takes a random percentage of strings from a slice of strings, guaranteeing that each item will appear only once.

Types

type ConfigDuration

type ConfigDuration struct {
	time.Duration
}

ConfigDuration allows for the configuration of durations in the form of "5m30s", as opposed to the default Unix epoch timestamp.

func (*ConfigDuration) UnmarshalJSON

func (d *ConfigDuration) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals a ConfigDuration from JSON.

type ConfigLogLevel

type ConfigLogLevel struct {
	logrus.Level
}

ConfigLogLevel allows for the configuration of logrus log levels in the form of "debug", as opposed to the default numeric representation

func (*ConfigLogLevel) UnmarshalJSON

func (d *ConfigLogLevel) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals a ConfigLogLevel from JSON.

type UTCFormatter

type UTCFormatter struct {
	log.Formatter
}

UTCFormatter formats logrus timestamps in UTC format rather than the default local format.

func (UTCFormatter) Format

func (u UTCFormatter) Format(e *log.Entry) ([]byte, error)

Format takes a local timestamp and converts it to UTC.