README

OpenCensus Receiver

Receives data via gRPC or HTTP using OpenCensus format.

Supported pipeline types: traces, metrics

Getting Started

All that is required to enable the OpenCensus receiver is to include it in the receiver definitions.

receivers:
  opencensus:

The following settings are configurable:

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

Writing with HTTP/JSON

The OpenCensus receiver can receive trace export calls via HTTP/JSON in addition to gRPC. The HTTP/JSON address is the same as gRPC as the protocol is recognized and processed accordingly.

To write traces with HTTP/JSON, POST to [address]/v1/trace. The JSON message format parallels the gRPC protobuf format, see this OpenApi spec for it.

The HTTP/JSON endpoint can also optionally configure CORS, which is enabled by specifying a list of allowed CORS origins in the cors_allowed_origins field:

receivers:
  opencensus:
    cors_allowed_origins:
    - http://test.com
    # Origins can have wildcards with *, use * by itself to match any origin.
    - https://*.example.com
Expand ▾ Collapse ▴

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

    NewFactory creates a new OpenCensus receiver factory.

    Types

    type Config

    type Config struct {
    	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
    
    	// Configures the receiver server protocol.
    	configgrpc.GRPCServerSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
    
    	// CorsOrigins are the allowed CORS origins for HTTP/JSON requests to grpc-gateway adapter
    	// for the OpenCensus receiver. See github.com/rs/cors
    	// An empty list means that CORS is not enabled at all. A wildcard (*) can be
    	// used to match any origin or one or more characters of an origin.
    	CorsOrigins []string `mapstructure:"cors_allowed_origins"`
    }

      Config defines configuration for OpenCensus receiver.

      func (*Config) Validate

      func (cfg *Config) Validate() error

        Validate checks the receiver configuration is valid

        Directories

        Path Synopsis
        Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance.
        Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance.
        Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TraceReceiverSink instance.
        Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TraceReceiverSink instance.