common

Documentation

Index

• Constants
• Variables
• func ContextOutOfTime(ctx context.Context) bool
• func FindSequenceNumber(sequence string) (int, error)
• func GetRemainingTimeoutFromContext(ctx context.Context) (timeRemaining time.Duration)
• func IsTestMode(ctx context.Context) bool
• func LowerContextTimeout(ctx context.Context, timeout time.Duration) (context.Context, context.CancelFunc)
• func ParseEndpointArgs(endpoint_strings []string, yaml_config_properties []string, ...) (viper_endpoints *viper.Viper, err error)
• func ParseTransactionResult(transactionResult string) (string, int)
• func ValidateEndpoint(endpoint string, apiInterface string) error
• type AuthConfig
  • func (ac *AuthConfig) AddAuthPath(url string) string
• type NodeUrl
  • func (url *NodeUrl) SetAuthHeaders(ctx context.Context, headerSetter func(string, string))
  • func (url *NodeUrl) SetIpForwardingIfNecessary(ctx context.Context, headerSetter func(string, string))
  • func (url *NodeUrl) String() string
• type RPCConsumerLogs
  • func NewRPCConsumerLogs() (*RPCConsumerLogs, error)
  • func (pl *RPCConsumerLogs) AddMetricForGrpc(data *metrics.RelayMetrics, err error, metadataValues *metadata.MD)
  • func (pl *RPCConsumerLogs) AddMetricForHttp(data *metrics.RelayMetrics, err error, headers map[string]string)
  • func (pl *RPCConsumerLogs) AddMetricForWebSocket(data *metrics.RelayMetrics, err error, c *websocket.Conn)
  • func (pl *RPCConsumerLogs) AnalyzeWebSocketErrorAndWriteMessage(c *websocket.Conn, mt int, err error, msgSeed string, msg []byte, ...)
  • func (pl *RPCConsumerLogs) GetMessageSeed() string
  • func (pl *RPCConsumerLogs) GetUniqueGuidResponseForError(responseError error, msgSeed string) string
  • func (pl *RPCConsumerLogs) LogRequestAndResponse(module string, hasError bool, method string, path string, req string, ...)
  • func (pl *RPCConsumerLogs) LogStartTransaction(name string) func()
  • func (rpccl *RPCConsumerLogs) LogTestMode(fiberCtx *fiber.Ctx)
• type Test_mode_ctx_key

Constants

const (
	EndpointsConfigName = "endpoints"
	SaveConfigFlagName  = "save-conf"
	GeolocationFlag     = "geolocation"
	TestModeFlagName    = "test-mode"
)

const (
	URL_QUERY_PARAMETERS_SEPARATOR_FROM_PATH        = "?"
	URL_QUERY_PARAMETERS_SEPARATOR_OTHER_PARAMETERS = "&"
	IP_FORWARDING_HEADER_NAME                       = "X-Forwarded-For"
)

const (
	RefererHeaderKey = "Referer"
)

Variables

var ReturnMaskedErrors = "false"

Functions

func ContextOutOfTime

func ContextOutOfTime(ctx context.Context) bool

func FindSequenceNumber

func FindSequenceNumber(sequence string) (int, error)

extract requested sequence number from tx error.

func GetRemainingTimeoutFromContext

func GetRemainingTimeoutFromContext(ctx context.Context) (timeRemaining time.Duration)

func IsTestMode

func IsTestMode(ctx context.Context) bool

func LowerContextTimeout

func LowerContextTimeout(ctx context.Context, timeout time.Duration) (context.Context, context.CancelFunc)

func ParseEndpointArgs

func ParseEndpointArgs(endpoint_strings []string, yaml_config_properties []string, endpointsConfigName string) (viper_endpoints *viper.Viper, err error)

func ParseTransactionResult

func ParseTransactionResult(transactionResult string) (string, int)

func ValidateEndpoint

func ValidateEndpoint(endpoint string, apiInterface string) error

Types

type AuthConfig

type AuthConfig struct {
	AuthHeaders map[string]string `yaml:"auth-headers,omitempty" json:"auth-headers,omitempty" mapstructure:"auth-headers"`
	AuthQuery   string            `yaml:"auth-query,omitempty" json:"auth-query,omitempty" mapstructure:"auth-query"`
}

func (*AuthConfig) AddAuthPath

func (ac *AuthConfig) AddAuthPath(url string) string

type NodeUrl

type NodeUrl struct {
	Url          string     `yaml:"url,omitempty" json:"url,omitempty" mapstructure:"url"`
	AuthConfig   AuthConfig `yaml:"auth-config,omitempty" json:"auth-config,omitempty" mapstructure:"auth-config"`
	IpForwarding bool       `yaml:"ip-forwarding,omitempty" json:"ip-forwarding,omitempty" mapstructure:"ip-forwarding"`
}

func (*NodeUrl) SetAuthHeaders

func (url *NodeUrl) SetAuthHeaders(ctx context.Context, headerSetter func(string, string))

func (*NodeUrl) SetIpForwardingIfNecessary

func (url *NodeUrl) SetIpForwardingIfNecessary(ctx context.Context, headerSetter func(string, string))

func (*NodeUrl) String

func (url *NodeUrl) String() string

type RPCConsumerLogs

type RPCConsumerLogs struct {
	MetricService   *metrics.MetricService
	StoreMetricData bool
	// contains filtered or unexported fields
}

func NewRPCConsumerLogs

func NewRPCConsumerLogs() (*RPCConsumerLogs, error)

func (*RPCConsumerLogs) AddMetricForGrpc

func (pl *RPCConsumerLogs) AddMetricForGrpc(data *metrics.RelayMetrics, err error, metadataValues *metadata.MD)

func (*RPCConsumerLogs) AddMetricForHttp

func (pl *RPCConsumerLogs) AddMetricForHttp(data *metrics.RelayMetrics, err error, headers map[string]string)

func (*RPCConsumerLogs) AddMetricForWebSocket

func (pl *RPCConsumerLogs) AddMetricForWebSocket(data *metrics.RelayMetrics, err error, c *websocket.Conn)

func (*RPCConsumerLogs) AnalyzeWebSocketErrorAndWriteMessage

func (pl *RPCConsumerLogs) AnalyzeWebSocketErrorAndWriteMessage(c *websocket.Conn, mt int, err error, msgSeed string, msg []byte, rpcType string)

Websocket healthy disconnections throw "websocket: close 1005 (no status)" error, We dont want to alert error monitoring for that purpses.

func (*RPCConsumerLogs) GetMessageSeed

func (pl *RPCConsumerLogs) GetMessageSeed() string

func (*RPCConsumerLogs) GetUniqueGuidResponseForError

func (pl *RPCConsumerLogs) GetUniqueGuidResponseForError(responseError error, msgSeed string) string

Input will be masked with a random GUID if returnMaskedErrors is set to true

func (*RPCConsumerLogs) LogRequestAndResponse

func (pl *RPCConsumerLogs) LogRequestAndResponse(module string, hasError bool, method string, path string, req string, resp string, msgSeed string, err error)

func (*RPCConsumerLogs) LogStartTransaction

func (pl *RPCConsumerLogs) LogStartTransaction(name string) func()

func (*RPCConsumerLogs) LogTestMode

func (rpccl *RPCConsumerLogs) LogTestMode(fiberCtx *fiber.Ctx)

type Test_mode_ctx_key

type Test_mode_ctx_key struct{}