tracing

Documentation

Index

• Variables
• func AddSpanFromTraceparentAttribute(ctx context.Context, name string, event cloudevents.Event) (context.Context, error)
• func AddTraceparentAttributeFromContext(ctx context.Context, event cloudevents.Event) cloudevents.Event
• func BrokerFilterName(args BrokerFilterNameArgs) string
• func BrokerIngressName(args BrokerIngressNameArgs) string
• func SetupDynamicPublishing(logger *zap.SugaredLogger, configMapWatcher *configmap.InformedWatcher, ...) error
• func SetupStaticPublishing(logger *zap.SugaredLogger, serviceName string, cfg *tracingconfig.Config) error
• type BrokerFilterNameArgs
• type BrokerIngressNameArgs

Variables

var (
	// OnePercentSampling is a configuration that samples 1% of the requests.
	// TODO(#1712): Remove this and pull "static" configuration from the
	// environment instead.
	OnePercentSampling = &tracingconfig.Config{
		Backend:        tracingconfig.Zipkin,
		Debug:          false,
		SampleRate:     0.01,
		ZipkinEndpoint: "http://zipkin.istio-system.svc.cluster.local:9411/api/v2/spans",
	}

	// AlwaysSample is a configuration that samples 100% of the requests and sends them to Zipkin.
	// It is expected to be used only for testing purposes (e.g. in e2e tests).
	// TODO(#1712): Remove this and pull "static" configuration from the environment instead.
	AlwaysSample = &tracingconfig.Config{
		Backend:        tracingconfig.Zipkin,
		Debug:          true,
		SampleRate:     1.0,
		ZipkinEndpoint: "http://zipkin.istio-system.svc.cluster.local:9411/api/v2/spans",
	}
)

Functions

func AddSpanFromTraceparentAttribute

func AddSpanFromTraceparentAttribute(ctx context.Context, name string, event cloudevents.Event) (context.Context, error)

AddSpanFromTraceparentAttribute extracts the traceparent extension attribute from the CloudEvent and returns a context with that span set. If the traceparent extension attribute is not found or cannot be parsed, then an error is returned.

func AddTraceparentAttributeFromContext

func AddTraceparentAttributeFromContext(ctx context.Context, event cloudevents.Event) cloudevents.Event

AddTraceparentAttributeFromContext returns a CloudEvent that is identical to the input event, with the traceparent CloudEvents extension attribute added. The value for that attribute is the Span stored in the context.

The context is expected to have passed through the OpenCensus HTTP Handler, so that the Span has been added to it.

func BrokerFilterName

func BrokerFilterName(args BrokerFilterNameArgs) string

BrokerFilterName creates the service name for Broker Filters to use when writing traces.

func BrokerIngressName

func BrokerIngressName(args BrokerIngressNameArgs) string

BrokerIngressName creates the service name for Broker Ingresses to use when writing Zipkin traces.

func SetupDynamicPublishing

func SetupDynamicPublishing(logger *zap.SugaredLogger, configMapWatcher *configmap.InformedWatcher, serviceName string) error

SetupDynamicPublishing sets up trace publishing for the process, by watching a ConfigMap for the configuration. Note that other pieces still need to generate the traces, this just ensures that if generated, they are collected appropriately. This is normally done by using tracing.HTTPSpanMiddleware as a middleware HTTP handler. The configuration will be dynamically updated when the ConfigMap is updated.

func SetupStaticPublishing

func SetupStaticPublishing(logger *zap.SugaredLogger, serviceName string, cfg *tracingconfig.Config) error

SetupStaticPublishing sets up trace publishing for the process. Note that other pieces still need to generate the traces, this just ensures that if generated, they are collected appropriately. This is normally done by using tracing.HTTPSpanMiddleware as a middleware HTTP handler. The configuration will not be dynamically updated.

Types

type BrokerFilterNameArgs

type BrokerFilterNameArgs struct {
	Namespace  string
	BrokerName string
}

BrokerFilterNameArgs are the arguments needed to generate the BrokerFilterName.

type BrokerIngressNameArgs

type BrokerIngressNameArgs struct {
	Namespace  string
	BrokerName string
}

BrokerIngressNameArgs are the arguments needed to generate the BrokerIngressName.