requestid

Documentation

Overview

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright 2024 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• Constants
• func FromContext(ctx context.Context) string
• func GetReqId(r *rest.Request) string
• func Middleware(opts ...*MiddlewareOptions) gin.HandlerFunc
• func SetReqId(r *rest.Request, reqid string) *rest.Request
• func WithContext(ctx context.Context, reqid string) context.Context
• type ApiRequester
• type MiddlewareOptions
  • func NewMiddlewareOptions() *MiddlewareOptions
  • func (opt *MiddlewareOptions) SetGenerateRequestID(gen bool) *MiddlewareOptions
• type RequestIdMiddleware
  • func (mw *RequestIdMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc
• type TrackingApiClient
  • func NewTrackingApiClient(reqid string) *TrackingApiClient
  • func (a *TrackingApiClient) Do(r *http.Request) (*http.Response, error)

Constants

const RequestIdHeader = "X-MEN-RequestID"

Functions

func FromContext

func FromContext(ctx context.Context) string

FromContext extracts current request Id from context.Context

func GetReqId

func GetReqId(r *rest.Request) string

GetReqId helper for retrieving current request Id

func Middleware

func Middleware(opts ...*MiddlewareOptions) gin.HandlerFunc

Middleware provides requestid middleware for the gin-gonic framework.

func SetReqId

func SetReqId(r *rest.Request, reqid string) *rest.Request

SetReqId is a helper for setting request ID in request context

func WithContext

func WithContext(ctx context.Context, reqid string) context.Context

WithContext adds request to context `ctx` and returns the resulting context.

Types

type ApiRequester

type ApiRequester interface {
	Do(r *http.Request) (*http.Response, error)
}

type MiddlewareOptions

type MiddlewareOptions struct {
	// GenerateRequestID decides whether a request ID should
	// be generated when none exists. (default: true)
	GenerateRequestID *bool
}

func NewMiddlewareOptions

func NewMiddlewareOptions() *MiddlewareOptions

func (*MiddlewareOptions) SetGenerateRequestID

func (opt *MiddlewareOptions) SetGenerateRequestID(gen bool) *MiddlewareOptions

type RequestIdMiddleware

type RequestIdMiddleware struct {
}

RequestIdMiddleware sets the X-MEN-RequestID header if it's not present, and adds the request id to the request logger's context.

func (*RequestIdMiddleware) MiddlewareFunc

func (mw *RequestIdMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc

MiddlewareFunc makes RequestIdMiddleware implement the Middleware interface.

type TrackingApiClient

type TrackingApiClient struct {
	http.Client
	// contains filtered or unexported fields
}

TrackingApiClient wrapper for http.Client for sending http requests to outside services with a given request id

func NewTrackingApiClient

func NewTrackingApiClient(reqid string) *TrackingApiClient

func (*TrackingApiClient) Do

func (a *TrackingApiClient) Do(r *http.Request) (*http.Response, error)

do send a request with a request id