opencensusexporter

README

OpenCensus gRPC Exporter

Status
Stability	beta: traces, metrics
Distributions	core, contrib
Issues
Code Owners	@open-telemetry/collector-approvers

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

Getting Started

The following settings are required:

• endpoint (no default): host:port to which the exporter is going to send Jaeger trace data, using the gRPC protocol. The valid syntax is described in grpc's naming.md.

By default, TLS is enabled and must be configured under tls::

• insecure (default = false): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required under tls::

• cert_file (no default): path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
• key_file (no default): path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.

Example:

exporters:
  opencensus:
    endpoint: opencensus2:55678
    tls:
      cert_file: file.cert
      key_file: file.key
  opencensus/2:
    endpoint: opencensus2:55678
    tls:
      insecure: true

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

• gRPC settings
• TLS and mTLS settings
• Queuing, retry and timeout settings

Documentation

Overview

Package opencensusexporter exports data to an OpenCensus agent.

Index

• func NewFactory() exporter.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for OTLP exporter.

Types

type Config

type Config struct {
	configgrpc.ClientConfig   `mapstructure:",squash"`   // squash ensures fields are correctly decoded in embedded struct.
	QueueSettings             exporterhelper.QueueConfig `mapstructure:"sending_queue"`
	configretry.BackOffConfig `mapstructure:"retry_on_failure"`

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

Config defines configuration for OpenCensus exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid