workflow

Documentation

Index

• type ChromiumCodesearchEnumFetcher
  • func NewChromiumCodesearchEnumFetcher(httpClient *http.Client) (*ChromiumCodesearchEnumFetcher, error)
• type ChromiumCodesearchEnumParser
  • func (p ChromiumCodesearchEnumParser) Parse(ctx context.Context, encodedData io.ReadCloser, ...) (metricdatatypes.HistogramMapping, error)
• type ChromiumHistogramEnumsJobProcessor
  • func NewChromiumHistogramEnumsJobProcessor(enumsFetecher EnumsFetecher, enumsParser EnumsParser, ...) ChromiumHistogramEnumsJobProcessor
  • func (p ChromiumHistogramEnumsJobProcessor) Process(ctx context.Context, job JobArguments) error
• type EnumsFetecher
• type EnumsParser
• type Histogram
• type HistogramConfiguration
• type HistogramEnums
• type HistogramInt
• type HistogramStorer
• type JobArguments
  • func NewJobArguments(histograms []metricdatatypes.HistogramName) JobArguments

Types

type ChromiumCodesearchEnumFetcher

type ChromiumCodesearchEnumFetcher struct {
	*httputils.HTTPFetcher
}

ChromiumCodesearchEnumFetcher fetches the enums from Chromium code search. The returned data will be base64 encoded and it is up the consumer to decode before reading.

func NewChromiumCodesearchEnumFetcher

func NewChromiumCodesearchEnumFetcher(httpClient *http.Client) (*ChromiumCodesearchEnumFetcher, error)

type ChromiumCodesearchEnumParser

type ChromiumCodesearchEnumParser struct{}

ChromiumCodesearchEnumFetcher parses the enums from Chromium code search. It expects the base64 encoded stream from ChromiumCodesearchEnumFetcher.

func (ChromiumCodesearchEnumParser) Parse

func (p ChromiumCodesearchEnumParser) Parse(
	ctx context.Context,
	encodedData io.ReadCloser,
	filteredHistogramEnums []metricdatatypes.HistogramName) (metricdatatypes.HistogramMapping, error)

Inspired by the get_template_data method on the HistogramsHandler class https://github.com/GoogleChrome/chromium-dashboard/blob/main/internals/fetchmetrics.py

type ChromiumHistogramEnumsJobProcessor

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

func NewChromiumHistogramEnumsJobProcessor

func NewChromiumHistogramEnumsJobProcessor(
	enumsFetecher EnumsFetecher,
	enumsParser EnumsParser,
	histogramStorer HistogramStorer,
) ChromiumHistogramEnumsJobProcessor

NewChromiumHistogramEnumsJobProcessor constructs a ChromiumHistogramEnumsJobProcessor.

func (ChromiumHistogramEnumsJobProcessor) Process

func (p ChromiumHistogramEnumsJobProcessor) Process(ctx context.Context, job JobArguments) error

type EnumsFetecher

type EnumsFetecher interface {
	Fetch(context.Context, ...httputils.FetchOption) (io.ReadCloser, error)
}

type EnumsParser

type EnumsParser interface {
	Parse(context.Context, io.ReadCloser, []metricdatatypes.HistogramName) (metricdatatypes.HistogramMapping, error)
}

type Histogram

type Histogram struct {
	XMLName xml.Name `xml:"enum"`
	Name    string   `xml:"name,attr"`

	Values []HistogramInt `xml:"int"`
}

type HistogramConfiguration

type HistogramConfiguration struct {
	XMLName xml.Name       `xml:"histogram-configuration"`
	Enums   HistogramEnums `xml:"enums"`
}

type HistogramEnums

type HistogramEnums struct {
	XMLName    xml.Name    `xml:"enums"`
	Histograms []Histogram `xml:"enum"`
}

type HistogramInt

type HistogramInt struct {
	XMLName xml.Name `xml:"int"`
	Value   int64    `xml:"value,attr"`
	Label   string   `xml:"label,attr"`
}

type HistogramStorer

type HistogramStorer interface {
	SaveHistogramEnums(context.Context, metricdatatypes.HistogramMapping) error
}

HistogramStorer represents the behavior to the storage layer.

type JobArguments

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

func NewJobArguments

func NewJobArguments(histograms []metricdatatypes.HistogramName) JobArguments

NewJobArguments constructor to create JobArguments, encapsulating essential workflow parameters.