MeasureOptions Struct

Options for framework-owned runtime measurement. More...

Declaration

struct simaai::neat::MeasureOptions { ... }

Included Headers

#include <Run.h>

Public Member Attributes Index

int	duration_ms = 10000
	Timed measurement window. More...
int	warmup_ms = 1000
	Warmup window excluded from latency/metrics results. More...
int	timeout_ms = 5000
	Per-output pull timeout. More...
bool	include_plugin_latency = true
	Capture per-plugin/kernel execution latency through the LTTng metrics collector. More...
MetricsTraceSource	plugin_latency_source = MetricsTraceSource::Auto
	Backend used for plugin execution latency. More...
bool	include_edge_latency = true
	Include low-overhead inter-plugin/edge/queue diagnostics in the report. More...
bool	include_message_latency = false
	Enable exact per-message LTTng edge tracing. Higher volume; off by default. More...
MetricsTraceSource	message_latency_source = MetricsTraceSource::Auto
	Backend used for exact per-message edge tracing. More...
bool	retain_metrics_trace = false
	Keep the private LTTng CTF trace directory after parsing for support/debug. More...
std::string	metrics_trace_dir
	Optional parent/output directory for retained or temporary metrics traces. More...
bool	include_power = true
	Include power telemetry when enabled on the Run. More...
std::string	title = "NEAT measurement"
	Optional report metadata. More...
std::string	model
std::string	input
std::string	placement
int	logical_batch_size = 1

Description

Options for framework-owned runtime measurement.

The defaults collect the measurements most applications need without asking examples to reimplement timers, percentile math, plugin/edge aggregation, or terminal formatting.

Definition at line 288 of file Run.h.

Public Member Attributes

duration_ms

int simaai::neat::MeasureOptions::duration_ms = 10000

Timed measurement window.

Definition at line 289 of file Run.h.

include_edge_latency

bool simaai::neat::MeasureOptions::include_edge_latency = true

Include low-overhead inter-plugin/edge/queue diagnostics in the report.

Definition at line 297 of file Run.h.

include_message_latency

bool simaai::neat::MeasureOptions::include_message_latency = false

Enable exact per-message LTTng edge tracing. Higher volume; off by default.

Definition at line 299 of file Run.h.

include_plugin_latency

bool simaai::neat::MeasureOptions::include_plugin_latency = true

Capture per-plugin/kernel execution latency through the LTTng metrics collector.

Definition at line 293 of file Run.h.

include_power

bool simaai::neat::MeasureOptions::include_power = true

Include power telemetry when enabled on the Run.

Definition at line 306 of file Run.h.

input

std::string simaai::neat::MeasureOptions::input

Definition at line 312 of file Run.h.

logical_batch_size

int simaai::neat::MeasureOptions::logical_batch_size = 1

Definition at line 314 of file Run.h.

message_latency_source

MetricsTraceSource simaai::neat::MeasureOptions::message_latency_source = MetricsTraceSource::Auto

Backend used for exact per-message edge tracing.

Definition at line 301 of file Run.h.

metrics_trace_dir

std::string simaai::neat::MeasureOptions::metrics_trace_dir

Optional parent/output directory for retained or temporary metrics traces.

Definition at line 305 of file Run.h.

model

std::string simaai::neat::MeasureOptions::model

Definition at line 311 of file Run.h.

placement

std::string simaai::neat::MeasureOptions::placement

Definition at line 313 of file Run.h.

plugin_latency_source

MetricsTraceSource simaai::neat::MeasureOptions::plugin_latency_source = MetricsTraceSource::Auto

Backend used for plugin execution latency.

Definition at line 295 of file Run.h.

retain_metrics_trace

bool simaai::neat::MeasureOptions::retain_metrics_trace = false

Keep the private LTTng CTF trace directory after parsing for support/debug.

Definition at line 303 of file Run.h.

timeout_ms

int simaai::neat::MeasureOptions::timeout_ms = 5000

Per-output pull timeout.

Definition at line 291 of file Run.h.

title

std::string simaai::neat::MeasureOptions::title = "NEAT measurement"

Optional report metadata.

Model-owned wrappers/examples can fill these in so the standardized report is informative without custom formatting code.

Definition at line 310 of file Run.h.

warmup_ms

int simaai::neat::MeasureOptions::warmup_ms = 1000

Warmup window excluded from latency/metrics results.

Definition at line 290 of file Run.h.

---

The documentation for this struct was generated from the following file:

• Run.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.