app

Documentation

Index

• func NewLogger(lvl zerolog.Level) zerolog.Logger
• type Application
  • func NewApplication(envName EnvName, datastorer datastore.Datastorer, logger zerolog.Logger) *Application
  • func NewMockedApplication(envName EnvName, datastorer datastore.Datastorer, logger zerolog.Logger) *Application
• type EnvName
  • func (n EnvName) String() string
• type GCPSeverityHook
  • func (h GCPSeverityHook) Run(e *zerolog.Event, level zerolog.Level, msg string)

Functions

func NewLogger

func NewLogger(lvl zerolog.Level) zerolog.Logger

NewLogger sets up the zerolog.Logger

Types

type Application

type Application struct {
	// Environment Name
	EnvName EnvName
	// Mock denotes whether or not the app is being "mocked" and
	// stubbed responses are being returned for various components
	// within
	Mock bool
	// Datastorer is an interface type meant to be the
	// persistence mechanism. It can be a
	// SQL database (PostgreSQL) or a mock database
	Datastorer datastore.Datastorer
	// Logger
	Logger zerolog.Logger
}

Application contains the app configurations and Datastore

func NewApplication

func NewApplication(envName EnvName, datastorer datastore.Datastorer, logger zerolog.Logger) *Application

NewApplication initializes an Application struct with Mock set to false

func NewMockedApplication

func NewMockedApplication(envName EnvName, datastorer datastore.Datastorer, logger zerolog.Logger) *Application

NewMockedApplication initializes an Application struct with Mock set to true

type EnvName

type EnvName uint8

EnvName is the environment Name int representation Using iota, 1 (Production) is the lowest, 2 (Staging) is 2nd lowest, and so on...

const (
	Production EnvName = iota + 1 // Production (1)
	Staging                       // Staging (2)
	QA                            // QA (3)
	Local                         // Local (4)
)

EnvName of environment.

func (EnvName) String

func (n EnvName) String() string

type GCPSeverityHook

type GCPSeverityHook struct{}

The GCPSeverityHook struct satisfies the zerolog.Hook interface as it has the Run method defined with the appropriate parameters

func (GCPSeverityHook) Run

func (h GCPSeverityHook) Run(e *zerolog.Event, level zerolog.Level, msg string)