Struct Report 

pub struct Report {
    pub total: u64,
    pub unparseable: u64,
    pub count_by_level: BTreeMap<String, u64>,
    pub count_by_component: BTreeMap<String, u64>,
    pub top_descriptions: Vec<(String, u64)>,
    pub latency: Option<LatencyStats>,
}

Aggregated digest of a log stream.

Fields

total: u64

Total parseable records seen.

unparseable: u64

Records that failed to parse as canonical JSON Log.

count_by_level: BTreeMap<String, u64>

Count of records grouped by level (string keys: INFO, ERROR, …).

count_by_component: BTreeMap<String, u64>

Count grouped by component.

top_descriptions: Vec<(String, u64)>

Top descriptions by frequency, descending. Top 10 by default.

latency: Option<LatencyStats>

Latency stats (ms) extracted from the latency_ms / http.latency_ms attribute when present. None when no records carried such an attribute.

Implementations

impl Report

pub fn from_lines<'a, I>(lines: I) -> Self

where I: IntoIterator<Item = &'a str>,

Aggregate a stream of JSON-shaped record lines into a Report. Lines that don’t parse as canonical JSON Log are counted as unparseable and otherwise ignored.

pub fn from_lines_with_top<'a, I>(lines: I, top_n: usize) -> Self

where I: IntoIterator<Item = &'a str>,

Same as Self::from_lines but lets the caller pick how many top descriptions to keep.

pub fn to_text(&self) -> String

Render the report as a human-readable text table.

pub fn to_json(&self) -> Result<String, Error>

Render the report as JSON.

Errors

Returns serde_json::Error only if the serialiser fails, which cannot happen for the report’s fixed shape.

pub fn error_count(&self) -> u64

Count of records at level ERROR-and-above.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Report

Returns the “default value” for a type.