jaegerreceiver

README

Jaeger Receiver

Receives trace data in Jaeger format.

By default, the Jaeger receiver will not serve any protocol. A protocol must be named under the protocols object for the jaeger receiver to start. The below protocols are supported and each supports an optional endpoint object configuration parameter.

• grpc (default endpoint = 0.0.0.0:14250)
• thrift_binary (default endpoint = 0.0.0.0:6832)
• thrift_compact (default endpoint = 0.0.0.0:6831)
• thrift_http (default endpoint = 0.0.0.0:14268)

Examples:

receivers:
  jaeger:
    protocols:
      grpc:
  jaeger/withendpoint:
    protocols:
      grpc:
        endpoint: 0.0.0.0:14260

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

Communicating over TLS

The Jaeger receiver supports communication using Transport Layer Security (TLS), but only using the grpc protocol. It can be configured by specifying a tls_credentials object in the grpc object receiver configuration.

receivers:
  jaeger:
    protocols:
      grpc:
        tls_credentials:
          key_file: /key.pem # path to private key
          cert_file: /cert.pem # path to certificate

Remote Sampling

The Jaeger receiver also supports fetching sampling configuration from a remote collector. It works by proxying client requests for remote sampling configuration to the configured collector.

    +------------+                   +-----------+              +---------------+
    |            |       get         |           |    proxy     |               |
    |   client   +---  sampling ---->+   agent   +------------->+   collector   |
    |            |     strategy      |           |              |               |
    +------------+                   +-----------+              +---------------+

Remote sample proxying can be enabled by specifying the following lines in the jaeger receiver config:

receivers:
  jaeger:
    protocols:
      grpc:
    remote_sampling:
      fetch_endpoint: "jaeger-collector:1234"

Remote sampling can also be directly served by the collector by providing a sampling json file:

receivers:
  jaeger:
    protocols:
      grpc:
    remote_sampling:
      strategy_file: "/etc/strategy.json"

Note: the grpc protocol must be enabled for this to work as Jaeger serves its remote sampling strategies over gRPC.

Documentation

Index

• func New(instanceName string, config *Configuration, ...) (component.TraceReceiver, error)
• func NewFactory() component.ReceiverFactory
• type Config
• type Configuration
• type Protocols
• type RemoteSamplingConfig

Functions

func New

func New(
	instanceName string,
	config *Configuration,
	nextConsumer consumer.TraceConsumer,
	params component.ReceiverCreateParams,
) (component.TraceReceiver, error)

New creates a TraceReceiver that receives traffic as a Jaeger collector, and also as a Jaeger agent.

func NewFactory

func NewFactory() component.ReceiverFactory

Types

type Config

type Config struct {
	configmodels.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	Protocols                     `mapstructure:"protocols"`
	RemoteSampling                *RemoteSamplingConfig `mapstructure:"remote_sampling"`
}

Config defines configuration for Jaeger receiver.

type Configuration

type Configuration struct {
	CollectorThriftPort  int
	CollectorHTTPPort    int
	CollectorGRPCPort    int
	CollectorGRPCOptions []grpc.ServerOption

	AgentCompactThriftPort       int
	AgentBinaryThriftPort        int
	AgentHTTPPort                int
	RemoteSamplingClientSettings configgrpc.GRPCClientSettings
	RemoteSamplingStrategyFile   string
}

Configuration defines the behavior and the ports that the Jaeger receiver will use.

type Protocols

type Protocols struct {
	GRPC          *configgrpc.GRPCServerSettings         `mapstructure:"grpc"`
	ThriftHTTP    *confighttp.HTTPServerSettings         `mapstructure:"thrift_http"`
	ThriftBinary  *configprotocol.ProtocolServerSettings `mapstructure:"thrift_binary"`
	ThriftCompact *configprotocol.ProtocolServerSettings `mapstructure:"thrift_compact"`
}

type RemoteSamplingConfig

type RemoteSamplingConfig struct {
	HostEndpoint                  string `mapstructure:"host_endpoint"`
	StrategyFile                  string `mapstructure:"strategy_file"`
	configgrpc.GRPCClientSettings `mapstructure:",squash"`
}

RemoteSamplingConfig defines config key for remote sampling fetch endpoint