scanner

Documentation

Index

• type Config
  • func NewDefaultConfig() *Config
  • func (c *Config) Apply(other *Config)
  • func (c *Config) Check() error
  • func (c *Config) String() string
• type Meta
• type Scanner
  • func NewScanner(cfg *Config, storage storage.Storage) (*Scanner, error)
  • func (s *Scanner) Close() error
  • func (s *Scanner) Run(ctx context.Context, events chan<- *model.Event) error
• type SchemaConfig
  • func (sc *SchemaConfig) Check() error
  • func (sc *SchemaConfig) String() string
• type Stats

Types

type Config

type Config struct {
	IncludePaths           []string
	ExcludeMatchers        []string
	SyncWorkersIntervalSec int
	StateStoreIntervalSec  int
	RecordMaxSizeBytes     int
	EventMaxRecords        int
	Schemas                []*SchemaConfig
}

func NewDefaultConfig

func NewDefaultConfig() *Config

func (*Config) Apply

func (c *Config) Apply(other *Config)

func (*Config) Check

func (c *Config) Check() error

func (*Config) String

func (c *Config) String() string

type Meta

type Meta struct {
	// Tags contains map of key-value pairs
	Tags map[string]string

	// Fields contains map of key-value pairs
	Fields map[string]string
}

Meta descirbes Tags and Fields assignment. Tags and Fields are maps, where key is the value of Tag or Field and the value is a template for the value. The template can contains variables placed in curly braces e.g. "var1={var1} or var2={var2}"...

type Scanner

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

func NewScanner

func NewScanner(cfg *Config, storage storage.Storage) (*Scanner, error)

func (*Scanner) Close

func (s *Scanner) Close() error

func (*Scanner) Run

func (s *Scanner) Run(ctx context.Context, events chan<- *model.Event) error

type SchemaConfig

type SchemaConfig struct {
	// PathMatcher contains a regexp for matching file names. It can contain
	// named groups, which values can be assigned for tags and fields (see Meta field)
	PathMatcher string
	DataFormat  parser.DataFormat
	DateFormats []string
	// Meta describes Tags and fields assignment. It is formded based on PathMather
	// where keys are taken by group names from the regular expression
	Meta Meta
}

SchemaConfig describes the configuration for parsing of the data

func (*SchemaConfig) Check

func (sc *SchemaConfig) Check() error

func (*SchemaConfig) String

func (sc *SchemaConfig) String() string

type Stats

type Stats struct {
	Workers []*stats
}