githubscraper

Documentation

Index

• Constants
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() internal.Config
  • func (f *Factory) CreateMetricsScraper(ctx context.Context, params receiver.CreateSettings, cfg internal.Config) (scraperhelper.Scraper, error)

Constants

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

Types

type Config

type Config struct {
	metadata.MetricsBuilderConfig `mapstructure:",squash"`
	confighttp.HTTPClientSettings `mapstructure:",squash"`
	internal.ScraperConfig
	// GitHubOrg is the name of the GitHub organization to srape (github scraper only)
	GitHubOrg string `mapstructure:"github_org"`
}

Config relating to Github Metric Scraper.

type Factory

type Factory struct{}

func (*Factory) CreateDefaultConfig

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

func (*Factory) CreateMetricsScraper

func (f *Factory) CreateMetricsScraper(
	ctx context.Context,
	params receiver.CreateSettings,
	cfg internal.Config,
) (scraperhelper.Scraper, error)