const (
TextVersion = "0.0.4"
ProtoType = `application/vnd.google.protobuf`
ProtoProtocol = `io.prometheus.client.MetricFamily`
ProtoFmt = ProtoType + "; proto=" + ProtoProtocol + ";"
// The Content-Type values for the different wire protocols.
FmtUnknown Format = `<unknown>`
FmtText Format = `text/plain; version=` + TextVersion
FmtProtoDelim Format = ProtoFmt + ` encoding=delimited`
FmtProtoText Format = ProtoFmt + ` encoding=text`
FmtProtoCompact Format = ProtoFmt + ` encoding=compact-text`
)
func ExtractSamples(o *DecodeOptions, fams ...*dto.MetricFamily) model.Vector
Extract samples builds a slice of samples from the provided metric families.
func MetricFamilyToText(out io.Writer, in *dto.MetricFamily) (int, error)
MetricFamilyToText converts a MetricFamily proto message into text format and writes the resulting lines to 'out'. It returns the number of bytes written and any error encountered. The output will have the same order as the input, no further sorting is performed. Furthermore, this function assumes the input is already sanitized and does not perform any sanity checks. If the input contains duplicate metrics or invalid metric or label names, the conversion will result in invalid text format output.
This method fulfills the type 'prometheus.encoder'.
type DecodeOptions struct {
// Timestamp is added to each value from the stream that has no explicit timestamp set.
Timestamp model.Time
}
type Decoder interface {
Decode(*dto.MetricFamily) error
}
Decoder types decode an input stream into metric families.
func NewDecoder(r io.Reader, format Format) Decoder
NewDecoder returns a new decoder based on the given input format. If the input format does not imply otherwise, a text format decoder is returned.
type Encoder interface {
Encode(*dto.MetricFamily) error
}
Encoder types encode metric families into an underlying wire protocol.
func NewEncoder(w io.Writer, format Format) Encoder
NewEncoder returns a new encoder based on content type negotiation.
type Format string
func Negotiate(h http.Header) Format
Negotiate returns the Content-Type based on the given Accept header. If no appropriate accepted type is found, FmtText is returned.
func ResponseFormat(h http.Header) Format
ResponseFormat extracts the correct format from a HTTP response header. If no matching format can be found FormatUnknown is returned.
type ParseError struct {
Line int
Msg string
}
ParseError signals errors while parsing the simple and flat text-based exchange format.
func (e ParseError) Error() string
Error implements the error interface.
type SampleDecoder struct {
Dec Decoder
Opts *DecodeOptions
// contains filtered or unexported fields
}
func (sd *SampleDecoder) Decode(s *model.Vector) error
type TextParser struct {
// contains filtered or unexported fields
}
TextParser is used to parse the simple and flat text-based exchange format. Its zero value is ready to use.
func (p *TextParser) TextToMetricFamilies(in io.Reader) (map[string]*dto.MetricFamily, error)
TextToMetricFamilies reads 'in' as the simple and flat text-based exchange format and creates MetricFamily proto messages. It returns the MetricFamily proto messages in a map where the metric names are the keys, along with any error encountered.
If the input contains duplicate metrics (i.e. lines with the same metric name and exactly the same label set), the resulting MetricFamily will contain duplicate Metric proto messages. Similar is true for duplicate label names. Checks for duplicates have to be performed separately, if required. Also note that neither the metrics within each MetricFamily are sorted nor the label pairs within each Metric. Sorting is not required for the most frequent use of this method, which is sample ingestion in the Prometheus server. However, for presentation purposes, you might want to sort the metrics, and in some cases, you must sort the labels, e.g. for consumption by the metric family injection hook of the Prometheus registry.
Summaries and histograms are rather special beasts. You would probably not use them in the simple text format anyway. This method can deal with summaries and histograms if they are presented in exactly the way the text.Create function creates them.
This method must not be called concurrently. If you want to parse different input concurrently, instantiate a separate Parser for each goroutine.