Skip to main content

Report

Struct Report 

Source
pub struct Report {
    pub analysis: Analysis,
    pub findings: Vec<Finding>,
    pub green_summary: GreenSummary,
    pub quality_gate: QualityGate,
    pub per_endpoint_io_ops: Vec<PerEndpointIoOps>,
    pub correlations: Vec<CrossTraceCorrelation>,
    pub warnings: Vec<String>,
    pub warning_details: Vec<Warning>,
    pub acknowledged_findings: Vec<AcknowledgedFinding>,
    pub binary_version: String,
    pub disclosure_waste: Option<DisclosureWaste>,
}
Expand description

A complete analysis report.

Fields§

§analysis: Analysis§findings: Vec<Finding>§green_summary: GreenSummary§quality_gate: QualityGate§per_endpoint_io_ops: Vec<PerEndpointIoOps>

Raw I/O operation count per (service, endpoint). Populated by the pipeline regardless of [green] enabled, so the diff subcommand works even with green scoring off. Sorted by service then endpoint for deterministic JSON output. Empty when no traces were analyzed.

Lives on Report rather than on GreenSummary because it is a raw telemetry counter, not a green metric, and is filled in regardless of the green configuration.

§correlations: Vec<CrossTraceCorrelation>

Cross-trace temporal correlations produced by the daemon’s correlator. Always empty in the batch pipeline (the correlator runs over a rolling window that batch mode does not maintain). The HTML dashboard’s Correlations tab lights up when this field is non-empty, i.e. when a daemon-produced Report is fed into perf-sentinel report --input <daemon.json>.

§warnings: Vec<String>

Snapshot- or analysis-level warnings surfaced to consumers. The daemon’s /api/export/report cold-start path populates this with "daemon has not yet processed any events" so consumers can distinguish “daemon is empty” from “daemon emitted zero findings” without resorting to a 5xx HTTP status. Empty in CLI batch output. Additive on pre-0.5.16 baselines via skip_serializing_if.

§warning_details: Vec<Warning>

Structured snapshot warnings (0.5.19+). Coexists with the legacy warnings: Vec<String> field. Each entry carries a stable kind (suitable for alerting / aggregation) and a human-readable message. Renderers prefer this field when non-empty, fall back to warnings otherwise. Additive on pre-0.5.19 baselines via skip_serializing_if.

§acknowledged_findings: Vec<AcknowledgedFinding>

Findings filtered out by the user’s acknowledgments file (.perf-sentinel-acknowledgments.toml), paired with the matching ack metadata. Cleared from the wire payload by default; the CLI only retains it when --show-acknowledged is set so audit output stays opt-in. Additive on pre-0.5.17 baselines via serde(default).

§binary_version: String

CARGO_PKG_VERSION of the binary that wrote this report. Empty on reports written by binaries that predate this field.

§disclosure_waste: Option<DisclosureWaste>

Avoidable energy/carbon tiers (operator + canonical threshold), set only by the daemon archive path (the periodic aggregator reads them). None in batch and live outputs. Additive via serde(default).

Trait Implementations§

Source§

impl Clone for Report

Source§

fn clone(&self) -> Report

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Report

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Report

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Report

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more