reqctx

Documentation

Index

• Variables
• type Value
  • func GetValue(ctx context.Context) *Value
  • func New(requestId string) *Value
  • func (v *Value) SetIdempotencyKey(idemKey string)
  • func (v *Value) SetUserId(userId int64)

Variables

var Key = "ReqCtx"

Key is used when writing to context using context.WithValue(parent, Key, Value).

Types

type Value

type Value struct {
	RequestId      string
	UserId         *int64  `json:"Userid,omitempty"`
	IdempotencyKey *string `json:"idempotencyKey,omitempty"`
}

Value stores commonly used metadata to log consistently across microservices.

Uninitialized fields will not be logged due to json tag `json:"omitempty"`.

func GetValue

func GetValue(ctx context.Context) *Value

GetValue retrieves a pointer to Value.

Value is mutable, a common usage is to retrieve from context to set values. Example:

ctx := context.WithValue(context.Background(), reqctx.Key, reqctx.New(uuid.NewString()))
reqctx.GetValue(ctx).SetUserId(1)

func New

func New(requestId string) *Value

New initializes *Value with a required requestId.

Value is mutable, and can be modified in-place using setter methods. Example:

valuePtr := reqctx.New(uuid.NewString())
valuePtr.SetUserId(1)
fmt.Println(valuePtr.UserId) // 1

func (*Value) SetIdempotencyKey

func (v *Value) SetIdempotencyKey(idemKey string)

SetIdempotencyKey modifies IdempotencyKey of Value in place.

func (*Value) SetUserId

func (v *Value) SetUserId(userId int64)

SetUserId modifies UserId of Value in place.