httpsinkexporter

README

HTTP Sink Exporter

This component is for testing purposes only. It does not redact or filter any telemetry content it exposes and should not be used with production data.

This exporter makes span data available via a HTTP endpoint. The endpoint accepts requests for spans or metrics with specific characteristics and blocks until the exporter receives matching data or the request times out. Once the requested data is detected, it is returned back to the client as JSON.

Spans are returned as JSON encoding using Jaeger protocol. We plan to switch this to OTLP in future.

Metrics are returned as JSON encoding using the OTLP protocol.

Please note that there is no guarantee that exact field names will remain stable. This is intended primarily for automatic and manual testing (and occasional debugging) observability pipelines without setting up backends.

Supported pipeline types: traces, metrics.

Getting Started

The following settings are required:

• endpoint (defaults to 0.0.0.0:8378).

Example:

exporters:
  httpsink:
    endpoint: "0.0.0.0:8378"

Example usage:

• Splunk Otel Python uses this to implement end to end tests.
• Splunk Otel JS uses this to implement tests.
• Used internally at Splunk for occasional debugging.

Documentation

Index

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

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for httpsink exporter.

Types

type Config

type Config struct {
	Endpoint string `mapstructure:"endpoint"`
}

Config defines configuration for file exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid