logutil

Documentation

Index

• Variables
• func AShortError(key string, err error) zap.Field
• func AbbreviatedArray(key string, elements any, marshalFunc func(any) []string) zap.Field
• func AbbreviatedStringers[T fmt.Stringer](key string, stringers []T) zap.Field
• func CL(c context.Context) *zap.Logger
• func ContextWithField(c context.Context, fields ...zap.Field) context.Context
• func File(file *backuppb.File) zap.Field
• func Files(fs []*backuppb.File) zap.Field
• func Key(fieldKey string, key []byte) zap.Field
• func Keys(keys [][]byte) zap.Field
• func Leader(peer *metapb.Peer) zap.Field
• func LoggerFromContext(c context.Context) *zap.Logger
• func MarshalLogObjectForFiles(files []*backuppb.File, encoder zapcore.ObjectEncoder) error
• func Peer(peer *metapb.Peer) zap.Field
• func Redact(field zap.Field) zap.Field
• func RedactAny(fieldKey string, key any) zap.Field
• func Region(region *metapb.Region) zap.Field
• func RegionBy(key string, region *metapb.Region) zap.Field
• func ResetGlobalLogger(l *zap.Logger)
• func RewriteRule(rewriteRule *import_sstpb.RewriteRule) zap.Field
• func RewriteRuleObject(rewriteRule *import_sstpb.RewriteRule) zapcore.ObjectMarshaler
• func SSTMeta(sstMeta *import_sstpb.SSTMeta) zap.Field
• func SSTMetas(sstMetas []*import_sstpb.SSTMeta) zap.Field
• func ShortError(err error) zap.Field
• func StreamBackupTaskInfo(t *backuppb.StreamBackupTaskInfo) zap.Field
• func StringifyMany[T fmt.Stringer](items []T) zapcore.ArrayMarshaler
• func WarnTerm(message string, fields ...zap.Field)
• type AbbreviatedArrayMarshaler
  • func (abb AbbreviatedArrayMarshaler) MarshalLogArray(encoder zapcore.ArrayEncoder) error
• type HexBytes
  • func (b HexBytes) MarshalJSON() ([]byte, error)
  • func (b HexBytes) String() string
• type RateTracer
  • func TraceRateOver(counter prometheus.Counter) RateTracer
  • func (r *RateTracer) L() *zap.Logger
  • func (r *RateTracer) Rate() float64
  • func (r *RateTracer) RateAt(instant time.Time) float64
• type StringifyKeys
  • func (kr StringifyKeys) String() string
• type StringifyRange
  • func StringifyRangeOf(start, end []byte) StringifyRange
  • func (rng StringifyRange) String() string

Variables

var MetricTableCreatedCounter = prometheus.NewCounter(prometheus.CounterOpts{
	Namespace: "BR",
	Name:      "table_created",
	Help:      "The count of tables have been created.",
})

MetricTableCreatedCounter counts how many tables created. TODO: when br decided to introduce Prometheus, move this to its metric package.

Functions

func AShortError

func AShortError(key string, err error) zap.Field

AShortError make the zap field with key to display error without verbose representation (e.g. the stack trace).

func AbbreviatedArray

func AbbreviatedArray(
	key string, elements any, marshalFunc func(any) []string,
) zap.Field

AbbreviatedArray constructs a field that abbreviates an array of elements.

func AbbreviatedStringers

func AbbreviatedStringers[T fmt.Stringer](key string, stringers []T) zap.Field

func CL

func CL(c context.Context) *zap.Logger

CL is the shorthand for LoggerFromContext.

func ContextWithField

func ContextWithField(c context.Context, fields ...zap.Field) context.Context

ContextWithField wrap a context with a logger with some fields.

func File

func File(file *backuppb.File) zap.Field

File make the zap fields for a file.

func Files

func Files(fs []*backuppb.File) zap.Field

Files make the zap field for a set of file.

func Key

func Key(fieldKey string, key []byte) zap.Field

Key constructs a field that carries upper hex format key.

func Keys

func Keys(keys [][]byte) zap.Field

Keys constructs a field that carries upper hex format keys.

func Leader

func Leader(peer *metapb.Peer) zap.Field

Leader make the zap fields for a peer as leader. nolint:interfacer

func LoggerFromContext

func LoggerFromContext(c context.Context) *zap.Logger

LoggerFromContext returns the contextual logger via the context. If there isn't a logger in the context, returns the global logger.

