jaegerstorage

README

jaeger_storage

This module implements an extension that allows to configure different storage backends that implement Jaeger's V1 storage APIs. The usual OpenTelemetry Collector's pipeline of receiver-processor-exporter does not require this because each exporter can be supporting just one storage backend, and many of then can be wired up via the pipeline. But in order to run jaeger-query service, which is not a part of the pipeline, we need the ability to access a shared storage backend implementations, and this extension serves as such shared container.

Configuration

The extension can declare multiple storage backend implementations, separating them by storage type first, and then by user-assigned names. Here's an example that may lets query-service extension use Cassandra as the main backend, but memory storage as Dependencies store:

jaeger_storage:
  memory:
    memstore:
      max_traces: 100000
  cassandra:
    cassandra_primary:
      servers: [...]
      namespace: jaeger
    cassandra_archive:
      servers: [...]
      namespace: jaeger_archive

jaeger_query:
    trace_storage: cassandra_primary
    trace_archive: cassandra_archive
    dependencies: memstore
    metrics_store: prometheus_store

NB: this is work in progress, only memory section is currently supported.

Documentation

Index

• Variables
• func GetMetricsFactory(name string, host component.Host) (storage.MetricsFactory, error)
• func GetStorageFactory(name string, host component.Host) (storage.Factory, error)
• func GetStorageFactoryV2(name string, host component.Host) (spanstore.Factory, error)
• func NewFactory() extension.Factory
• type Backend
  • func (cfg *Backend) Unmarshal(conf *confmap.Conf) error
• type Config
  • func (cfg *Config) Validate() error
• type Extension
• type MetricBackends
  • func (cfg *MetricBackends) Unmarshal(conf *confmap.Conf) error

Variables

var ID = component.NewID(componentType)

ID is the identifier of this extension.

Functions

func GetMetricsFactory

func GetMetricsFactory(name string, host component.Host) (storage.MetricsFactory, error)

GetMetricsFactory locates the extension in Host and retrieves a metrics factory from it with the given name.

func GetStorageFactory

func GetStorageFactory(name string, host component.Host) (storage.Factory, error)

GetStorageFactory locates the extension in Host and retrieves a storage factory from it with the given name.

func GetStorageFactoryV2

func GetStorageFactoryV2(name string, host component.Host) (spanstore.Factory, error)

func NewFactory

func NewFactory() extension.Factory

Types

type Backend

type Backend struct {
	Memory        *memory.Configuration `mapstructure:"memory"`
	Badger        *badger.Config        `mapstructure:"badger"`
	GRPC          *grpc.Config          `mapstructure:"grpc"`
	Cassandra     *cassandra.Options    `mapstructure:"cassandra"`
	Elasticsearch *esCfg.Configuration  `mapstructure:"elasticsearch"`
	Opensearch    *esCfg.Configuration  `mapstructure:"opensearch"`
}

func (*Backend) Unmarshal

func (cfg *Backend) Unmarshal(conf *confmap.Conf) error

Unmarshal implements confmap.Unmarshaler. This allows us to provide defaults for different configs. It cannot be done in createDefaultConfig() because at that time we don't know which backends the user wants to use.

type Config

type Config struct {
	Backends       map[string]Backend        `mapstructure:"backends"`
	MetricBackends map[string]MetricBackends `mapstructure:"metric_backends"`
}

Config contains configuration(s) for jaeger trace storage. Keys in the map are storage names that can be used to refer to them from other components, e.g. from jaeger_storage_exporter or jaeger_query. We tried to alias this type directly to a map, but conf did not populated it correctly. Note also that the Backend struct has a custom unmarshaler.

func (*Config) Validate

func (cfg *Config) Validate() error

type Extension

type Extension interface {
	extension.Extension
	TraceStorageFactory(name string) (storage.Factory, bool)
	MetricStorageFactory(name string) (storage.MetricsFactory, bool)
}

type MetricBackends

type MetricBackends struct {
	Prometheus *promCfg.Configuration `mapstructure:"prometheus"`
}

func (*MetricBackends) Unmarshal

func (cfg *MetricBackends) Unmarshal(conf *confmap.Conf) error