requestid

README

go-requestid

Install

go get github.com/akm/go-requestid

How to use

import

import "github.com/akm/go-requestid"

Easy way

    handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // Get the request ID by using requestid.Get in your http handler
        requestID := requestid.Get(r.Context())
		w.Write([]byte(fmt.Sprintf("Request ID", requestID)))
		w.WriteHeader(http.StatusOK)
	})

    // Wrap your http handler in order to process requestid
	handlerWithRequestID := requestid.Wrap(handler)

with slog

import "github.com/akm/slogctx"

Setup logger

    slog.SetDefault(slogctx.New(slog.NewTextHandler(os.Stdout, nil)))

you can use slog.NewJSONHandler instead of slog.NewTextHandler.

And setup slog Handler for requestid.

func init() {
	requestid.RegisterSlogHandle("requestid")
}

Then the server log includes requestid.

$ go run ./example
Server started at :8080
time=2024-10-19T23:29:52.650+09:00 level=INFO msg=Start requestid=eVxKgnfE
time=2024-10-19T23:29:52.651+09:00 level=INFO msg=End requestid=eVxKgnfE
time=2024-10-19T23:29:53.389+09:00 level=INFO msg=Start requestid=MJsEk1JG
time=2024-10-19T23:29:53.389+09:00 level=INFO msg=End requestid=MJsEk1JG

See example/main.go for more details.

Documentation

Index

• func Get(ctx context.Context) string
• func RandomGenerator(size int) generator
• func SetDefaultNamespace(ns *Namespace)
• func SlogwPrepareFunc(key string) slogctx.HandlePrepareFunc
• func Wrap(next http.Handler, opts ...Option) http.Handler
• type Namespace
  • func DefaultNamespace() *Namespace
  • func New(opts ...Option) *Namespace
  • func (f *Namespace) Wrap(h http.Handler) http.Handler
• type Option
  • func Generator(g generator) Option
  • func RequestHeader(h string) Option
  • func ResponseHeader(h string) Option
  • func SlogwNamespace(ns *slogctx.Namespace) Option
• type Options

Functions

func Get

func Get(ctx context.Context) string

func RandomGenerator

func RandomGenerator(size int) generator

func SetDefaultNamespace

func SetDefaultNamespace(ns *Namespace)

func SlogwPrepareFunc

func SlogwPrepareFunc(key string) slogctx.HandlePrepareFunc

func Wrap

func Wrap(next http.Handler, opts ...Option) http.Handler

Types

type Namespace

type Namespace struct {
	SlogwNamespace *slogctx.Namespace
	// contains filtered or unexported fields
}

func DefaultNamespace

func DefaultNamespace() *Namespace

func New

func New(opts ...Option) *Namespace

func (*Namespace) Wrap

func (f *Namespace) Wrap(h http.Handler) http.Handler

type Option

type Option func(o *Options)

func Generator

func Generator(g generator) Option

func RequestHeader

func RequestHeader(h string) Option

Set X-Cloud-Trace-Context for Google Cloud https://cloud.google.com/trace/docs/trace-context?hl=ja#http-requests Set X-Amzn-Trace-Id for AWS https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/application/load-balancer-request-tracing.html

func ResponseHeader

func ResponseHeader(h string) Option

func SlogwNamespace

func SlogwNamespace(ns *slogctx.Namespace) Option

type Options

type Options struct {
	Generator      generator
	RequestHeader  string
	ResponseHeader string
	SlogwNamespace *slogctx.Namespace
}