func MarshalLogObjectForFiles

func MarshalLogObjectForFiles(files []*backuppb.File, encoder zapcore.ObjectEncoder) error

MarshalLogObjectForFiles is an internal util function to zap something having `Files` field.

func Peer

func Peer(peer *metapb.Peer) zap.Field

Peer make the zap fields for a peer.

func Redact

func Redact(field zap.Field) zap.Field

Redact replaces the zap field by a '?' if redaction is turned on.

func RedactAny

func RedactAny(fieldKey string, key any) zap.Field

RedactAny constructs a redacted field that carries an interface{}.

func Region

func Region(region *metapb.Region) zap.Field

Region make the zap fields for a region.

func RegionBy

func RegionBy(key string, region *metapb.Region) zap.Field

RegionBy make the zap fields for a region with name.

func ResetGlobalLogger

func ResetGlobalLogger(l *zap.Logger)

ResetGlobalLogger resets the global logger. Contexts have already made by `ContextWithField` would keep untouched, subsequent wrapping over those contexts would keep using the old global logger, only brand new contexts (i.e. context without logger) would be wrapped with the new global logger. This method is mainly for testing.

func RewriteRule

func RewriteRule(rewriteRule *import_sstpb.RewriteRule) zap.Field

RewriteRule make the zap fields for a rewrite rule.

func RewriteRuleObject

func RewriteRuleObject(rewriteRule *import_sstpb.RewriteRule) zapcore.ObjectMarshaler

RewriteRuleObject make zap object marshaler for a rewrite rule.

func SSTMeta

func SSTMeta(sstMeta *import_sstpb.SSTMeta) zap.Field

SSTMeta make the zap fields for a SST meta.

func SSTMetas

func SSTMetas(sstMetas []*import_sstpb.SSTMeta) zap.Field

SSTMetas make the zap fields for SST metas.

func ShortError

func ShortError(err error) zap.Field

ShortError make the zap field to display error without verbose representation (e.g. the stack trace).

func StreamBackupTaskInfo

func StreamBackupTaskInfo(t *backuppb.StreamBackupTaskInfo) zap.Field

StreamBackupTaskInfo makes the zap fields for a stream backup task info.

func StringifyMany

func StringifyMany[T fmt.Stringer](items []T) zapcore.ArrayMarshaler

StringifyMany returns an array marshaler for a slice of stringers.

func WarnTerm

func WarnTerm(message string, fields ...zap.Field)

WarnTerm put a log both to terminal and to the log file.

Types

type AbbreviatedArrayMarshaler

type AbbreviatedArrayMarshaler []string

AbbreviatedArrayMarshaler abbreviates an array of elements.

func (AbbreviatedArrayMarshaler) MarshalLogArray

func (abb AbbreviatedArrayMarshaler) MarshalLogArray(encoder zapcore.ArrayEncoder) error

MarshalLogArray implements zapcore.ArrayMarshaler.

type HexBytes

type HexBytes []byte

HexBytes is a wrapper which make a byte sequence printed by the hex format.

func (HexBytes) MarshalJSON

func (b HexBytes) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (HexBytes) String

func (b HexBytes) String() string

String implements fmt.Stringer.

type RateTracer

type RateTracer struct {
	prometheus.Counter
	// contains filtered or unexported fields
}

RateTracer is a trivial rate tracer based on a prometheus counter. It traces the average speed from it was created.

func TraceRateOver

func TraceRateOver(counter prometheus.Counter) RateTracer

TraceRateOver make a trivial rater based on a counter. the current value of this counter would be omitted.

func (*RateTracer) L

func (r *RateTracer) L() *zap.Logger

L make a logger with the current speed.

func (*RateTracer) Rate

func (r *RateTracer) Rate() float64

Rate returns the average rate from when it was created.

func (*RateTracer) RateAt

func (r *RateTracer) RateAt(instant time.Time) float64

RateAt returns the rate until some instant. This function is mainly for testing. WARN: the counter value for calculating is still its CURRENT VALUE.

type StringifyKeys

type StringifyKeys []kv.KeyRange

StringifyKeys wraps the key range into a stringer.

func (StringifyKeys) String

func (kr StringifyKeys) String() string

type StringifyRange

type StringifyRange kv.KeyRange

StringifyRange is the wrapper for displaying a key range.

func StringifyRangeOf

func StringifyRangeOf(start, end []byte) StringifyRange

func (StringifyRange) String

func (rng StringifyRange) String() string