contextslogger

README

contextslogger

import "github.com/induzo/gocom/contextslogger"

contextslogger is a package that provides a context key for a logger.

Index

• func FromContext(ctx context.Context) *slog.Logger
• func NewContext(ctx context.Context, l *slog.Logger) context.Context

func FromContext

func FromContext(ctx context.Context) *slog.Logger

FromContext returns the Logger stored in ctx by NewContext, or the default Logger if there is none.

Example

package main

import (
	"context"
	"io"
	"log/slog"

	"github.com/induzo/gocom/contextslogger"
)

func main() {
	textHandler := slog.NewTextHandler(io.Discard, nil)
	logger := slog.New(textHandler)

	ctxWithLogger := contextslogger.NewContext(context.Background(), logger)

	retrievedLogger := contextslogger.FromContext(ctxWithLogger)

	_ = retrievedLogger
}

func NewContext

func NewContext(ctx context.Context, l *slog.Logger) context.Context

NewContext returns a context that contains the given Logger. Use FromContext to retrieve the Logger.

Example

package main

import (
	"context"
	"io"
	"log/slog"

	"github.com/induzo/gocom/contextslogger"
)

func main() {
	textHandler := slog.NewTextHandler(io.Discard, nil)
	logger := slog.New(textHandler)

	_ = contextslogger.NewContext(context.Background(), logger)
}

Generated by gomarkdoc

Documentation

Overview

contextslogger is a package that provides a context key for a logger.

Index

• func FromContext(ctx context.Context) *slog.Logger
• func NewContext(ctx context.Context, l *slog.Logger) context.Context

Examples

• FromContext
• NewContext

Functions

func FromContext

func FromContext(ctx context.Context) *slog.Logger

FromContext returns the Logger stored in ctx by NewContext, or the default Logger if there is none.

Example

package main

import (
	"context"
	"io"
	"log/slog"

	"github.com/induzo/gocom/contextslogger"
)

func main() {
	textHandler := slog.NewTextHandler(io.Discard, nil)
	logger := slog.New(textHandler)

	ctxWithLogger := contextslogger.NewContext(context.Background(), logger)

	retrievedLogger := contextslogger.FromContext(ctxWithLogger)

	_ = retrievedLogger
}

func NewContext

func NewContext(ctx context.Context, l *slog.Logger) context.Context

NewContext returns a context that contains the given Logger. Use FromContext to retrieve the Logger.

Example

package main

import (
	"context"
	"io"
	"log/slog"

	"github.com/induzo/gocom/contextslogger"
)

func main() {
	textHandler := slog.NewTextHandler(io.Discard, nil)
	logger := slog.New(textHandler)

	_ = contextslogger.NewContext(context.Background(), logger)
}