opencensusexporter

README

OpenCensus Exporter

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

The following settings are required:

• endpoint: host:port 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:

• insecure (default = false): whether to enable client transport security for the exporter's gRPC connection. See grpc.WithInsecure().
• ca_file path to the CA cert. For a client this verifies the server certificate. Should only be used if insecure is set to false.
• cert_file path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
• key_file path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.
• compression (default = gzip): 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.
• balancer_name(default = pick_first): Sets the balancer in grpclb_policy to discover the servers. See grpc loadbalancing example.
• wait_for_ready: Option not supported.

Example:

exporters:
  opencensus:
    endpoint: otelcol2:55678

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

Documentation

Index

• func NewFactory() component.ExporterFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for OTLP 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"`
}

Config defines configuration for OpenCensus exporter.