cp

README

Context Propagation Go

This middleware is used for support propagate context between micro services.

For this version, we propagate context by opentracing baggage protocol.

Supported framework for auto inject and extract:

• Gin
• Standard Http Server
• Standard Http Client
• gRPC Server
• gRPC Client

How to use

Operate data from context

Before get or set data from context, you should enable auto inject and extract.

go get -u github.com/AminoApps/context-propagation-go

package main

import "github.com/AminoApps/context-propagation-go"


ctx = cp.SetValueToContext(ctx, "my-key", "my-value")

valye := cp.GetValueFromContext(context.Background(), "my-key")

Auto inject and extract

Gin

go get -u github.com/AminoApps/context-propagation-go/module/context-propagation-gin

package main 

import "github.com/AminoApps/context-propagation-go/module/context-propagation-gin"

e := gin.New()
e.Use(cpgin.Middleware())

Http Client/Server

go get -u github.com/AminoApps/context-propagation-go/module/context-propagation-http

package main

import "github.com/AminoApps/context-propagation-go/module/context-propagation-http"

http.ListenAndServe(":8080", cphttp.Wrap(myHandler))

client := cphttp.WrapClient(&http.Client{})

// Please use the ctxhttp to wrap the request.
resp, err := ctxhttp.Get(ctx, client, "http://127.0.0.1:8080/test")

Grpc Client/Server

go get -u github.com/AminoApps/context-propagation-go/module/context-propagation-grpc

package main

import "github.com/AminoApps/context-propagation-go/module/context-propagation-grpc"

server := grpc.NewServer(grpc.UnaryInterceptor(cpgrpc.NewUnaryServerInterceptor()))

client := grpc.Dial(address, grpc.WithUnaryInterceptor(cpgrpc.NewUnaryClientInterceptor()))

Documentation

Index

• Constants
• func Extract(carrier map[string]string) map[string]string
• func GetValueFromContext(c context.Context, key string) string
• func Inject(carrier interface{}) map[string]string
• func SetValueToContext(c context.Context, key string, val string) context.Context
• type InternalContextKey

Constants

const (
	BaggagePrefix = "baggage-"
)

Functions

func Extract

func Extract(carrier map[string]string) map[string]string

func GetValueFromContext

func GetValueFromContext(c context.Context, key string) string

func Inject

func Inject(carrier interface{}) map[string]string

func SetValueToContext

func SetValueToContext(c context.Context, key string, val string) context.Context

Types

type InternalContextKey

type InternalContextKey struct{}