prometheus

Documentation

Index

• func FilterSeriesByOptions(series []*ts.Series, opts *storage.FetchOptions) []*ts.Series
• func ParseSeriesMatchQuery(r *http.Request, parseOpts xpromql.ParseOptions, tagOptions models.TagOptions) ([]*storage.FetchQuery, error)
• func ParseStartAndEnd(r *http.Request, parseOpts xpromql.ParseOptions) (time.Time, time.Time, error)
• func ParseTime(r *http.Request, key string, now time.Time) (time.Time, error)
• func SetDefaultStartEndParamsForInstant(r *http.Request)
• type MatchInformation
• type MatrixResult
  • func (r MatrixResult) Len() int
  • func (r MatrixResult) Less(i, j int) bool
  • func (r MatrixResult) Sort()
  • func (r MatrixResult) Swap(i, j int)
• type ParsePromCompressedRequestResult
  • func ParsePromCompressedRequest(r *http.Request) (ParsePromCompressedRequestResult, error)
• type ParsedMatch
  • func ParseMatch(r *http.Request, parseOpts xpromql.ParseOptions, tagOptions models.TagOptions) ([]ParsedMatch, bool, error)
• type RenderSeriesMetadataOptions
• type RenderSeriesMetadataResult
  • func RenderListTagResultsJSON(w io.Writer, result *consolidators.CompleteTagsResult, ...) (RenderSeriesMetadataResult, error)
  • func RenderSeriesMatchResultsJSON(w io.Writer, results []models.Metrics, opts RenderSeriesMetadataOptions) (RenderSeriesMetadataResult, error)
  • func RenderTagCompletionResultsJSON(w io.Writer, result consolidators.CompleteTagsResult, ...) (RenderSeriesMetadataResult, error)
  • func RenderTagValuesResultsJSON(w io.Writer, result *consolidators.CompleteTagsResult, ...) (RenderSeriesMetadataResult, error)
• type Response
  • func (r Response) Matches(other Response) (MatchInformation, error)
• type ScalarResult
• type StringResult
• type TagCompletionQueries
  • func ParseTagCompletionParamsToQueries(r *http.Request) (TagCompletionQueries, error)
• type Tags
• type TimeParams
  • func ParseTimeParams(r *http.Request) (TimeParams, error)
• type Value
• type Values
• type VectorResult
  • func (r VectorResult) Len() int
  • func (r VectorResult) Less(i, j int) bool
  • func (r VectorResult) Sort()
  • func (r VectorResult) Swap(i, j int)

Functions

func FilterSeriesByOptions

func FilterSeriesByOptions(
	series []*ts.Series,
	opts *storage.FetchOptions,
) []*ts.Series

FilterSeriesByOptions removes series tags based on options.

func ParseSeriesMatchQuery

func ParseSeriesMatchQuery(
	r *http.Request,
	parseOpts xpromql.ParseOptions,
	tagOptions models.TagOptions,
) ([]*storage.FetchQuery, error)

ParseSeriesMatchQuery parses all params from the GET request.

func ParseStartAndEnd

func ParseStartAndEnd(
	r *http.Request,
	parseOpts xpromql.ParseOptions,
) (time.Time, time.Time, error)

ParseStartAndEnd parses start and end params from the request.

func ParseTime

func ParseTime(r *http.Request, key string, now time.Time) (time.Time, error)

ParseTime parses a time out of a request key, with a default value.

func SetDefaultStartEndParamsForInstant

func SetDefaultStartEndParamsForInstant(r *http.Request)

SetDefaultStartEndParamsForInstant sets the start and end values for instant queries. Instant queries don't specify start and end, but these params are required to be set to be successfully processed by storage.

Types

type MatchInformation

type MatchInformation struct {
	// FullMatch indicates a full match.
	FullMatch bool
	// NoMatch indicates that the responses do not match sufficiently.
	NoMatch bool
}

MatchInformation describes how well two responses match.

type MatrixResult

type MatrixResult struct {
	Result []matrixRow `json:"result"`
}

MatrixResult contains a list matrixRow.

func (MatrixResult) Len

func (r MatrixResult) Len() int

Len is the number of elements in the collection.

func (MatrixResult) Less

func (r MatrixResult) Less(i, j int) bool

Less reports whether the element with index i should sort before the element with index j.

func (MatrixResult) Sort

func (r MatrixResult) Sort()

Sort sorts the MatrixResult.

func (MatrixResult) Swap

func (r MatrixResult) Swap(i, j int)

Swap swaps the elements with indexes i and j.

type ParsePromCompressedRequestResult

type ParsePromCompressedRequestResult struct {
	CompressedBody   []byte
	UncompressedBody []byte
}

ParsePromCompressedRequestResult is the result of a ParsePromCompressedRequest call.

