logs

Documentation

Overview

Package logs is a container of all structure logs that the service will emit. Log structs should leverage `logevent` annotations and extend the httplog.Event struct.

Index

• Constants
• type Conflict
• type DependencyFailure
• type InvalidInput
• type NotFound

Constants

const (
	// DependencyStorage identifies a storage failure
	DependencyStorage = "storage"

	//DependencyQueuer identifies a queuer failure
	DependencyQueuer = "queuer"

	// DependencyMarker identifies a marker failure
	DependencyMarker = "marker"

	// DependencyDiffer identifies a differ failure
	DependencyDiffer = "differ"
)

Types

type Conflict

type Conflict struct {
	Reason  string `logevent:"reason"`
	Message string `logevent:"message,default=conflict"`
}

Conflict is logged when the request conflicts with an existing resource

type DependencyFailure

type DependencyFailure struct {
	Dependency string `logevent:"dependency"`
	Reason     string `logevent:"reason"`
	Message    string `logevent:"message,default=dependency-failure"`
}

DependencyFailure is logged when a downstream dependency fails

type InvalidInput

type InvalidInput struct {
	Reason  string `logevent:"reason"`
	Message string `logevent:"message,default=invalid-input"`
}

InvalidInput is logged when the input provided is not valid

type NotFound

type NotFound struct {
	Reason  string `logevent:"reason"`
	Message string `logevent:"message,default=not-found"`
}

NotFound is logged when the requested resource is not found