Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

formatter

package

v1.5.1 Latest Latest Go to latest Published: May 1, 2025 License: MIT Imports: 6 Imported by: 0

Details

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

Repository

github.com/Falokut/go-kit

Links

Open Source Insights

Documentation ¶

Overview ¶

nolint

nolint:forcetypeassert

nolint

nolint

Index ¶

func JsonWithCallerPrettifier(prettifierFunc CallerPrettifierFunc) func(f *JsonFormatter)
func JsonWithConfig(cfg log.FormatterSettings) func(f *JsonFormatter)
func JsonWithFieldMap(fieldMap FieldMap) func(f *JsonFormatter)
func NewFromConfig(cfg log.FormatterConfig) log.Formatter
func PlainTextWithCallerPrettifier(prettifierFunc CallerPrettifierFunc) func(f *PlainTextFormatter)
func PlainTextWithConfig(cfg log.FormatterSettings) func(f *PlainTextFormatter)
func PlainTextWithFieldMap(fieldMap FieldMap) func(f *PlainTextFormatter)
type CallerPrettifierFunc
type FieldMap
- func NewFieldMap(overrideFields map[string]string) FieldMap
type JsonFormatter
- func NewJsonFormatter(options ...JsonOption) *JsonFormatter
- func (f *JsonFormatter) Format(entry *log.Entry) ([]byte, error)
type JsonOption
type PlainTextFormatter
- func NewPlainTextFormatter(options ...PlainTextOption) *PlainTextFormatter
- func (f *PlainTextFormatter) Format(entry *log.Entry) ([]byte, error)
type PlainTextOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func JsonWithCallerPrettifier ¶ added in v1.5.0

func JsonWithCallerPrettifier(prettifierFunc CallerPrettifierFunc) func(f *JsonFormatter)

func JsonWithConfig ¶

func JsonWithConfig(cfg log.FormatterSettings) func(f *JsonFormatter)

func JsonWithFieldMap ¶ added in v1.5.0

func JsonWithFieldMap(fieldMap FieldMap) func(f *JsonFormatter)

func NewFromConfig ¶

func NewFromConfig(cfg log.FormatterConfig) log.Formatter

nolint:ireturn

func PlainTextWithCallerPrettifier ¶ added in v1.5.0

func PlainTextWithCallerPrettifier(prettifierFunc CallerPrettifierFunc) func(f *PlainTextFormatter)

func PlainTextWithConfig ¶ added in v1.5.0

func PlainTextWithConfig(cfg log.FormatterSettings) func(f *PlainTextFormatter)

func PlainTextWithFieldMap ¶ added in v1.5.0

func PlainTextWithFieldMap(fieldMap FieldMap) func(f *PlainTextFormatter)

Types ¶

type CallerPrettifierFunc ¶ added in v1.5.0

type CallerPrettifierFunc func(*runtime.Frame) (function string, file string)

type FieldMap ¶

type FieldMap map[string]string

FieldMap allows customization of the key names for default fields.

func NewFieldMap ¶ added in v1.5.0

func NewFieldMap(overrideFields map[string]string) FieldMap

type JsonFormatter ¶

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

JsonFormatter formats logs into parsable json

func NewJsonFormatter ¶

func NewJsonFormatter(options ...JsonOption) *JsonFormatter

func (*JsonFormatter) Format ¶

func (f *JsonFormatter) Format(entry *log.Entry) ([]byte, error)

Format renders a single log entry

type JsonOption ¶

type JsonOption func(f *JsonFormatter)

type PlainTextFormatter ¶ added in v1.5.0

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

func NewPlainTextFormatter ¶ added in v1.5.0

func NewPlainTextFormatter(options ...PlainTextOption) *PlainTextFormatter

func (*PlainTextFormatter) Format ¶ added in v1.5.0

func (f *PlainTextFormatter) Format(entry *log.Entry) ([]byte, error)

type PlainTextOption ¶ added in v1.5.0

type PlainTextOption func(f *PlainTextFormatter)

Source Files ¶

View all Source files