opencensus

README

KrakenD opencensus

A set of building blocks for instrumenting KakenD gateways

Available middlewares

There are the avaliable middlewares to add to the KrakenD pipes.

1. Backend
2. Proxy
3. Router

Available router flavours

1. mux Mux based routers and handlers
2. gin Gin based routers and handlers

Check the examples and the documentation for more details

Documentation

Index

• Constants
• Variables
• func BackendFactory(bf proxy.BackendFactory) proxy.BackendFactory
• func HTTPRequestExecutor(clientFactory transport.HTTPClientFactory) transport.HTTPRequestExecutor
• func IsBackendEnabled() bool
• func IsPipeEnabled() bool
• func IsRouterEnabled() bool
• func Middleware(name string) proxy.Middleware
• func NewHTTPClient(ctx context.Context) *http.Client
• func ProxyFactory(pf proxy.Factory) proxy.FactoryFunc
• func Register(ctx context.Context, srvCfg config.ServiceConfig, vs ...*view.View) error
• func RegisterExporterFactories(ef ExporterFactory)
• type Config
• type EnabledLayers
• type ExporterFactory
• type InfluxDBConfig
• type JaegerConfig
• type OcagentConfig
• type PrometheusConfig
• type StackdriverConfig
• type XrayConfig
• type ZipkinConfig

Constants

const (
	ContextKey = "opencensus-request-span"
	Namespace  = "github_com/devopsfaith/krakend-opencensus"
)

Variables

var (
	DefaultViews = []*view.View{
		ochttp.ClientSentBytesDistribution,
		ochttp.ClientReceivedBytesDistribution,
		ochttp.ClientRoundtripLatencyDistribution,
		ochttp.ClientCompletedCount,

		ochttp.ServerRequestCountView,
		ochttp.ServerRequestBytesView,
		ochttp.ServerResponseBytesView,
		ochttp.ServerLatencyView,
		ochttp.ServerRequestCountByMethod,
		ochttp.ServerResponseCountByStatusCode,
	}
)

Functions

func BackendFactory

func BackendFactory(bf proxy.BackendFactory) proxy.BackendFactory

func HTTPRequestExecutor

func HTTPRequestExecutor(clientFactory transport.HTTPClientFactory) transport.HTTPRequestExecutor

func IsBackendEnabled

func IsBackendEnabled() bool

func IsPipeEnabled

func IsPipeEnabled() bool

func IsRouterEnabled

func IsRouterEnabled() bool

func Middleware

func Middleware(name string) proxy.Middleware

func NewHTTPClient

func NewHTTPClient(ctx context.Context) *http.Client

func ProxyFactory

func ProxyFactory(pf proxy.Factory) proxy.FactoryFunc

func Register

func Register(ctx context.Context, srvCfg config.ServiceConfig, vs ...*view.View) error

func RegisterExporterFactories

func RegisterExporterFactories(ef ExporterFactory)

Types

type Config

type Config struct {
	SampleRate      int            `json:"sample_rate"`
	ReportingPeriod int            `json:"reporting_period"`
	EnabledLayers   *EnabledLayers `json:"enabled_layers"`
	Exporters       struct {
		InfluxDB    *InfluxDBConfig    `json:"influxdb"`
		Zipkin      *ZipkinConfig      `json:"zipkin"`
		Jaeger      *JaegerConfig      `json:"jaeger"`
		Prometheus  *PrometheusConfig  `json:"prometheus"`
		Logger      *struct{}          `json:"logger"`
		Xray        *XrayConfig        `json:"xray"`
		Stackdriver *StackdriverConfig `json:"stackdriver"`
		Ocagent     *OcagentConfig     `json:"ocagent"`
	} `json:"exporters"`
}

type EnabledLayers

type EnabledLayers struct {
	Router  bool `json:"router"`
	Pipe    bool `json:"pipe"`
	Backend bool `json:"backend"`
}

type ExporterFactory

type ExporterFactory func(context.Context, Config) (interface{}, error)

type InfluxDBConfig

type InfluxDBConfig struct {
	Address      string `json:"address"`
	Username     string `json:"username"`
	Password     string `json:"password"`
	Timeout      string `json:"timeout"`
	PingEnabled  bool   `json:"ping"`
	Database     string `json:"db"`
	InstanceName string `json:"service_name"`
	BufferSize   int    `json:"buffer_size"`
}

type JaegerConfig

type JaegerConfig struct {
	Endpoint    string `json:"endpoint"`
	ServiceName string `json:"service_name"`
}

type OcagentConfig

type OcagentConfig struct {
	Address            string            `json:"address"`
	ServiceName        string            `json:"service_name"`
	Headers            map[string]string `json:"headers"`
	Insecure           bool              `json:"insecure"`
	Reconnection       string            `json:"reconnection"`
	EnaableCompression bool              `json:"enable_compression"`
}

type PrometheusConfig

type PrometheusConfig struct {
	Namespace string `json:"namespace"`
	Port      int    `json:"port"`
}

type StackdriverConfig

type StackdriverConfig struct {
	ProjectID     string            `json:"project_id"`
	MetricPrefix  string            `json:"metric_prefix"`
	DefaultLabels map[string]string `json:"default_labels"`
}

type XrayConfig

type XrayConfig struct {
	UseEnv    bool   `json:"use_env"`
	Region    string `json:"region"`
	AccessKey string `json:"access_key_id"`
	SecretKey string `json:"secret_access_key"`
	Version   string `json:"version"`
}

type ZipkinConfig

type ZipkinConfig struct {
	CollectorURL string `json:"collector_url"`
	ServiceName  string `json:"service_name"`
	IP           string `json:"ip"`
	Port         int    `json:"port"`
}