logger

package

v1.5.1 Latest Latest Go to latest Published: Mar 20, 2018 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grimbixcode/influxdb

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Database(name string) zapcore.Field
func DurationLiteral(key string, val time.Duration) zapcore.Field
func IsTerminal(w io.Writer) bool
func New(w io.Writer) *zap.Logger
func NewOperation(log *zap.Logger, msg, name string, fields ...zapcore.Field) (*zap.Logger, func())
func OperationElapsed(d time.Duration) zapcore.Field
func OperationEventEnd() zapcore.Field
func OperationEventStart() zapcore.Field
func OperationName(name string) zapcore.Field
func RetentionPolicy(name string) zapcore.Field
func Shard(id uint64) zapcore.Field
func ShardGroup(id uint64) zapcore.Field
func TraceID(id string) zapcore.Field
type Config
- func NewConfig() Config
- func (c *Config) New(defaultOutput io.Writer) (*zap.Logger, error)

Constants ¶

View Source

const (
	// TraceIDKey is the logging context key used for identifying unique traces.
	TraceIDKey = "trace_id"

	// OperationNameKey is the logging context key used for identifying name of an operation.
	OperationNameKey = "op_name"

	// OperationEventKey is the logging context key used for identifying a notable
	// event during the course of an operation.
	OperationEventKey = "op_event"

	// OperationElapsedKey is the logging context key used for identifying time elapsed to finish an operation.
	OperationElapsedKey = "op_elapsed"

	// DBInstanceKey is the logging context key used for identifying name of the relevant database.
	DBInstanceKey = "db_instance"

	// DBRetentionKey is the logging context key used for identifying name of the relevant retention policy.
	DBRetentionKey = "db_rp"

	// DBShardGroupKey is the logging context key used for identifying relevant shard group.
	DBShardGroupKey = "db_shard_group"

	// DBShardIDKey is the logging context key used for identifying name of the relevant shard number.
	DBShardIDKey = "db_shard_id"
)

View Source

const TimeFormat = "2006-01-02T15:04:05.000000Z07:00"

Variables ¶

This section is empty.

Functions ¶

func Database ¶

func Database(name string) zapcore.Field

Database returns a field for tracking the name of a database.

func DurationLiteral ¶

func DurationLiteral(key string, val time.Duration) zapcore.Field

func IsTerminal ¶

func IsTerminal(w io.Writer) bool

IsTerminal checks if w is a file and whether it is an interactive terminal session.

func New ¶

func New(w io.Writer) *zap.Logger

func NewOperation ¶

func NewOperation(log *zap.Logger, msg, name string, fields ...zapcore.Field) (*zap.Logger, func())

NewOperation uses the exiting log to create a new logger with context containing a trace id and the operation. Prior to returning, a standardized message is logged indicating the operation has started. The returned function should be called when the operation concludes in order to log a corresponding message which includes an elapsed time and that the operation has ended.

func OperationElapsed ¶

func OperationElapsed(d time.Duration) zapcore.Field

OperationElapsed returns a field for tracking the duration of an operation.

func OperationEventEnd ¶

func OperationEventEnd() zapcore.Field

OperationEventFinish returns a field for tracking the end of an operation.

func OperationEventStart ¶

func OperationEventStart() zapcore.Field

OperationEventStart returns a field for tracking the start of an operation.

func OperationName ¶

func OperationName(name string) zapcore.Field

OperationName returns a field for tracking the name of an operation.

func RetentionPolicy ¶

func RetentionPolicy(name string) zapcore.Field

Database returns a field for tracking the name of a database.

func Shard ¶

func Shard(id uint64) zapcore.Field

Shard returns a field for tracking the shard identifier.

func ShardGroup ¶

func ShardGroup(id uint64) zapcore.Field

ShardGroup returns a field for tracking the shard group identifier.

func TraceID ¶

func TraceID(id string) zapcore.Field

TraceID returns a field for tracking the trace identifier.

Types ¶

type Config ¶

type Config struct {
	Format       string        `toml:"format"`
	Level        zapcore.Level `toml:"level"`
	SuppressLogo bool          `toml:"suppress-logo"`
}

func NewConfig ¶

func NewConfig() Config

NewConfig returns a new instance of Config with defaults.

func (*Config) New ¶

func (c *Config) New(defaultOutput io.Writer) (*zap.Logger, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL