logfields

Documentation

Overview

Package logfields provides a standard location for field names we expect in logs

Index

• Constants
• Variables
• func AuditChangeID(changeID interface{}) zapcore.Field
• func AuditQueueAttempts(attempts interface{}) zapcore.Field
• func BID(bid string) zapcore.Field
• func Date(date interface{}) zapcore.Field
• func FaktoryQueue(faktoryQueue string) zapcore.Field
• func IsFinalAttempt(isFinal bool) zapcore.Field
• func JID(jid string) zapcore.Field
• func JobType(jobType string) zapcore.Field
• func MaxRetries(maxRetries int) zapcore.Field
• func ModelPlanID(modelPlanID uuid.UUID) zapcore.Field
• func RetryCount(retryCount int) zapcore.Field
• func TraceField(traceID string) zapcore.Field
• func TranslatedAuditQueueID(translatedAuditQueueID uuid.UUID) zapcore.Field
• func UserID(userID uuid.UUID) zapcore.Field

Constants

const (
	AppSectionKey string = "app_section"

	FaktorySectionKey    string = "faktory"
	DataLoaderSectionKey string = "dataLoader"
)

these constants represents the keys to get these data fields out of a zap logger.

const (
	BatchIDKey        string = "BID"
	JobIDKey          string = "JID"
	JobTypeKey        string = "job_type"
	RetryCountKey     string = "retry_count"
	MaxRetriesKey     string = "max_retries"
	IsFinalAttemptKey string = "is_final_attempt"
	FaktoryQueueKey   string = "faktory_queue"
)

these constants represents the common keys used in the faktory job section of the app. They are used as the key when logging data in a zap logger

const TraceFieldKey string = "traceID"

TraceFieldKey is the key to check the trace of a logging chain

Variables

var DataLoaderAppSection = zap.String(AppSectionKey, DataLoaderSectionKey)

var FaktoryAppSection = zap.String(AppSectionKey, FaktorySectionKey)

FaktoryAppSection provides the zap field for specifying the part of the application is faktory

Functions

func AuditChangeID

func AuditChangeID(changeID interface{}) zapcore.Field

AuditChangeID provides the zap field for an audit change id

func AuditQueueAttempts

func AuditQueueAttempts(attempts interface{}) zapcore.Field

AuditQueueAttempts provides the zap field for the number of attempts

func BID

func BID(bid string) zapcore.Field

BID returns the zap core field for a worker BatchID

func Date

func Date(date interface{}) zapcore.Field

Date provides the zap field for the date

func FaktoryQueue

func FaktoryQueue(faktoryQueue string) zapcore.Field

FaktoryQueue provides the zap field for a FaktoryQueue

func IsFinalAttempt

func IsFinalAttempt(isFinal bool) zapcore.Field

IsFinalAttempt returns the zap core field for a worker is final attempt

func JID

func JID(jid string) zapcore.Field

JID returns the zap core field for a worker JobID

func JobType

func JobType(jobType string) zapcore.Field

JobType returns the zap core field for a worker job type

func MaxRetries

func MaxRetries(maxRetries int) zapcore.Field

MaxRetries returns the zap core field for a worker max retries

func ModelPlanID

func ModelPlanID(modelPlanID uuid.UUID) zapcore.Field

ModelPlanID provides the zap field for the modelPlanID

func RetryCount

func RetryCount(retryCount int) zapcore.Field

RetryCount returns the zap core field for a worker retry count

func TraceField

func TraceField(traceID string) zapcore.Field

func TranslatedAuditQueueID

func TranslatedAuditQueueID(translatedAuditQueueID uuid.UUID) zapcore.Field

TranslatedAuditQueueID provides the zap field for a TranslatedAuditQueueID

func UserID

func UserID(userID uuid.UUID) zapcore.Field

UserID provides the zap field for the userID