proxy

Documentation

Overview

Package proxy provides an http server to act as a signing proxy for SDKs calling AWS X-Ray APIs

Index

• type Config
  • func DefaultConfig() *Config
• type Server
  • func NewServer(cfg *Config, logger *zap.Logger) (Server, error)

Types

type Config

type Config struct {
	// endpoint is the TCP address and port on which this receiver listens for
	// calls from the X-Ray SDK and relays them to the AWS X-Ray backend to
	// get sampling rules and report sampling statistics.
	confignet.TCPAddrConfig `mapstructure:",squash"`

	// ProxyAddress defines the proxy address that the local TCP server
	// forwards HTTP requests to AWS X-Ray backend through.
	ProxyAddress string `mapstructure:"proxy_address"`

	// TLS struct exposes TLS client configuration when forwarding
	// calls to the AWS X-Ray backend.
	TLS configtls.ClientConfig `mapstructure:"tls,omitempty"`

	// Region is the AWS region the local TCP server forwards requests to.
	Region string `mapstructure:"region"`

	// RoleARN is the IAM role used by the local TCP server when
	// communicating with the AWS X-Ray service.
	RoleARN string `mapstructure:"role_arn"`

	// AWSEndpoint is the X-Ray service endpoint which the local
	// TCP server forwards requests to.
	AWSEndpoint string `mapstructure:"aws_endpoint"`

	// LocalMode determines whether the EC2 instance metadata endpoint
	// will be called or not. Set to `true` to skip EC2 instance
	// metadata check.
	LocalMode bool `mapstructure:"local_mode"`

	// ServiceName determines which service the requests are sent to.
	// will be default to `xray`. This is mandatory for SigV4
	ServiceName string `mapstructure:"service_name"`
}

Config is the configuration for the local TCP proxy server.

func DefaultConfig

func DefaultConfig() *Config

type Server

type Server interface {
	ListenAndServe() error
	Shutdown(ctx context.Context) error
}

Server represents HTTP server.

func NewServer

func NewServer(cfg *Config, logger *zap.Logger) (Server, error)

NewServer returns a local TCP server that proxies requests to AWS backend using the given credentials.