orbreceiver

README

OTLP Receiver

Status
Stability	traces stable
	metrics stable
	logs beta
Supported pipeline types	traces, metrics, logs
Distributions	core, contrib

Receives data via gRPC or HTTP using OTLP format.

Getting Started

All that is required to enable the OTLP receiver is to include it in the receiver definitions. A protocol can be disabled by simply not specifying it in the list of protocols.

receivers:
  otlp:
    protocols:
      grpc:
      http:

The following settings are configurable:

• endpoint (default = 0.0.0.0:4317 for grpc protocol, 0.0.0.0:4318 http protocol): host:port to which the receiver is going to receive data. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md.

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

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

Writing with HTTP/JSON

The OTLP 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. Note the serialization format needs to be protobuf JSON.

To write traces with HTTP/JSON, POST to [address]/v1/traces for traces, to [address]/v1/metrics for metrics, to [address]/v1/logs for logs. The default port is 4318.

CORS (Cross-origin resource sharing)

The HTTP/JSON endpoint can also optionally configure CORS under cors:. Specify what origins (or wildcard patterns) to allow requests from as allowed_origins. To allow additional request headers outside of the default safelist, set allowed_headers. Browsers can be instructed to cache responses to preflight requests by setting max_age.

receivers:
  otlp:
    protocols:
      http:
        endpoint: "localhost:4318"
        cors:
          allowed_origins:
            - http://test.com
            # Origins can have wildcards with *, use * by itself to match any origin.
            - https://*.example.com
          allowed_headers:
            - Example-Header
          max_age: 7200

Documentation

Index

• Constants
• func CreateDefaultConfig() component.Config
• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error
  • func (cfg *Config) Validate() error
• type OrbReceiver
  • func NewOrbReceiver(ctx context.Context, cfg *Config, settings receiver.CreateSettings) *OrbReceiver
  • func (r *OrbReceiver) DecompressBrotli(data []byte) []byte
  • func (r *OrbReceiver) MessageLogsInbound(msg messaging.Message) error
  • func (r *OrbReceiver) MessageMetricsInbound(msg messaging.Message) error
  • func (r *OrbReceiver) MessageTracesInbound(msg messaging.Message) error
  • func (r *OrbReceiver) ProccessLogsContext(scope plog.ScopeLogs, channel string, size int)
  • func (r *OrbReceiver) ProccessMetricsContext(scope pmetric.ScopeMetrics, channel string, size int)
  • func (r *OrbReceiver) ProccessTracesContext(scope ptrace.ScopeSpans, channel string, size int)
  • func (r *OrbReceiver) Shutdown(ctx context.Context) error
  • func (r *OrbReceiver) Start(ctx context.Context, _ component.Host) error

Constants

const (
	OtelMetricsTopic = "otlp.*.m.>"
	OtelLogsTopic    = "otlp.*.l.>"
	OtelTraceTopic   = "otlp.*.t.>"
)

Functions

func CreateDefaultConfig

func CreateDefaultConfig() component.Config

createDefaultConfig creates the default configuration for receiver.

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a new OTLP receiver factory.

Types

type Config

type Config struct {
	Logger *zap.Logger
	// Entry from Metrics
	PubSub mfnats.PubSub
	// Entry for Accessing DataSets, AgentGroup and Sinks
	SinkerService *bridgeservice.SinkerOtelBridgeService
}

Config defines configuration for OTLP receiver.

func (*Config) Unmarshal

func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error

Unmarshal a confmap.Conf into the config struct.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks the receiver configuration is valid

type OrbReceiver

type OrbReceiver struct {
	// contains filtered or unexported fields
}

OrbReceiver is the type that exposes Trace and Metrics reception.

func NewOrbReceiver

func NewOrbReceiver(ctx context.Context, cfg *Config, settings receiver.CreateSettings) *OrbReceiver

NewOrbReceiver just creates the OpenTelemetry receiver services. It is the caller's responsibility to invoke the respective Start*Reception methods as well as the various Stop*Reception methods to end it.

func (*OrbReceiver) DecompressBrotli

func (r *OrbReceiver) DecompressBrotli(data []byte) []byte

func (*OrbReceiver) MessageLogsInbound

func (r *OrbReceiver) MessageLogsInbound(msg messaging.Message) error

func (*OrbReceiver) MessageMetricsInbound

func (r *OrbReceiver) MessageMetricsInbound(msg messaging.Message) error

func (*OrbReceiver) MessageTracesInbound

func (r *OrbReceiver) MessageTracesInbound(msg messaging.Message) error

func (*OrbReceiver) ProccessLogsContext

func (r *OrbReceiver) ProccessLogsContext(scope plog.ScopeLogs, channel string, size int)

func (*OrbReceiver) ProccessMetricsContext

func (r *OrbReceiver) ProccessMetricsContext(scope pmetric.ScopeMetrics, channel string, size int)

func (*OrbReceiver) ProccessTracesContext

func (r *OrbReceiver) ProccessTracesContext(scope ptrace.ScopeSpans, channel string, size int)

func (*OrbReceiver) Shutdown

func (r *OrbReceiver) Shutdown(ctx context.Context) error

Shutdown is a method to turn off receiving.

func (*OrbReceiver) Start

func (r *OrbReceiver) Start(ctx context.Context, _ component.Host) error

Start appends the message channel that Orb-Sinker will deliver the message