logs

Documentation

Overview

Package logs contains all structured log events for the service.

Index

• type DBCommitError
• type DBOpenError
• type DBPingError
• type DBRollbackError
• type InvalidInput
• type MigrationSuccess
• type StorageError

Types

type DBCommitError

type DBCommitError struct {
	Message string `logevent:"message,default=database-transaction-commit-error"`
	Reason  string `logevent:"reason"`
}

DBCommitError is logged when there is a failure to commit a transaction to the database

type DBOpenError

type DBOpenError struct {
	Message string `logevent:"message,default=database-open-error"`
	Reason  string `logevent:"reason"`
}

DBOpenError is logged when there is a failure to "Open" the database

type DBPingError

type DBPingError struct {
	Message string `logevent:"message,default=database-ping-error"`
	Reason  string `logevent:"reason"`
}

DBPingError is logged when there is a failure to "Ping" the database, which is required to establish Postgres connection

type DBRollbackError

type DBRollbackError struct {
	Message string `logevent:"message,default=database-transaction-rollback-error"`
	Reason  string `logevent:"reason"`
}

DBRollbackError is logged when there is a failure to rollback a failed transaction to the database

type InvalidInput

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

InvalidInput is logged when the provided input is malformed

type MigrationSuccess

type MigrationSuccess struct {
	Message string `logevent:"message,default=migration-success"`
	Reason  string `logevent:"reason"`
}

MigrationSuccess is logged for successful runs of schema changes

type StorageError

type StorageError struct {
	Message string `logevent:"message,default=storage-error"`
	Reason  string `logevent:"reason"`
}

StorageError is logged when there is a failure with the backend dependency