2019-05-31 09:45:11 +00:00
|
|
|
// Copyright 2015 The Prometheus Authors
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
package expfmt
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"io"
|
|
|
|
"net/http"
|
|
|
|
|
2024-06-24 20:58:34 +00:00
|
|
|
"google.golang.org/protobuf/encoding/protodelim"
|
2023-08-17 05:15:28 +00:00
|
|
|
"google.golang.org/protobuf/encoding/prototext"
|
2019-05-31 09:45:11 +00:00
|
|
|
|
2024-06-24 20:58:34 +00:00
|
|
|
"github.com/prometheus/common/internal/bitbucket.org/ww/goautoneg"
|
|
|
|
"github.com/prometheus/common/model"
|
|
|
|
|
2019-05-31 09:45:11 +00:00
|
|
|
dto "github.com/prometheus/client_model/go"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Encoder types encode metric families into an underlying wire protocol.
|
|
|
|
type Encoder interface {
|
|
|
|
Encode(*dto.MetricFamily) error
|
|
|
|
}
|
|
|
|
|
2020-04-14 07:04:33 +00:00
|
|
|
// Closer is implemented by Encoders that need to be closed to finalize
|
|
|
|
// encoding. (For example, OpenMetrics needs a final `# EOF` line.)
|
|
|
|
//
|
|
|
|
// Note that all Encoder implementations returned from this package implement
|
|
|
|
// Closer, too, even if the Close call is a no-op. This happens in preparation
|
|
|
|
// for adding a Close method to the Encoder interface directly in a (mildly
|
|
|
|
// breaking) release in the future.
|
|
|
|
type Closer interface {
|
|
|
|
Close() error
|
|
|
|
}
|
|
|
|
|
|
|
|
type encoderCloser struct {
|
|
|
|
encode func(*dto.MetricFamily) error
|
|
|
|
close func() error
|
|
|
|
}
|
2019-05-31 09:45:11 +00:00
|
|
|
|
2020-04-14 07:04:33 +00:00
|
|
|
func (ec encoderCloser) Encode(v *dto.MetricFamily) error {
|
|
|
|
return ec.encode(v)
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|
|
|
|
|
2020-04-14 07:04:33 +00:00
|
|
|
func (ec encoderCloser) Close() error {
|
|
|
|
return ec.close()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Negotiate returns the Content-Type based on the given Accept header. If no
|
|
|
|
// appropriate accepted type is found, FmtText is returned (which is the
|
|
|
|
// Prometheus text format). This function will never negotiate FmtOpenMetrics,
|
|
|
|
// as the support is still experimental. To include the option to negotiate
|
|
|
|
// FmtOpenMetrics, use NegotiateOpenMetrics.
|
2019-05-31 09:45:11 +00:00
|
|
|
func Negotiate(h http.Header) Format {
|
2024-06-24 20:58:34 +00:00
|
|
|
escapingScheme := Format(fmt.Sprintf("; escaping=%s", Format(model.NameEscapingScheme.String())))
|
2019-05-31 09:45:11 +00:00
|
|
|
for _, ac := range goautoneg.ParseAccept(h.Get(hdrAccept)) {
|
2024-06-24 20:58:34 +00:00
|
|
|
if escapeParam := ac.Params[model.EscapingKey]; escapeParam != "" {
|
|
|
|
switch Format(escapeParam) {
|
|
|
|
case model.AllowUTF8, model.EscapeUnderscores, model.EscapeDots, model.EscapeValues:
|
|
|
|
escapingScheme = Format(fmt.Sprintf("; escaping=%s", escapeParam))
|
|
|
|
default:
|
|
|
|
// If the escaping parameter is unknown, ignore it.
|
|
|
|
}
|
|
|
|
}
|
2020-04-14 07:04:33 +00:00
|
|
|
ver := ac.Params["version"]
|
2019-05-31 09:45:11 +00:00
|
|
|
if ac.Type+"/"+ac.SubType == ProtoType && ac.Params["proto"] == ProtoProtocol {
|
|
|
|
switch ac.Params["encoding"] {
|
|
|
|
case "delimited":
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtProtoDelim + escapingScheme
|
2019-05-31 09:45:11 +00:00
|
|
|
case "text":
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtProtoText + escapingScheme
|
2019-05-31 09:45:11 +00:00
|
|
|
case "compact-text":
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtProtoCompact + escapingScheme
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|
|
|
|
}
|
2020-04-14 07:04:33 +00:00
|
|
|
if ac.Type == "text" && ac.SubType == "plain" && (ver == TextVersion || ver == "") {
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtText + escapingScheme
|
2020-04-14 07:04:33 +00:00
|
|
|
}
|
|
|
|
}
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtText + escapingScheme
|
2020-04-14 07:04:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NegotiateIncludingOpenMetrics works like Negotiate but includes
|
|
|
|
// FmtOpenMetrics as an option for the result. Note that this function is
|
|
|
|
// temporary and will disappear once FmtOpenMetrics is fully supported and as
|
|
|
|
// such may be negotiated by the normal Negotiate function.
|
|
|
|
func NegotiateIncludingOpenMetrics(h http.Header) Format {
|
2024-06-24 20:58:34 +00:00
|
|
|
escapingScheme := Format(fmt.Sprintf("; escaping=%s", Format(model.NameEscapingScheme.String())))
|
2020-04-14 07:04:33 +00:00
|
|
|
for _, ac := range goautoneg.ParseAccept(h.Get(hdrAccept)) {
|
2024-06-24 20:58:34 +00:00
|
|
|
if escapeParam := ac.Params[model.EscapingKey]; escapeParam != "" {
|
|
|
|
switch Format(escapeParam) {
|
|
|
|
case model.AllowUTF8, model.EscapeUnderscores, model.EscapeDots, model.EscapeValues:
|
|
|
|
escapingScheme = Format(fmt.Sprintf("; escaping=%s", escapeParam))
|
|
|
|
default:
|
|
|
|
// If the escaping parameter is unknown, ignore it.
|
|
|
|
}
|
|
|
|
}
|
2019-05-31 09:45:11 +00:00
|
|
|
ver := ac.Params["version"]
|
2020-04-14 07:04:33 +00:00
|
|
|
if ac.Type+"/"+ac.SubType == ProtoType && ac.Params["proto"] == ProtoProtocol {
|
|
|
|
switch ac.Params["encoding"] {
|
|
|
|
case "delimited":
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtProtoDelim + escapingScheme
|
2020-04-14 07:04:33 +00:00
|
|
|
case "text":
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtProtoText + escapingScheme
|
2020-04-14 07:04:33 +00:00
|
|
|
case "compact-text":
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtProtoCompact + escapingScheme
|
2020-04-14 07:04:33 +00:00
|
|
|
}
|
|
|
|
}
|
2019-05-31 09:45:11 +00:00
|
|
|
if ac.Type == "text" && ac.SubType == "plain" && (ver == TextVersion || ver == "") {
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtText + escapingScheme
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|
2023-08-17 05:15:28 +00:00
|
|
|
if ac.Type+"/"+ac.SubType == OpenMetricsType && (ver == OpenMetricsVersion_0_0_1 || ver == OpenMetricsVersion_1_0_0 || ver == "") {
|
2024-06-24 20:58:34 +00:00
|
|
|
switch ver {
|
|
|
|
case OpenMetricsVersion_1_0_0:
|
|
|
|
return fmtOpenMetrics_1_0_0 + escapingScheme
|
|
|
|
default:
|
|
|
|
return fmtOpenMetrics_0_0_1 + escapingScheme
|
2023-08-17 05:15:28 +00:00
|
|
|
}
|
2020-04-14 07:04:33 +00:00
|
|
|
}
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|
2024-06-24 20:58:34 +00:00
|
|
|
return fmtText + escapingScheme
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|
|
|
|
|
2020-04-14 07:04:33 +00:00
|
|
|
// NewEncoder returns a new encoder based on content type negotiation. All
|
|
|
|
// Encoder implementations returned by NewEncoder also implement Closer, and
|
|
|
|
// callers should always call the Close method. It is currently only required
|
|
|
|
// for FmtOpenMetrics, but a future (breaking) release will add the Close method
|
|
|
|
// to the Encoder interface directly. The current version of the Encoder
|
|
|
|
// interface is kept for backwards compatibility.
|
2024-06-24 20:58:34 +00:00
|
|
|
// In cases where the Format does not allow for UTF-8 names, the global
|
|
|
|
// NameEscapingScheme will be applied.
|
2019-05-31 09:45:11 +00:00
|
|
|
func NewEncoder(w io.Writer, format Format) Encoder {
|
2024-06-24 20:58:34 +00:00
|
|
|
escapingScheme := format.ToEscapingScheme()
|
|
|
|
|
|
|
|
switch format.FormatType() {
|
|
|
|
case TypeProtoDelim:
|
2020-04-14 07:04:33 +00:00
|
|
|
return encoderCloser{
|
|
|
|
encode: func(v *dto.MetricFamily) error {
|
2024-06-24 20:58:34 +00:00
|
|
|
_, err := protodelim.MarshalTo(w, v)
|
2020-04-14 07:04:33 +00:00
|
|
|
return err
|
|
|
|
},
|
|
|
|
close: func() error { return nil },
|
|
|
|
}
|
2024-06-24 20:58:34 +00:00
|
|
|
case TypeProtoCompact:
|
2020-04-14 07:04:33 +00:00
|
|
|
return encoderCloser{
|
|
|
|
encode: func(v *dto.MetricFamily) error {
|
2024-06-24 20:58:34 +00:00
|
|
|
_, err := fmt.Fprintln(w, model.EscapeMetricFamily(v, escapingScheme).String())
|
2020-04-14 07:04:33 +00:00
|
|
|
return err
|
|
|
|
},
|
|
|
|
close: func() error { return nil },
|
|
|
|
}
|
2024-06-24 20:58:34 +00:00
|
|
|
case TypeProtoText:
|
2020-04-14 07:04:33 +00:00
|
|
|
return encoderCloser{
|
|
|
|
encode: func(v *dto.MetricFamily) error {
|
2024-06-24 20:58:34 +00:00
|
|
|
_, err := fmt.Fprintln(w, prototext.Format(model.EscapeMetricFamily(v, escapingScheme)))
|
2020-04-14 07:04:33 +00:00
|
|
|
return err
|
|
|
|
},
|
|
|
|
close: func() error { return nil },
|
|
|
|
}
|
2024-06-24 20:58:34 +00:00
|
|
|
case TypeTextPlain:
|
2020-04-14 07:04:33 +00:00
|
|
|
return encoderCloser{
|
|
|
|
encode: func(v *dto.MetricFamily) error {
|
2024-06-24 20:58:34 +00:00
|
|
|
_, err := MetricFamilyToText(w, model.EscapeMetricFamily(v, escapingScheme))
|
2020-04-14 07:04:33 +00:00
|
|
|
return err
|
|
|
|
},
|
|
|
|
close: func() error { return nil },
|
|
|
|
}
|
2024-06-24 20:58:34 +00:00
|
|
|
case TypeOpenMetrics:
|
2020-04-14 07:04:33 +00:00
|
|
|
return encoderCloser{
|
|
|
|
encode: func(v *dto.MetricFamily) error {
|
2024-06-24 20:58:34 +00:00
|
|
|
_, err := MetricFamilyToOpenMetrics(w, model.EscapeMetricFamily(v, escapingScheme))
|
2020-04-14 07:04:33 +00:00
|
|
|
return err
|
|
|
|
},
|
|
|
|
close: func() error {
|
|
|
|
_, err := FinalizeOpenMetrics(w)
|
|
|
|
return err
|
|
|
|
},
|
|
|
|
}
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|
2020-04-14 07:04:33 +00:00
|
|
|
panic(fmt.Errorf("expfmt.NewEncoder: unknown format %q", format))
|
2019-05-31 09:45:11 +00:00
|
|
|
}
|