pagingscraper

Documentation

Index

• Constants
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() internal.Config
  • func (f *Factory) CreateMetricsScraper(ctx context.Context, _ *zap.Logger, config internal.Config) (scraperhelper.Scraper, error)

Constants

const (
	// TypeStr the value of "type" key in configuration.
	TypeStr = "paging"
)

Types

type Config

type Config struct {
	internal.ConfigSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct

	// Metrics allows customizing scraped metrics representation.
	Metrics metadata.MetricsSettings `mapstructure:"metrics"`
}

Config relating to Paging Metric Scraper.

type Factory

type Factory struct {
}

Factory is the Factory for scraper.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() internal.Config

CreateDefaultConfig creates the default configuration for the Scraper.

func (*Factory) CreateMetricsScraper

func (f *Factory) CreateMetricsScraper(
	ctx context.Context,
	_ *zap.Logger,
	config internal.Config,
) (scraperhelper.Scraper, error)

CreateMetricsScraper creates a scraper based on provided config.