Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 1.32 KB

request-id.md

File metadata and controls

65 lines (49 loc) · 1.32 KB
Raw

+++ title = "Request ID Middleware" description = "Request ID middleware for Echo" [menu.main] name = "Request ID" parent = "middleware" +++

Request ID middleware generates a unique id for a request.

Usage

e.Use(middleware.RequestID())

Custom Configuration

Usage

e.Use(middleware.RequestIDWithConfig(middleware.RequestIDConfig{
  Generator: func() string {
    return customGenerator()
  },
}))

Configuration

RequestIDConfig struct {
  // Skipper defines a function to skip middleware.
  Skipper Skipper

  // Generator defines a function to generate an ID.
  // Optional. Default value random.String(32).
  Generator func() string

  // TargetHeader defines what header to look for to populate the id
  TargetHeader string
}

Default Configuration

DefaultRequestIDConfig = RequestIDConfig{
  Skipper:   DefaultSkipper,
  Generator: generator,
  TargetHeader: echo.HeaderXRequestID,
}

Set ID

You can set the id from the requester with the X-Request-ID-Header

request

curl -H "X-Request-ID: 3" --compressed -v "http://localhost:1323/?my=param"

Log

{"time":"2017-11-13T20:26:28.6438003+01:00","id":"3","remote_ip":"::1","host":"localhost:1323","method":"GET","uri":"/?my=param","my":"param","status":200, "latency":0,"latency_human":"0s","bytes_in":0,"bytes_out":13}