MCPcopy Create free account
hub / github.com/prometheus/common / NewEncoder

Function NewEncoder

expfmt/encode.go:232–294  ·  view source on GitHub ↗

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 t

(w io.Writer, format Format, options ...EncoderOption)

Source from the content-addressed store, hash-verified

230//
231// Extra options are ignored for all other formats.
232func NewEncoder(w io.Writer, format Format, options ...EncoderOption) Encoder {
233 escapingScheme := format.ToEscapingScheme()
234
235 switch format.FormatType() {
236 case TypeProtoDelim:
237 return encoderCloser{
238 encode: func(v *dto.MetricFamily) error {
239 _, err := protodelim.MarshalTo(w, model.EscapeMetricFamily(v, escapingScheme))
240 return err
241 },
242 close: func() error { return nil },
243 }
244 case TypeProtoCompact:
245 return encoderCloser{
246 encode: func(v *dto.MetricFamily) error {
247 _, err := fmt.Fprintln(w, model.EscapeMetricFamily(v, escapingScheme).String())
248 return err
249 },
250 close: func() error { return nil },
251 }
252 case TypeProtoText:
253 return encoderCloser{
254 encode: func(v *dto.MetricFamily) error {
255 _, err := fmt.Fprintln(w, prototext.Format(model.EscapeMetricFamily(v, escapingScheme)))
256 return err
257 },
258 close: func() error { return nil },
259 }
260 case TypeTextPlain:
261 return encoderCloser{
262 encode: func(v *dto.MetricFamily) error {
263 _, err := MetricFamilyToText(w, model.EscapeMetricFamily(v, escapingScheme))
264 return err
265 },
266 close: func() error { return nil },
267 }
268 case TypeOpenMetrics:
269 _, params, err := mime.ParseMediaType(string(format))
270 if err == nil && isOpenMetrics20Version(params["version"]) {
271 return encoderCloser{
272 encode: func(v *dto.MetricFamily) error {
273 _, err := MetricFamilyToOpenMetrics20(w, model.EscapeMetricFamily(v, escapingScheme), options...)
274 return err
275 },
276 close: func() error {
277 _, err := FinalizeOpenMetrics(w)
278 return err
279 },
280 }
281 }
282 return encoderCloser{
283 encode: func(v *dto.MetricFamily) error {
284 _, err := MetricFamilyToOpenMetrics(w, model.EscapeMetricFamily(v, escapingScheme), options...)
285 return err
286 },
287 close: func() error {
288 _, err := FinalizeOpenMetrics(w)
289 return err

Callers 7

TestEncodeFunction · 0.85
TestEscapedEncodeFunction · 0.85
TestDottedEncodeFunction · 0.85

Calls 9

EscapeMetricFamilyFunction · 0.92
MetricFamilyToTextFunction · 0.85
isOpenMetrics20VersionFunction · 0.85
FinalizeOpenMetricsFunction · 0.85
ToEscapingSchemeMethod · 0.80
FormatTypeMethod · 0.80
StringMethod · 0.65

Tested by 7

TestEncodeFunction · 0.68
TestEscapedEncodeFunction · 0.68
TestDottedEncodeFunction · 0.68