scrape

Documentation

Index

• type LabelStats
  • func (l LabelStats) String() string
• type LabelStatsSlice
  • func (l LabelStatsSlice) String() string
• type PromScraper
  • func NewPromScraper(scrapeURL string, logger log.Logger, opts ...ScraperOption) *PromScraper
  • func (ps *PromScraper) LastScrapeContentType() string
  • func (ps *PromScraper) Scrape() (*Result, error)
• type Result
• type ScraperOption
  • func WithMaxBodySize(maxBodySize int64) ScraperOption
  • func WithTimeout(timeout time.Duration) ScraperOption
• type Series
• type SeriesInfo
• type SeriesMap
  • func (s SeriesMap) AsRows() []SeriesInfo
• type SeriesSet
  • func (s SeriesSet) Cardinality() int
  • func (s SeriesSet) CreatedTS() int64
  • func (s SeriesSet) LabelNames() string
  • func (s SeriesSet) LabelStats() LabelStatsSlice
  • func (s SeriesSet) MetricTypeString() string

Types

type LabelStats

type LabelStats struct {
	Name           string
	DistinctValues uint
}

func (LabelStats) String

func (l LabelStats) String() string

type LabelStatsSlice

type LabelStatsSlice []LabelStats

func (LabelStatsSlice) String

func (l LabelStatsSlice) String() string

type PromScraper

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

func NewPromScraper

func NewPromScraper(scrapeURL string, logger log.Logger, opts ...ScraperOption) *PromScraper

func (*PromScraper) LastScrapeContentType

func (ps *PromScraper) LastScrapeContentType() string

func (*PromScraper) Scrape

func (ps *PromScraper) Scrape() (*Result, error)

type Result

type Result struct {
	Series          SeriesMap
	UsedContentType string
}

type ScraperOption

type ScraperOption func(*scrapeOpts)

func WithMaxBodySize

func WithMaxBodySize(maxBodySize int64) ScraperOption

func WithTimeout

func WithTimeout(timeout time.Duration) ScraperOption

type Series

type Series struct {
	Name             string
	Labels           labels.Labels
	Type             string
	CreatedTimestamp int64
}

type SeriesInfo

type SeriesInfo struct {
	Name        string
	Cardinality int
	Type        string
	Labels      string
	CreatedTS   string
}

type SeriesMap

type SeriesMap map[string]SeriesSet

func (SeriesMap) AsRows

func (s SeriesMap) AsRows() []SeriesInfo

type SeriesSet

type SeriesSet map[uint64]Series

func (SeriesSet) Cardinality

func (s SeriesSet) Cardinality() int

func (SeriesSet) CreatedTS

func (s SeriesSet) CreatedTS() int64

func (SeriesSet) LabelNames

func (s SeriesSet) LabelNames() string

func (SeriesSet) LabelStats

func (s SeriesSet) LabelStats() LabelStatsSlice

func (SeriesSet) MetricTypeString

func (s SeriesSet) MetricTypeString() string