1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102

// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0.

#[cfg(feature = "protobuf")]
mod pb;
mod text;

#[cfg(feature = "protobuf")]
pub use self::pb::{ProtobufEncoder, PROTOBUF_FORMAT};
pub use self::text::{TextEncoder, TEXT_FORMAT};

use std::io::Write;

use crate::errors::{Error, Result};
use crate::proto::MetricFamily;

/// An interface for encoding metric families into an underlying wire protocol.
pub trait Encoder {
    /// `encode` converts a slice of MetricFamily proto messages into target
    /// format and writes the resulting lines to `writer`. It returns the number
    /// of bytes written and any error encountered. This function does not
    /// perform checks on the content of the metric and label names,
    /// i.e. invalid metric or label names will result in invalid text format
    /// output.
    fn encode<W: Write>(&self, _: &[MetricFamily], _: &mut W) -> Result<()>;

    /// `format_type` returns target format.
    fn format_type(&self) -> &str;
}

fn check_metric_family(mf: &MetricFamily) -> Result<()> {
    if mf.get_metric().is_empty() {
        return Err(Error::Msg(format!("MetricFamily has no metrics: {:?}", mf)));
    }
    if mf.get_name().is_empty() {
        return Err(Error::Msg(format!("MetricFamily has no name: {:?}", mf)));
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::counter::CounterVec;
    use crate::encoder::Encoder;
    use crate::metrics::Collector;
    use crate::metrics::Opts;

    #[test]
    #[cfg(feature = "protobuf")]
    fn test_bad_proto_metrics() {
        let mut writer = Vec::<u8>::new();
        let pb_encoder = ProtobufEncoder::new();
        let cv = CounterVec::new(
            Opts::new("test_counter_vec", "help information"),
            &["labelname"],
        )
        .unwrap();

        // Empty metrics
        let mfs = cv.collect();
        check_metric_family(&mfs[0]).unwrap_err();
        pb_encoder.encode(&mfs, &mut writer).unwrap_err();
        assert_eq!(writer.len(), 0);

        // Add a sub metric
        cv.with_label_values(&["foo"]).inc();
        let mut mfs = cv.collect();

        // Empty name
        (&mut mfs[0]).clear_name();
        check_metric_family(&mfs[0]).unwrap_err();
        pb_encoder.encode(&mfs, &mut writer).unwrap_err();
        assert_eq!(writer.len(), 0);
    }

    #[test]
    fn test_bad_text_metrics() {
        let mut writer = Vec::<u8>::new();
        let text_encoder = TextEncoder::new();
        let cv = CounterVec::new(
            Opts::new("test_counter_vec", "help information"),
            &["labelname"],
        )
        .unwrap();

        // Empty metrics
        let mfs = cv.collect();
        check_metric_family(&mfs[0]).unwrap_err();
        text_encoder.encode(&mfs, &mut writer).unwrap_err();
        assert_eq!(writer.len(), 0);

        // Add a sub metric
        cv.with_label_values(&["foo"]).inc();
        let mut mfs = cv.collect();

        // Empty name
        (&mut mfs[0]).clear_name();
        check_metric_family(&mfs[0]).unwrap_err();
        text_encoder.encode(&mfs, &mut writer).unwrap_err();
        assert_eq!(writer.len(), 0);
    }
}