configuration

Documentation

Index

• type API
• type Auth
• type BlockExplorer
• type Controller
• type DB
• type Exporter
• type Log
  • func NewLog() Log
• type Metrics
• type Processor
• type Profefe
• type Replicator
• type TestDB
• type Transformer

Types

type API

type API struct {
	Listen       string        `insconfig:":0| API starts on this address"`
	ReadTimeout  time.Duration `insconfig:"60s| The maximum duration for reading the entire request, including the body"`
	WriteTimeout time.Duration `insconfig:"60s| The maximum duration before timing out writes of the response"`
	DB           DB
	Log          Log
	Metrics      Metrics
	Profefe      Profefe
}

type Auth

type Auth struct {
	// warning: set false only for testing purpose within secured environment
	// if true then have to authorize
	Required      bool          `insconfig:"false| Required authorization or not"`
	URL           string        `insconfig:"https://{heavy.url}/auth/token | URL to auth endpoint"`
	Login         string        `insconfig:"login| Authorization login"`
	Password      string        `insconfig:"password| Authorization password"`
	RefreshOffset int64         `insconfig:"60| Number of seconds remain of token expiration to start token refreshing"`
	Timeout       time.Duration `insconfig:"15s| Timeout specifies a time limit for requests made by Client"`
	// warning: set true only for testing purpose within secured environment
	InsecureTLS bool `insconfig:"false| Transport layer security"`
}

Auth represents the authentication of the Platform

type BlockExplorer

type BlockExplorer struct {
	Log         Log
	DB          DB
	Replicator  Replicator
	Controller  Controller
	Processor   Processor
	Transformer Transformer
	Metrics     Metrics
	Profefe     Profefe
}

type Controller

type Controller struct {
	PulsePeriod      int `insconfig:"10| Seconds between pulse completion tries"`
	SequentialPeriod int `insconfig:"1| Seconds between pulse sequential tries"`
	// recommend to use 20 minutes because of PENV-447
	ReloadPeriod      int `insconfig:"1200| Seconds between reloading data for same pulse tries"`
	ReloadCleanPeriod int `insconfig:"1| Seconds between launching cleaning for reloaded data map"`
}

type DB

type DB struct {
	URL             string        `insconfig:"postgres://postgres:secret@localhost:5432/postgres?sslmode=disable| Path to postgres db"`
	MaxOpenConns    int           `insconfig:"100| The maximum number of open connections to the database"`
	MaxIdleConns    int           `insconfig:"100| The maximum number of connections in the idle"`
	ConnMaxLifetime time.Duration `insconfig:"600s| The maximum amount of time a connection may be reused"`
}

type Exporter

type Exporter struct {
	// Listen specifies address where exporter server starts
	Listen      string        `insconfig:":0| exporter-api gRPC server starts on this address"`
	PulsePeriod time.Duration `insconfig:"10s| Seconds between pulse completion tries"`
	DB          DB
	Log         Log
	Metrics     Metrics
	Profefe     Profefe
}

Exporter holds exporter configuration. Exporter will be used for exporting data for observer-framework Exporter is grpc-base service

type Log

type Log struct {
	// Default level for logger
	Level string `insconfig:"debug| Default level for logger"`
	// Logging adapter - only zerolog by now
	Adapter string `insconfig:"zerolog| Logging adapter - only zerolog by now"`
	// Log output format - e.g. json or text
	Formatter string `insconfig:"text| Log output format - e.g. json or text"`
	// Log output type - e.g. stderr, syslog
	OutputType string `insconfig:"stderr| Log output type - e.g. stderr, syslog"`
	// Write-parallel limit for the output
	OutputParallelLimit string `insconfig:"| Write-parallel limit for the output"`
	// Parameter for output - depends on OutputType
	OutputParams string `insconfig:"| Parameter for output - depends on OutputType"`
	// Number of regular log events that can be buffered, =0 to disable
	BufferSize int `insconfig:"0| Number of regular log events that can be buffered, =0 to disable"`
	// Number of low-latency log events that can be buffered, =-1 to disable, =0 - default size
	LLBufferSize int `insconfig:"0| Number of low-latency log events that can be buffered, =-1 to disable, =0 - default size"`
}

Log holds configuration for logging

func NewLog

func NewLog() Log

NewLog creates new default configuration for logging

type Metrics

type Metrics struct {
	HTTPServerPort  uint32        `insconfig:"8081| http server port"`
	RefreshInterval time.Duration `insconfig:"10s| Refresh metrics interval"`
	StartServer     bool          `insconfig:"true| if true, create http server to expose metrics"`
}

Metrics represents a configuration for expose metrics

type Processor

type Processor struct {
	Workers int `insconfig:"200| The count of workers for processing transformed data"`
}

Processor represents for processing layer

type Profefe

type Profefe struct {
	StartAgent bool   `insconfig:"true| if true, start the profefe agent"`
	Address    string `insconfig:"http://127.0.0.1:10100| Profefe collector public address to send profiling data"`
	Labels     string `insconfig:"host,localhost| Application labels. For example, region,europe-west3,dc,fra"`
}

type Replicator

type Replicator struct {
	PlatformVersion                           int           `insconfig:"1| Platform version, can be 1 or 2"`
	Addr                                      string        `insconfig:"127.0.0.1:5678| The gRPC server address"`
	MaxTransportMsg                           int           `insconfig:"1073741824| Maximum message size the client can send"`
	WaitForConnectionRecoveryTimeout          time.Duration `insconfig:"30s| Connection recovery timeout"`
	ContinuousPulseRetrievingHalfPulseSeconds uint32        `insconfig:"5| Half pulse in seconds"`
	ParallelConnections                       uint32        `insconfig:"100| Maximum parallel pulse retrievers"`
	QueueLen                                  uint32        `insconfig:"500| Max elements in extractor queue"`
	Auth                                      Auth
}

Replicator represents a configuration of the Platform connection

type TestDB

type TestDB struct {
	URL          string `insconfig:"postgres://postgres@localhost/postgres?sslmode=disable| Path to postgres db"`
	PoolSize     int    `insconfig:"100| Maximum number of socket connections"`
	TestPulses   int    `insconfig:"100| amount of generated pulses"`
	TestJetDrops int    `insconfig:"1000| amount of generated jet drops"`
	TestRecords  int    `insconfig:"1000| amount of generated records"`
}

type Transformer

type Transformer struct {
	QueueLen uint32 `insconfig:"500| Max elements in transformer queue"`
}

Transformer transforms raw platform data to canonical GBE data types