Struct prometheus_json_encoder::JsonEncoder

pub struct JsonEncoder;

An implementation of an Encoder that converts a MetricFamily proto message into json format.

Implementations

impl JsonEncoder

pub fn new() -> JsonEncoder

Create a new json encoder.

pub fn encode_utf8(
    &self,
    metric_families: &[MetricFamily],
    buf: &mut String
) -> Result<()>

Appends metrics to a given String buffer.

This is a convenience wrapper around <JsonEncoder as Encoder>::encode.

pub fn encode_to_string(
    &self,
    metric_families: &[MetricFamily]
) -> Result<String>

Converts metrics to String.

This is a convenience wrapper around <JsonEncoder as Encoder>::encode.

Trait Implementations

impl Debug for JsonEncoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JsonEncoder

fn default() -> JsonEncoder

Returns the “default value” for a type.

impl Encoder for JsonEncoder

fn encode<W: Write>(
    &self,
    metric_families: &[MetricFamily],
    writer: &mut W
) -> Result<()>

encode converts a slice of MetricFamily proto messages into target format and writes the resulting lines to writer. This function does not perform checks on the content of the metrics and label names, i.e. invalid metrics or label names will result in invalid text format output.

fn format_type(&self) -> &str

format_type returns target format.