cobrazerolog

Documentation

Overview

Package cobrahttp implements a builder for registering flags and producing a Cobra RunFunc that configures Zerolog.

Index

• type Builder
  • func New(opts ...Option) *Builder
  • func (b *Builder) RegisterFlags(flags *pflag.FlagSet)
  • func (b *Builder) RunE() cobrautil.CobraRunFunc
• type Option
  • func WithAsync(size int, pollInterval time.Duration) Option
  • func WithFlagPrefix(flagPrefix string) Option
  • func WithPreRunLevel(preRunLevel zerolog.Level) Option
  • func WithTarget(fn func(zerolog.Logger)) Option

Examples

• Builder.RegisterFlags

Types

type Builder

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

Builder is used to configure Zerolog via Cobra.

func New

func New(opts ...Option) *Builder

New creates a Cobra RunFunc Builder for ZeroLog.

func (*Builder) RegisterFlags

func (b *Builder) RegisterFlags(flags *pflag.FlagSet)

RegisterFlags adds flags for configuring Zerolog.

The following flags are added: - "$PREFIX-level" - "$PREFIX-format"

Example

package main

import (
	"github.com/jzelinskie/cobrautil/v2/cobrazerolog"

	"github.com/spf13/cobra"
)

func main() {
	zl := cobrazerolog.New()

	cmd := &cobra.Command{
		Use:     "mycmd",
		PreRunE: zl.RunE(),
	}

	zl.RegisterFlags(cmd.PersistentFlags())
}

func (*Builder) RunE

func (b *Builder) RunE() cobrautil.CobraRunFunc

RunE returns a Cobra RunFunc that configures Zerolog.

The required flags can be added to a command by using RegisterFlags().

type Option

type Option func(*Builder)

Option is function used to configure Zerolog within a Cobra RunFunc.

func WithAsync

func WithAsync(size int, pollInterval time.Duration) Option

WithAsync enables non-blocking logging.

Size of the buffer and polling interval can be configured. Disabled by default.

func WithFlagPrefix

func WithFlagPrefix(flagPrefix string) Option

WithFlagPrefix defines prefix used with the generated flags. Defaults to "log".

func WithPreRunLevel

func WithPreRunLevel(preRunLevel zerolog.Level) Option

WithPreRunLevel defines the logging level used for pre-run log messages. Defaults to "debug".

func WithTarget

func WithTarget(fn func(zerolog.Logger)) Option

WithTarget callback that forwards the configured logger. Useful when we want to keep it in a global variable.