setup_options.go

package log

import (
	"io"
	"os"

	"github.com/rs/zerolog"
)

func getOptions(opts []SetupOption) setupOptions {
	cfg := setupOptions{
		serviceName: "unknown",
		format:      FormatJSON,
		level:       zerolog.TraceLevel,
		output:      os.Stdout,
		updateCtx:   func(c zerolog.Context) zerolog.Context { return c },
	}

	for _, opt := range opts {
		opt(&cfg)
	}
	return cfg
}

type setupOptions struct {
	serviceName string
	hostName    string
	region      string
	publicIP    string
	format      Format
	level       zerolog.Level
	output      io.Writer
	updateCtx   func(c zerolog.Context) zerolog.Context
}

// SetupOption defines an option for setting up the logging.
type SetupOption func(*setupOptions)

// ServiceName sets the service name for logging.
func ServiceName(name string) SetupOption {
	return func(opts *setupOptions) {
		opts.serviceName = name
	}
}

// HostName sets the host name for logging.
func HostName(name string) SetupOption {
	return func(opts *setupOptions) {
		opts.hostName = name
	}
}

// Region sets the data center region for logging.
func Region(name string) SetupOption {
	return func(opts *setupOptions) {
		opts.region = name
	}
}

// PublicIP sets the public ip for logging.
func PublicIP(ip string) SetupOption {
	return func(opts *setupOptions) {
		opts.publicIP = ip
	}
}

// WithFormat sets the format to use for logging.
func WithFormat[T FormatInput](format T) SetupOption {
	logFormat := getFormat(format)

	return func(opts *setupOptions) {
		opts.format = logFormat
	}
}

// WithLevel sets the global log level to use for logging.
func WithLevel[T LevelInput](level T) SetupOption {
	logLevel := getLevel(level)

	return func(opts *setupOptions) {
		opts.level = logLevel
	}
}

// UpdateContext can be used to update log context, adding additional information at setup.
func UpdateContext(f func(zerolog.Context) zerolog.Context) SetupOption {
	return func(opts *setupOptions) {
		opts.updateCtx = f
	}
}

// WithOutput sets the writer to write the log output to.
// Can be used to use a customized output writer. Doing so should be done in combination
// with passing FormatCustom to WithFormat.
func WithOutput(out io.Writer) SetupOption {
	return func(opts *setupOptions) {
		opts.output = out
	}
}