logger

Documentation

Index

• Constants
• func AddMetadata(msg string, metadataMap map[string]string) string
• func AddMetadataMapFromContext(ctx context.Context, msg string) string
• func AddMetadataMapToContext(ctx context.Context, metadataMap map[string]string) context.Context
• func AddRequestUUIDToMap(metadataMap map[string]string, requestUUID string) map[string]string
• func ConvertMapToString(metadataMap map[string]string) string
• func ConvertStringToMap(metadata string) map[string]string
• func LogMemoryStats(ctx context.Context)
• func LogTransactionCreated(transactionIdentifier *types.TransactionIdentifier)
• type CheckType
• type Logger
  • func NewLogger(logDir string, logBlocks bool, logTransactions bool, logBalanceChanges bool, ...) (*Logger, error)
  • func (l *Logger) AddBlockStream(ctx context.Context, block *types.Block) error
  • func (l *Logger) BalanceStream(ctx context.Context, balanceChanges []*parser.BalanceChange) error
  • func (l *Logger) Debug(msg string, fields ...zap.Field)
  • func (l *Logger) Error(msg string, fields ...zap.Field)
  • func (l *Logger) Fatal(msg string, fields ...zap.Field)
  • func (l *Logger) GetMetadata() string
  • func (l *Logger) GetMetadataMap() map[string]string
  • func (l *Logger) Info(msg string, fields ...zap.Field)
  • func (l *Logger) LogConstructionStatus(ctx context.Context, status *results.CheckConstructionStatus)
  • func (l *Logger) LogDataStatus(ctx context.Context, status *results.CheckDataStatus)
  • func (l *Logger) Panic(msg string, fields ...zap.Field)
  • func (l *Logger) ReconcileFailureStream(ctx context.Context, reconciliationType string, ...) error
  • func (l *Logger) ReconcileSuccessStream(ctx context.Context, reconciliationType string, ...) error
  • func (l *Logger) RemoveBlockStream(ctx context.Context, block *types.BlockIdentifier) error
  • func (l *Logger) TransactionStream(ctx context.Context, block *types.Block) error
  • func (l *Logger) Warn(msg string, fields ...zap.Field)

Constants

const (
	RequestUUID contextKey = iota

	MetadataMapKey contextKey = iota

	// Construction identifies construction check
	Construction CheckType = "construction"
	// Data identifies data check
	Data CheckType = "data"
)

Functions

func AddMetadata

func AddMetadata(msg string, metadataMap map[string]string) string

AddMetadata k-v pairs to the tip

func AddMetadataMapFromContext

func AddMetadataMapFromContext(ctx context.Context, msg string) string

Add InfoMetaData k-v pairs to the tip

func AddMetadataMapToContext

func AddMetadataMapToContext(ctx context.Context, metadataMap map[string]string) context.Context

AddMetadataMapToContext will add InfoMetaData to the context, and return the new context

func AddRequestUUIDToMap

func AddRequestUUIDToMap(metadataMap map[string]string, requestUUID string) map[string]string

add requesrUUID to metadataMap

func ConvertMapToString

func ConvertMapToString(metadataMap map[string]string) string

convert metadataMap to a string, aims to support fmt.Errorf

func ConvertStringToMap

func ConvertStringToMap(metadata string) map[string]string

ConvertStringToMap is used to convert a string to map by split , and ;

func LogMemoryStats

func LogMemoryStats(ctx context.Context)

LogMemoryStats logs memory usage information.

func LogTransactionCreated

func LogTransactionCreated(
	transactionIdentifier *types.TransactionIdentifier,
)

LogTransactionCreated logs the hash of created transactions.

Types

type CheckType

type CheckType string

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger contains all logic to record validator output and benchmark a Rosetta Server.

func NewLogger

func NewLogger(
	logDir string,
	logBlocks bool,
	logTransactions bool,
	logBalanceChanges bool,
	logReconciliation bool,
	checkType CheckType,
	network *types.NetworkIdentifier,
	logMetadataMap map[string]string,
	fields ...zap.Field,
) (*Logger, error)

NewLogger constructs a new Logger.

func (*Logger) AddBlockStream

func (l *Logger) AddBlockStream(
	ctx context.Context,
	block *types.Block,
) error

AddBlockStream writes the next processed block to the end of the blockStreamFile output file.

func (*Logger) BalanceStream

func (l *Logger) BalanceStream(
	ctx context.Context,
	balanceChanges []*parser.BalanceChange,
) error

BalanceStream writes a slice of storage.BalanceChanges to the balanceStreamFile.

func (*Logger) Debug

func (l *Logger) Debug(msg string, fields ...zap.Field)

Debug logs at Debug level

func (*Logger) Error

func (l *Logger) Error(msg string, fields ...zap.Field)

Error logs at Error level

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, fields ...zap.Field)

Fatal logs at Fatal level

func (*Logger) GetMetadata

func (l *Logger) GetMetadata() string

return a string of metadata

func (*Logger) GetMetadataMap

func (l *Logger) GetMetadataMap() map[string]string

return a map of metadatMap

func (*Logger) Info

func (l *Logger) Info(msg string, fields ...zap.Field)

Info logs at Info level

func (*Logger) LogConstructionStatus

func (l *Logger) LogConstructionStatus(
	ctx context.Context,
	status *results.CheckConstructionStatus,
)

LogConstructionStatus logs results.CheckConstructionStatus.

func (*Logger) LogDataStatus

func (l *Logger) LogDataStatus(ctx context.Context, status *results.CheckDataStatus)

LogDataStatus logs results.CheckDataStatus.

func (*Logger) Panic

func (l *Logger) Panic(msg string, fields ...zap.Field)

Panic logs at Panic level

func (*Logger) ReconcileFailureStream

func (l *Logger) ReconcileFailureStream(
	ctx context.Context,
	reconciliationType string,
	account *types.AccountIdentifier,
	currency *types.Currency,
	computedBalance string,
	liveBalance string,
	block *types.BlockIdentifier,
) error

ReconcileFailureStream logs all reconciliation checks performed during syncing.

func (*Logger) ReconcileSuccessStream

func (l *Logger) ReconcileSuccessStream(
	ctx context.Context,
	reconciliationType string,
	account *types.AccountIdentifier,
	currency *types.Currency,
	balance string,
	block *types.BlockIdentifier,
) error

ReconcileSuccessStream logs all reconciliation checks performed during syncing.

func (*Logger) RemoveBlockStream

func (l *Logger) RemoveBlockStream(
	ctx context.Context,
	block *types.BlockIdentifier,
) error

RemoveBlockStream writes the next processed block to the end of the blockStreamFile output file.

func (*Logger) TransactionStream

func (l *Logger) TransactionStream(
	ctx context.Context,
	block *types.Block,
) error

TransactionStream writes the next processed block's transactions to the end of the transactionStreamFile.

func (*Logger) Warn

func (l *Logger) Warn(msg string, fields ...zap.Field)

Warn logs at Warn level