storage

Documentation

Index

• type Configuration
  • func (cfg *Configuration) GetSpansArchiveTable() clickhousespanstore.TableName
• type EncodingType
• type Store
  • func NewStore(logger hclog.Logger, cfg Configuration) (*Store, error)
  • func (s *Store) ArchiveSpanReader() spanstore.Reader
  • func (s *Store) ArchiveSpanWriter() spanstore.Writer
  • func (s *Store) Close() error
  • func (s *Store) DependencyReader() dependencystore.Reader
  • func (s *Store) SpanReader() spanstore.Reader
  • func (s *Store) SpanWriter() spanstore.Writer
  • func (s *Store) StreamingSpanWriter() spanstore.Writer

Types

type Configuration

type Configuration struct {
	// Batch write size. Default is 10_000.
	BatchWriteSize int64 `yaml:"batch_write_size"`
	// Batch flush interval. Default is 5s.
	BatchFlushInterval time.Duration `yaml:"batch_flush_interval"`
	// Maximal amount of spans that can be pending writes at a time.
	// New spans exceeding this limit will be discarded,
	// keeping memory in check if there are issues writing to ClickHouse.
	// Check the "jaeger_clickhouse_discarded_spans" metric to keep track of discards.
	// Default 10_000_000, or disable the limit entirely by setting to 0.
	MaxSpanCount int `yaml:"max_span_count"`
	// Encoding either json or protobuf. Default is json.
	Encoding EncodingType `yaml:"encoding"`
	// ClickHouse address e.g. localhost:9000.
	Address string `yaml:"address"`
	// Directory with .sql files to run at plugin startup, mainly for integration tests.
	// Depending on the value of init_tables, this can be run as a
	// replacement or supplement to creating default tables for span storage.
	// If init_tables is also enabled, the scripts in this directory will be run first.
	InitSQLScriptsDir string `yaml:"init_sql_scripts_dir"`
	// Whether to automatically attempt to create tables in ClickHouse.
	// By default, this is enabled if init_sql_scripts_dir is empty,
	// or disabled if init_sql_scripts_dir is provided.
	InitTables *bool `yaml:"init_tables"`
	// Indicates location of TLS certificate used to connect to database.
	CaFile string `yaml:"ca_file"`
	// Username for connection to database. Default is "default".
	Username string `yaml:"username"`
	// Password for connection to database.
	Password string `yaml:"password"`
	// Database name. Default is "default"
	Database string `yaml:"database"`
	// Endpoint for scraping prometheus metrics e.g. localhost:9090.
	MetricsEndpoint string `yaml:"metrics_endpoint"`
	// Whether to use SQL scripts supporting replication and sharding. Default false.
	Replication bool `yaml:"replication"`
	// If non-empty, enables multitenancy in SQL scripts, and assigns the tenant name for this instance.
	Tenant string `yaml:"tenant"`
	// Table with spans. Default "jaeger_spans_local" or "jaeger_spans" when replication is enabled.
	SpansTable clickhousespanstore.TableName `yaml:"spans_table"`
	// Span index table. Default "jaeger_index_local" or "jaeger_index" when replication is enabled.
	SpansIndexTable clickhousespanstore.TableName `yaml:"spans_index_table"`
	// Operations table. Default "jaeger_operations_local" or "jaeger_operations" when replication is enabled.
	OperationsTable clickhousespanstore.TableName `yaml:"operations_table"`

	// TTL for data in tables in days. If 0, no TTL is set. Default 0.
	TTLDays uint `yaml:"ttl"`
	// The maximum number of spans to fetch per trace. If 0, no limits is set. Default 0.
	MaxNumSpans uint `yaml:"max_num_spans"`
	// The maximum number of open connections to the database. Default is unlimited (see: https://pkg.go.dev/database/sql#DB.SetMaxOpenConns)
	MaxOpenConns *uint `yaml:"max_open_conns"`
	// The maximum number of database connections in the idle connection pool. Default 2. (see: https://pkg.go.dev/database/sql#DB.SetMaxIdleConns)
	MaxIdleConns *uint `yaml:"max_idle_conns"`
	// The maximum amount of milliseconds a database connection may be reused. Default = connections are never closed due to age (see: https://pkg.go.dev/database/sql#DB.SetConnMaxLifetime)
	ConnMaxLifetimeMillis *uint `yaml:"conn_max_lifetime_millis"`
	// The maximum amount of milliseconds a database connection may be idle. Default = connections are never closed due to idle time (see: https://pkg.go.dev/database/sql#DB.SetConnMaxIdleTime)
	ConnMaxIdleTimeMillis *uint `yaml:"conn_max_idle_time_millis"`
	// contains filtered or unexported fields
}

func (*Configuration) GetSpansArchiveTable

func (cfg *Configuration) GetSpansArchiveTable() clickhousespanstore.TableName

type EncodingType

type EncodingType string

const (
	JSONEncoding     EncodingType = "json"
	ProtobufEncoding EncodingType = "protobuf"
)

type Store

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

func NewStore

func NewStore(logger hclog.Logger, cfg Configuration) (*Store, error)

func (*Store) ArchiveSpanReader

func (s *Store) ArchiveSpanReader() spanstore.Reader

func (*Store) ArchiveSpanWriter

func (s *Store) ArchiveSpanWriter() spanstore.Writer

func (*Store) Close

func (s *Store) Close() error

func (*Store) DependencyReader

func (s *Store) DependencyReader() dependencystore.Reader

func (*Store) SpanReader

func (s *Store) SpanReader() spanstore.Reader

func (*Store) SpanWriter

func (s *Store) SpanWriter() spanstore.Writer

func (*Store) StreamingSpanWriter

func (s *Store) StreamingSpanWriter() spanstore.Writer