Documentation
¶
Index ¶
- Constants
- Variables
- func AppendRecord(b []byte, ts int64, level Level, fn *FuncInfo, msg string) []byte
- func Err()
- func FuncFromPointer(p unsafe.Pointer) func()
- func FuncToPC(fn func()) uintptr
- func FuncToPCUnsafe(p unsafe.Pointer) uintptr
- func FuncToPointer(fn func()) unsafe.Pointer
- func Info()
- func Info0()
- func Log(level Level, msg string)
- type Attr
- type AttrType
- type Event
- type Flags
- type FuncInfo
- func (f *FuncInfo) Data() any
- func (f *FuncInfo) Entry() uintptr
- func (f *FuncInfo) File() string
- func (f *FuncInfo) Formatted() string
- func (f *FuncInfo) Line() int
- func (f *FuncInfo) Method() reflect.Method
- func (f *FuncInfo) MethodName() string
- func (f *FuncInfo) Name() string
- func (f *FuncInfo) NumIn() int
- func (f *FuncInfo) NumOut() int
- func (f *FuncInfo) PC() uintptr
- func (f *FuncInfo) Receiver() string
- func (f *FuncInfo) ReceiverSize() uintptr
- func (f *FuncInfo) SetData(data any)
- func (f *FuncInfo) String() string
- type FuncInfoMap
- type Kind
- type Level
- type LevelVar
- type Leveler
- type Logger
- type Record
- type RecordAttr
- type RecordAttributes
- type RecordBuilder
- func (r RecordBuilder) Msg(msg string, a ...any)
- func (r RecordBuilder) Msgf(format string, a ...any)
- func (r RecordBuilder) Reset() RecordBuilder
- func (r RecordBuilder) Size(size uint16) RecordBuilder
- func (r RecordBuilder) Str(name string, value string) RecordBuilder
- func (r RecordBuilder) Strf(name string, value string, a ...any) RecordBuilder
- func (r RecordBuilder) TimeHF() RecordBuilder
- type RecordHeader
Constants ¶
const CacheLinePad = unsafe.Sizeof(cpu.CacheLinePad{})
const TestMessage = "Test logging, but use a somewhat realistic message length."
Variables ¶
var ( ErrFull = errors.New("full") ErrTimeout = errors.New("timeout") ErrEmptyData = errors.New("empty data") ErrTooBig = errors.New("too big") )
var ( DurationAsString = true RawFieldName = "raw" DataFieldName = "data" DurationFieldName = "dur" DurationsFieldName = "durs" ErrorsFieldName = "errors" EmptyMessage = "" )
Functions ¶
func AppendRecord ¶
func FuncFromPointer ¶
func FuncToPCUnsafe ¶
func FuncToPointer ¶
Types ¶
type FuncInfo ¶
type FuncInfo struct {
// contains filtered or unexported fields
}
func GetMethodSlow ¶
func (*FuncInfo) MethodName ¶
func (*FuncInfo) ReceiverSize ¶
type FuncInfoMap ¶
type FuncInfoMap struct {
// contains filtered or unexported fields
}
func NewFuncInfoMap ¶
func NewFuncInfoMap() *FuncInfoMap
func (*FuncInfoMap) GetForFunc ¶
func (fip *FuncInfoMap) GetForFunc(fn func()) *FuncInfo
func (*FuncInfoMap) GetForPC ¶
func (fip *FuncInfoMap) GetForPC(pc uintptr) *FuncInfo
func (*FuncInfoMap) GetMethod ¶
func (fip *FuncInfoMap) GetMethod(methodWrapperPC uintptr) *FuncInfo
func (*FuncInfoMap) GetMethodSlow ¶
func (fip *FuncInfoMap) GetMethodSlow( object interface{}, methodWrapperPC uintptr, methodName string, ) *FuncInfo
type Level ¶
type Level int8
A Level is the importance or severity of a log event. The higher the level, the more important or severe the event.
Second, we wanted to make it easy to use levels to specify logger verbosity. Since a larger level means a more severe event, a logger that accepts events with smaller (or more negative) level means a more verbose logger. Logger verbosity is thus the negation of event severity, and the default verbosity of 0 accepts all events at least as severe as INFO.
Third, we wanted some room between levels to accommodate schemes with named levels between ours. For example, Google Cloud Logging defines a Notice level between Info and Warn. Since there are only a few of these intermediate levels, the gap between the numbers need not be large. Our gap of 4 matches OpenTelemetry's mapping. Subtracting 9 from an OpenTelemetry level in the DEBUG, INFO, WARN and ERROR ranges converts it to the corresponding slog Level range. OpenTelemetry also has the names TRACE and FATAL, which slog does not. But those OpenTelemetry levels can still be represented as slog Levels by using the appropriate integers.
Names for common levels.
func (Level) MarshalJSON ¶
MarshalJSON implements encoding/json.Marshaler by quoting the output of Level.String.
func (Level) MarshalText ¶
MarshalText implements encoding.TextMarshaler by calling Level.String.
func (Level) String ¶
String returns a name for the level. If the level has a name, then that name in uppercase is returned. If the level is between named values, then an integer is appended to the uppercased name. Examples:
LevelWarn.String() => "WARN" (LevelInfo+2).String() => "INFO+2"
func (*Level) UnmarshalJSON ¶
UnmarshalJSON implements encoding/json.Unmarshaler It accepts any string produced by Level.MarshalJSON, ignoring case. It also accepts numeric offsets that would result in a different string on output. For example, "Error-8" would marshal as "INFO".
func (*Level) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler. It accepts any string produced by Level.MarshalText, ignoring case. It also accepts numeric offsets that would result in a different string on output. For example, "Error-8" would marshal as "INFO".
type LevelVar ¶
type LevelVar struct {
// contains filtered or unexported fields
}
A LevelVar is a Level variable, to allow a Handler level to change dynamically. It implements Leveler as well as a Set method, and it is safe for use by multiple goroutines. The zero LevelVar corresponds to LevelInfo.
func (*LevelVar) MarshalText ¶
MarshalText implements encoding.TextMarshaler by calling Level.MarshalText.
func (*LevelVar) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler by calling Level.UnmarshalText.
type Leveler ¶
type Leveler interface {
Level() Level
}
A Leveler provides a Level value.
As Level itself implements Leveler, clients typically supply a Level value wherever a Leveler is needed, such as in HandlerOptions. Clients who need to vary the level dynamically can provide a more complex Leveler implementation such as *LevelVar.
type RecordAttr ¶
type RecordAttr struct {
// contains filtered or unexported fields
}
func (*RecordAttr) Kind ¶
func (ra *RecordAttr) Kind() Kind
type RecordAttributes ¶
type RecordAttributes struct {
// contains filtered or unexported fields
}
type RecordBuilder ¶
type RecordBuilder struct {
// contains filtered or unexported fields
}
func AllocRecordBuilder ¶
func AllocRecordBuilder() RecordBuilder
func (RecordBuilder) Msg ¶
func (r RecordBuilder) Msg(msg string, a ...any)
func (RecordBuilder) Msgf ¶
func (r RecordBuilder) Msgf(format string, a ...any)
func (RecordBuilder) Reset ¶
func (r RecordBuilder) Reset() RecordBuilder
func (RecordBuilder) Size ¶
func (r RecordBuilder) Size(size uint16) RecordBuilder
func (RecordBuilder) Str ¶
func (r RecordBuilder) Str(name string, value string) RecordBuilder
func (RecordBuilder) Strf ¶
func (r RecordBuilder) Strf(name string, value string, a ...any) RecordBuilder
func (RecordBuilder) TimeHF ¶
func (r RecordBuilder) TimeHF() RecordBuilder
type RecordHeader ¶
type RecordHeader struct {
// contains filtered or unexported fields
}
func (*RecordHeader) AttrReader ¶
func (r *RecordHeader) AttrReader()
func (*RecordHeader) Caller ¶
func (r *RecordHeader) Caller() string
func (*RecordHeader) Msg ¶
func (r *RecordHeader) Msg() string
func (*RecordHeader) Source ¶
func (r *RecordHeader) Source() string
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package slog provides structured logging, in which log records include a message, a severity level, and various other attributes expressed as key-value pairs.
|
Package slog provides structured logging, in which log records include a message, a severity level, and various other attributes expressed as key-value pairs. |
|
benchmarks
Package benchmarks contains benchmarks for slog.
|
Package benchmarks contains benchmarks for slog. |
|
internal/buffer
Package buffer provides a pool-allocated byte buffer.
|
Package buffer provides a pool-allocated byte buffer. |
|
internal/testutil
Package testutil contains support functions for testing.
|
Package testutil contains support functions for testing. |