config

Documentation

Index

• Constants
• func Error() error
• type MetricConfig
• type MetricsReporterConfig
• type Partition
• type PartitionSchema
• type Rollup
• type Schema
• type SchemaField
• type TableSchema
• type V3ioConfig
  • func GetOrDefaultConfig() (*V3ioConfig, error)
  • func GetOrLoadFromData(data []byte) (*V3ioConfig, error)
  • func GetOrLoadFromFile(path string) (*V3ioConfig, error)
  • func GetOrLoadFromStruct(cfg *V3ioConfig) (*V3ioConfig, error)

Constants

const (
	V3ioConfigEnvironmentVariable = "V3IO_CONF"
	DefaultConfigurationFileName  = "v3io.yaml"
	SchemaConfigFileName          = ".schema"

	DefaultShardingBuckets        = 8
	DefaultStorageClass           = "local"
	DefaultIngestionRate          = ""
	DefaultAggregates             = "" // no aggregates by default
	DefaultAggregationGranularity = "1h"
	DefaultLayerRetentionTime     = "1y"
	DefaultSampleRetentionTime    = 0
)

Functions

func Error

func Error() error

Types

type MetricConfig

type MetricConfig struct {
	Rollups       string `json:"rollups,omitempty"`
	RollupMin     int    `json:"rollupMin,omitempty"`
	DelRawSamples bool   `json:"delRawSamples,omitempty"`
	// Dimensions to pre aggregate (vertical aggregation)
	PreAggragate []string `json:"preAggragate,omitempty"`
}

type MetricsReporterConfig

type MetricsReporterConfig struct {
	ReportOnShutdown   bool   `json:"reportOnShutdown,omitempty"`
	Output             string `json:"output"` // stdout, stderr, syslog, etc.
	ReportPeriodically bool   `json:"reportPeriodically,omitempty"`
	RepotInterval      int    `json:"reportInterval"` // interval between consequence reports (in Seconds)
}

type Partition

type Partition struct {
	StartTime  int64           `json:"startTime"`
	SchemaInfo PartitionSchema `json:"schemaInfo"`
}

type PartitionSchema

type PartitionSchema struct {
	Version                int      `json:"version"`
	Aggregators            []string `json:"aggregators"`
	AggregatorsGranularity string   `json:"aggregatorsGranularity"`
	StorageClass           string   `json:"storageClass"`
	SampleRetention        int      `json:"sampleRetention"`
	PartitionerInterval    string   `json:"partitionerInterval"`
	ChunckerInterval       string   `json:"chunckerInterval"`
}

type Rollup

type Rollup struct {
	Aggregators            []string `json:"aggregators"`
	AggregatorsGranularity string   `json:"aggregatorsGranularity"`
	//["cloud","local"] for the aggregators and sample chunks
	StorageClass string `json:"storageClass"`
	//in hours. 0  means no need to save samples
	SampleRetention int `json:"sampleRetention"`
	// format : 1m, 7d, 3h . Possible intervals: m/d/h
	LayerRetentionTime string `json:"layerRetentionTime"`
}

type Schema

type Schema struct {
	TableSchemaInfo     TableSchema     `json:"tableSchemaInfo"`
	PartitionSchemaInfo PartitionSchema `json:"partitionSchemaInfo"`
	Partitions          []*Partition    `json:"partitions"`
	Fields              []SchemaField   `json:"fields"`
}

type SchemaField

type SchemaField struct {
	Name     string `json:"name"`
	Type     string `json:"type"`
	Nullable bool   `json:"nullable"`
	Items    string `json:"items,omitempty"`
}

type TableSchema

type TableSchema struct {
	Version             int      `json:"version"`
	RollupLayers        []Rollup `json:"rollupLayers"`
	ShardingBuckets     int      `json:"shardingBuckets"`
	PartitionerInterval string   `json:"partitionerInterval"`
	ChunckerInterval    string   `json:"chunckerInterval"`
}

type V3ioConfig

type V3ioConfig struct {
	// V3IO Connection details: Url, Data container, relative path for this dataset, credentials
	WebApiEndpoint string `json:"webApiEndpoint"`
	Container      string `json:"container"`
	TablePath      string `json:"tablePath"`
	Username       string `json:"username,omitempty"`
	Password       string `json:"password,omitempty"`

	// Disable is use in Prometheus to disable v3io and work with the internal TSDB
	Disabled bool `json:"disabled,omitempty"`
	// Set logging level: debug | info | warn | error (info by default)
	LogLevel string `json:"logLevel,omitempty"`
	// Number of parallel V3IO worker routines
	Workers int `json:"workers"`
	// Number of parallel V3IO worker routines for queries (default is min between 8 and Workers)
	QryWorkers int `json:"qryWorkers"`
	// Max uncommitted (delayed) samples allowed per metric
	MaxBehind int `json:"maxBehind"`
	// Override last chunk (by default on restart it will append from the last point if possible)
	OverrideOld bool `json:"overrideOld"`
	// Default timeout duration in Seconds (if not set, 1 Hour timeout will be used )
	DefaultTimeoutInSeconds int `json:"timeout,omitempty"`
	// The size of batch to use during ingestion
	BatchSize int `json:"batchSize,omitempty"`
	// Sample size in bytes in worst compression scenario
	MaximumSampleSize int `json:"maximumSampleSize,omitempty"`
	// Max size of a partition object
	MaximumPartitionSize int `json:"maximumPartitionSize,omitempty"`
	// Size of chunk in bytes for worst an best compression scenarios
	MinimumChunkSize int `json:"minimumChunkSize,omitempty"`
	MaximumChunkSize int `json:"maximumChunkSize,omitempty"`
	ShardingBuckets  int `json:"shardingBuckets,omitempty"`
	// Metrics reporter configuration
	MetricsReporter MetricsReporterConfig `json:"performance,omitempty"`
	// dont aggregate from raw chuncks, for use when working as Prometheus TSDB lib
	DisableClientAggr bool `json:"disableClientAggr,omitempty"`
}

func GetOrDefaultConfig

func GetOrDefaultConfig() (*V3ioConfig, error)

func GetOrLoadFromData

func GetOrLoadFromData(data []byte) (*V3ioConfig, error)

func GetOrLoadFromFile

func GetOrLoadFromFile(path string) (*V3ioConfig, error)

func GetOrLoadFromStruct

func GetOrLoadFromStruct(cfg *V3ioConfig) (*V3ioConfig, error)

update defaults when using config struct