func ParsePromCompressedRequest

func ParsePromCompressedRequest(
	r *http.Request,
) (ParsePromCompressedRequestResult, error)

ParsePromCompressedRequest parses a snappy compressed request from Prometheus.

type ParsedMatch

type ParsedMatch struct {
	Match    string
	Matchers models.Matchers
}

ParsedMatch is a parsed matched.

func ParseMatch

func ParseMatch(
	r *http.Request,
	parseOpts xpromql.ParseOptions,
	tagOptions models.TagOptions,
) ([]ParsedMatch, bool, error)

ParseMatch parses all match params from the GET request.

type RenderSeriesMetadataOptions

type RenderSeriesMetadataOptions struct {
	ReturnedSeriesMetadataLimit int
}

RenderSeriesMetadataOptions is a set of options for rendering series metadata.

type RenderSeriesMetadataResult

type RenderSeriesMetadataResult struct {
	// Results is how many results were rendered.
	Results int
	// TotalResults is how many results in total there were regardless
	// of rendering.
	TotalResults int
	// LimitedMaxReturnedData indicates if results rendering
	// was truncated by a limit.
	LimitedMaxReturnedData bool
}

RenderSeriesMetadataResult returns results about a series metadata rendering.

func RenderListTagResultsJSON

func RenderListTagResultsJSON(
	w io.Writer,
	result *consolidators.CompleteTagsResult,
	opts RenderSeriesMetadataOptions,
) (RenderSeriesMetadataResult, error)

RenderListTagResultsJSON renders list tag results to json format.

func RenderSeriesMatchResultsJSON

func RenderSeriesMatchResultsJSON(
	w io.Writer,
	results []models.Metrics,
	opts RenderSeriesMetadataOptions,
) (RenderSeriesMetadataResult, error)

RenderSeriesMatchResultsJSON renders series match results to json format.

func RenderTagCompletionResultsJSON

func RenderTagCompletionResultsJSON(
	w io.Writer,
	result consolidators.CompleteTagsResult,
	opts RenderSeriesMetadataOptions,
) (RenderSeriesMetadataResult, error)

RenderTagCompletionResultsJSON renders tag completion results to json format.

func RenderTagValuesResultsJSON

func RenderTagValuesResultsJSON(
	w io.Writer,
	result *consolidators.CompleteTagsResult,
	opts RenderSeriesMetadataOptions,
) (RenderSeriesMetadataResult, error)

RenderTagValuesResultsJSON renders tag values results to json format.

type Response

type Response struct {
	// Status is the response status.
	Status string `json:"status"`
	// Data is the response data.
	Data data `json:"data"`
}

Response represents Prometheus's query response.

func (Response) Matches

func (r Response) Matches(other Response) (MatchInformation, error)

Matches compares two responses and determines how closely they match.

type ScalarResult

type ScalarResult struct {
	Result Value `json:"result"`
}

ScalarResult is the scalar Value for the response.

type StringResult

type StringResult struct {
	Result Value `json:"result"`
}

StringResult is the string Value for the response.

type TagCompletionQueries

type TagCompletionQueries struct {
	// Queries are the tag completion queries.
	Queries []*storage.CompleteTagsQuery
	// NameOnly indicates name only
	NameOnly bool
}

TagCompletionQueries are tag completion queries.

func ParseTagCompletionParamsToQueries

func ParseTagCompletionParamsToQueries(
	r *http.Request,
) (TagCompletionQueries, error)

ParseTagCompletionParamsToQueries parses all params from the GET request. Returns queries, a boolean indicating if the query completes names only, and any errors.

type Tags

type Tags map[string]string

Tags is a simple representation of Prometheus tags.

type TimeParams

type TimeParams struct {
	Now   time.Time
	Start time.Time
	End   time.Time
}

TimeParams represents the time parameters within a request.

func ParseTimeParams

func ParseTimeParams(r *http.Request) (TimeParams, error)

ParseTimeParams parses the time params (now, start, end) from a request.

type Value

type Value []interface{}

Value is a single value for Prometheus Result.

type Values

type Values []Value

Values is a list of values for the Prometheus Result.

type VectorResult

type VectorResult struct {
	Result []vectorItem `json:"result"`
}

VectorResult contains a list of vectorItem.

func (VectorResult) Len

func (r VectorResult) Len() int

Len is the number of elements in the vector.

func (VectorResult) Less

func (r VectorResult) Less(i, j int) bool

Less reports whether the element with index i should sort before the element with index j.

func (VectorResult) Sort

func (r VectorResult) Sort()

Sort sorts the VectorResult.

func (VectorResult) Swap

func (r VectorResult) Swap(i, j int)

Swap swaps the elements with indexes i and j.