rkgfinter

Documentation

Overview

Package rkgfinter provides common utility functions for middleware of GoFrame framework

Index

• Constants
• Variables
• func GetRemoteAddressSet(ctx *ghttp.Request) (remoteIp, remotePort string)
• func NewNoopGLogger() *glog.Logger
• func ShouldLog(ctx *ghttp.Request) bool

Constants

const (
	// RpcEntryNameKey entry name key
	RpcEntryNameKey = "gfEntryName"
	// RpcEntryNameValue entry name
	RpcEntryNameValue = "gf"
	// RpcEntryTypeValue entry type
	RpcEntryTypeValue = "gf"
	// RpcEventKey event key
	RpcEventKey = "gfEvent"
	// RpcLoggerKey logger key
	RpcLoggerKey = "gfLogger"
	// RpcTracerKey tracer key
	RpcTracerKey = "gfTracer"
	// RpcSpanKey span key
	RpcSpanKey = "gfSpan"
	// RpcTracerProviderKey trace provider key
	RpcTracerProviderKey = "gfTracerProvider"
	// RpcPropagatorKey propagator key
	RpcPropagatorKey = "gfPropagator"
	// RpcAuthorizationHeaderKey auth key
	RpcAuthorizationHeaderKey = "authorization"
	// RpcApiKeyHeaderKey api auth key
	RpcApiKeyHeaderKey = "X-API-Key"
)

Variables

var (
	// Realm environment variable
	Realm = zap.String("realm", rkcommon.GetEnvValueOrDefault("REALM", "*"))
	// Region environment variable
	Region = zap.String("region", rkcommon.GetEnvValueOrDefault("REGION", "*"))
	// AZ environment variable
	AZ = zap.String("az", rkcommon.GetEnvValueOrDefault("AZ", "*"))
	// Domain environment variable
	Domain = zap.String("domain", rkcommon.GetEnvValueOrDefault("DOMAIN", "*"))
	// LocalIp read local IP from localhost
	LocalIp = zap.String("localIp", rkcommon.GetLocalIP())
	// LocalHostname read hostname from localhost
	LocalHostname = zap.String("localHostname", rkcommon.GetLocalHostname())
)

Functions

func GetRemoteAddressSet

func GetRemoteAddressSet(ctx *ghttp.Request) (remoteIp, remotePort string)

GetRemoteAddressSet returns remote endpoint information set including IP, Port. We will do as best as we can to determine it. If fails, then just return default ones.

func NewNoopGLogger

func NewNoopGLogger() *glog.Logger

func ShouldLog

func ShouldLog(ctx *ghttp.Request) bool

ShouldLog determines whether should log the RPC