opencensusexporter

README

OpenCensus Exporter

Exports traces and/or metrics to another Collector via gRPC using OpenCensus format.

The following settings are required:

• endpoint: target to which the exporter is going to send traces or metrics, using the gRPC protocol. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md.

The following settings can be optionally configured:

• cert_pem_file: certificate file for TLS credentials of gRPC client. Should only be used if secure is set to true.
• compression: compression key for supported compression types within collector. Currently the only supported mode is gzip.
• headers: the headers associated with gRPC requests.
• keepalive: keepalive parameters for client gRPC. See grpc.WithKeepaliveParams().
• num_workers (default = 2): number of workers that send the gRPC requests. Optional.
• reconnection_delay: time period between each reconnection performed by the exporter.
• secure: whether to enable client transport security for the exporter's gRPC connection. See grpc.WithInsecure().

Example:

exporters:
  opencensus:
    endpoint: 0.0.0.0:14250
    reconnection_delay: 60s
    secure: false

The full list of settings exposed for this exporter are documented here with detailed sample configurations here.

Documentation

Index

• func NewMetricsExporter(logger *zap.Logger, config configmodels.Exporter, ...) (component.MetricsExporterOld, error)
• func NewTraceExporter(logger *zap.Logger, config configmodels.Exporter, ...) (component.TraceExporterOld, error)
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() configmodels.Exporter
  • func (f *Factory) CreateMetricsExporter(logger *zap.Logger, config configmodels.Exporter) (component.MetricsExporterOld, error)
  • func (f *Factory) CreateTraceExporter(logger *zap.Logger, config configmodels.Exporter) (component.TraceExporterOld, error)
  • func (f *Factory) OCAgentOptions(logger *zap.Logger, ocac *Config) ([]ocagent.ExporterOption, error)
  • func (f *Factory) Type() configmodels.Type

Functions

func NewMetricsExporter

func NewMetricsExporter(logger *zap.Logger, config configmodels.Exporter, opts ...ocagent.ExporterOption) (component.MetricsExporterOld, error)

NewMetricsExporter creates an Open Census metrics exporter.

func NewTraceExporter

func NewTraceExporter(logger *zap.Logger, config configmodels.Exporter, opts ...ocagent.ExporterOption) (component.TraceExporterOld, error)

NewTraceExporter creates an Open Census trace exporter.

Types

type Config

type Config struct {
	configmodels.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	configgrpc.GRPCClientSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	// The number of workers that send the gRPC requests.
	NumWorkers int `mapstructure:"num_workers"`

	// The time period between each reconnection performed by the exporter.
	ReconnectionDelay time.Duration `mapstructure:"reconnection_delay,omitempty"`
}

Config defines configuration for OpenCensus exporter.

type Factory

type Factory struct {
}

Factory is the factory for OpenCensus exporter.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() configmodels.Exporter

CreateDefaultConfig creates the default configuration for exporter.

func (*Factory) CreateMetricsExporter

func (f *Factory) CreateMetricsExporter(logger *zap.Logger, config configmodels.Exporter) (component.MetricsExporterOld, error)

CreateMetricsExporter creates a metrics exporter based on this config.

func (*Factory) CreateTraceExporter

func (f *Factory) CreateTraceExporter(logger *zap.Logger, config configmodels.Exporter) (component.TraceExporterOld, error)

CreateTraceExporter creates a trace exporter based on this config.

func (*Factory) OCAgentOptions

func (f *Factory) OCAgentOptions(logger *zap.Logger, ocac *Config) ([]ocagent.ExporterOption, error)

OCAgentOptions takes the oc exporter Config and generates ocagent Options

func (*Factory) Type

func (f *Factory) Type() configmodels.Type

Type gets the type of the Exporter config created by this factory.