exporterparser

README

A variety of exporters are available to the OpenCensus Service (both Agent and Collector)

Collector

In addition to the normal exporters, the OpenCensus Collector supports a special configuration. queued-exporters offer bounded buffer retry logic for multiple destinations.

queued-exporters:
  omnition: # A friendly name for the processor
    # num-workers is the number of queue workers that will be dequeuing batches and sending them out (default is 10)
    num-workers: 2
    # queue-size is the maximum number of batches allowed in the queue at a given time (default is 5000)
    queue-size: 100
    # retry-on-failure indicates whether queue processor should retry span batches in case of processing failure (default is true)
    retry-on-failure: true
    # backoff-delay is the amount of time a worker waits after a failed send before retrying (default is 5 seconds)
    backoff-delay: 3s
    # sender-type is the type of sender used by this processor, the default is an invalid sender so it forces one to be specified
    sender-type: jaeger-thrift-http
    # configuration of the selected sender-type, in this example jaeger-thrift-http. Which supports 3 settings:
    # collector-endpoint: address of Jaeger collector thrift-http endpoint
    # headers: a map of any additional headers to be sent with each batch (e.g.: api keys, etc)
    # timeout: the timeout for the sender to consider the operation as failed
    jaeger-thrift-http:
      collector-endpoint: "https://ingest.omnition.io"
      headers: { "x-omnition-api-key": "00000000-0000-0000-0000-000000000001" }
      timeout: 5s
  my-org-jaeger: # A second processor with its own configuration options
    num-workers: 2
    queue-size: 100
    retry-on-failure: true
    backoff-delay: 3s
    sender-type: jaeger-thrift-http
    jaeger-thrift-http:
      collector-endpoint: "http://jaeger.local:14268/api/traces"
      timeout: 5s

Documentation

Overview

Package exporterparser provides support for parsing and creating the respective exporters given a YAML configuration payload. For now it currently only provides statically imported OpenCensus exporters like:

• Stackdriver Tracing and Monitoring
• DataDog
• Zipkin

Index

• Constants
• func DatadogTraceExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• func JaegerExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• func KafkaExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• func OpenCensusTraceExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• func PrometheusExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• func StackdriverTraceExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• func ZipkinExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, ...)
• type ZipkinConfig
  • func (zc *ZipkinConfig) EndpointURL() string

Constants

const (
	DefaultZipkinEndpointHostPort = "localhost:9411"
	DefaultZipkinEndpointURL      = "http://" + DefaultZipkinEndpointHostPort + "/api/v2/spans"
)

Default values for Zipkin endpoint.

Functions

func DatadogTraceExportersFromYAML

func DatadogTraceExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

DatadogTraceExportersFromYAML parses the yaml bytes and returns an exporter.TraceExporter targeting Datadog according to the configuration settings.

func JaegerExportersFromYAML

func JaegerExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

JaegerExportersFromYAML parses the yaml bytes and returns exporter.TraceExporters targeting Jaeger according to the configuration settings.

func KafkaExportersFromYAML

func KafkaExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

KafkaExportersFromYAML parses the yaml bytes and returns an exporter.TraceExporter targeting Kafka according to the configuration settings.

func OpenCensusTraceExportersFromYAML

func OpenCensusTraceExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

OpenCensusTraceExportersFromYAML parses the yaml bytes and returns an exporter.TraceExporter targeting OpenCensus Agent/Collector according to the configuration settings.

func PrometheusExportersFromYAML

func PrometheusExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

PrometheusExportersFromYAML parses the yaml bytes and returns exporter.MetricsExporters targeting Prometheus according to the configuration settings. It allows HTTP clients to scrape it on endpoint path "/metrics".

func StackdriverTraceExportersFromYAML

func StackdriverTraceExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

StackdriverTraceExportersFromYAML parses the yaml bytes and returns an exporter.TraceExporter targeting Stackdriver according to the configuration settings.

func ZipkinExportersFromYAML

func ZipkinExportersFromYAML(config []byte) (tes []exporter.TraceExporter, mes []exporter.MetricsExporter, doneFns []func() error, err error)

ZipkinExportersFromYAML parses the yaml bytes and returns an exporter.TraceExporter targeting Zipkin according to the configuration settings.

Types

type ZipkinConfig

type ZipkinConfig struct {
	ServiceName      string         `yaml:"service_name,omitempty"`
	Endpoint         string         `yaml:"endpoint,omitempty"`
	LocalEndpointURI string         `yaml:"local_endpoint,omitempty"`
	UploadPeriod     *time.Duration `yaml:"upload_period,omitempty"`
}

ZipkinConfig holds the configuration of a Zipkin exporter.

func (*ZipkinConfig) EndpointURL

func (zc *ZipkinConfig) EndpointURL() string

EndpointURL returns the endpoint URL of the Zipkin configuration.