requestid

README

requestid

RequestID middleware for Go forked from ascarter/requestid with custom extensions to pass the request ID with Twirp RequestID adds a UUID as X-Request-ID header if not already set. It also adds it to the http.Request Context. Use requestid.FromContext to get the generated request id.

Example

package main

import (
	"fmt"
	"html"
	"log"
	"net/http"

	"github.com/elblox/requestid"
)

func handler(w http.ResponseWriter, r *http.Request) {
	rid, _ := requestid.FromContext(r.Context())
	log.Println("Running hello handler:", rid)
	fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
}

func main() {
	h := http.HandlerFunc(handler)
	http.Handle("/", requestid.RequestIDHandler(h))
	log.Fatal(http.ListenAndServe(":8080", nil))
}

Documentation

Overview

Example

package main

import (
	"fmt"
	"html"
	"log"
	"net/http"

	"github.com/elblox/requestid"
)

func handler(w http.ResponseWriter, r *http.Request) {
	rid, _ := requestid.FromContext(r.Context())
	log.Println("Running hello handler:", rid)
	fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
}

func main() {
	h := http.HandlerFunc(handler)
	http.Handle("/", requestid.RequestIDHandler(h))
	log.Fatal(http.ListenAndServe(":8080", nil))
}

Index

• Constants
• func FromContext(ctx context.Context) (string, bool)
• func NewContext(ctx context.Context, rid string) context.Context
• func RequestIDHandler(h http.Handler) http.Handler

Examples

• Package

Constants

const HeaderName = "X-Request-ID"

Functions

func FromContext

func FromContext(ctx context.Context) (string, bool)

FromContext returns the request id from context.

func NewContext

func NewContext(ctx context.Context, rid string) context.Context

NewContext creates a context with request id set as context value as well as twirp request header.

func RequestIDHandler

func RequestIDHandler(h http.Handler) http.Handler

RequestIDHandler sets unique request id. If header `X-Request-ID` is already present in the request, that is considered the request id. Otherwise, generates a new unique ID.