generator

Documentation

Index

• func CalculateRelevance(tweets v1.TweetsResponse, timeFrame time.Frame, series int) (*storage.Relevance, error)
• type Config
  • func (cfg *Config) MarshalLogObject(enc zapcore.ObjectEncoder) error
  • func (cfg *Config) Validate() error
• type Generator
  • func New(db storage.Statistical, twtsClient *tweets.Client, config Config, ...) *Generator
  • func (gen *Generator) CalculateRelevances(tweets v1.TweetsResponse) (storage.Relevances, error)
  • func (gen *Generator) GenerateRelevances(ctx context.Context)
  • func (gen *Generator) Start(ctx context.Context)

Functions

func CalculateRelevance

func CalculateRelevance(
	tweets v1.TweetsResponse,
	timeFrame time.Frame,
	series int,
) (*storage.Relevance, error)

CalculateRelevance calculates relevance.

Types

type Config

type Config struct {
	AllTimeStatistics  bool
	Series             int
	DefaultTimeSpans   time.Durations
	GeneratingInterval time.Duration
}

Config represents a generator configuration.

func (*Config) MarshalLogObject

func (cfg *Config) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*Config) Validate

func (cfg *Config) Validate() error

Validate validates the generator configuration.

type Generator

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

Generator represents a statistics generator.

func New

func New(db storage.Statistical, twtsClient *tweets.Client, config Config, logger *zap.Logger) *Generator

New returns new generator.

func (*Generator) CalculateRelevances

func (gen *Generator) CalculateRelevances(tweets v1.TweetsResponse) (storage.Relevances, error)

CalculateRelevances calculates the relevances for different time spans.

func (*Generator) GenerateRelevances

func (gen *Generator) GenerateRelevances(ctx context.Context)

GenerateRelevances gets all the tweets, generates relevance statistics for all time spans and updates the relevances in the database.

func (*Generator) Start

func (gen *Generator) Start(ctx context.Context)

Start starts the generator.