Diagnostics
PipelineReport, debug probes, and observability helpers. More...
Classes Index
| struct | PowerRailConfig |
|
Configuration for one PMBus rail exposed by a paged PMIC. More... | |
| struct | PowerFieldReading |
|
One scalar rail field read from a PMIC. More... | |
| struct | PowerRailReading |
|
Snapshot for one rail. More... | |
| struct | PowerSnapshot |
|
Point-in-time board power snapshot. More... | |
| struct | PowerMonitorOptions |
|
Options for a PowerMonitor. More... | |
| struct | PowerFieldSummary |
|
Summary statistics for one scalar rail field. More... | |
| struct | PowerRailSummary |
|
Summary statistics for one rail. More... | |
| struct | PowerSummary |
|
Aggregated power monitor result. More... | |
| class | PowerMonitor |
|
Background SOM power sampler. More... | |
| struct | InputDropInfo |
|
Diagnostic record for a dropped input frame. More... | |
| struct | InputStreamStats |
|
Per-Run input-side telemetry: counts, drops, and timing averages. More... | |
| struct | RunStats |
|
Per-Run end-to-end statistics: counts and latency. More... | |
| struct | RunMeasurementSummary |
|
One-call runtime measurement summary. More... | |
| struct | RunStageStats |
|
Per-stage timing telemetry — how long each stage takes per sample. More... | |
| struct | RunElementTimingStats |
|
Per-element timing — finer-grained than per-stage; one row per GStreamer element. More... | |
| struct | RunElementFlowStats |
|
Per-element data-flow telemetry — buffer and byte counts, plus caps changes. More... | |
| struct | RunElementPadTimingStats |
|
Per-pad timing — finest-grained telemetry, one row per (element, pad). More... | |
| struct | RunDiagSnapshot |
|
Aggregate diagnostic snapshot: stages, boundaries, per-element, per-pad. More... | |
| struct | RunReportOptions |
|
Toggles for what Run::report() includes in its formatted text output. More... | |
| struct | RuntimeMetricsOptions |
|
Options controlling collection and rendering of runtime metrics. More... | |
| struct | RuntimeLatencyMetrics |
|
Basic latency summary in milliseconds. More... | |
| struct | RuntimeCounters |
|
Common input/output/drop counters. More... | |
| struct | RuntimeMetricValue |
|
Generic named scalar metric. More... | |
| struct | RuntimeMetricGroup |
|
Generic named metric group for adapter-specific diagnostics. More... | |
| struct | RuntimeMetrics |
|
Unified runtime metrics returned by Run, Model::Runner, GraphRun, and tools. More... | |
| class | SessionError |
|
Framework exception type carrying a structured SessionReport. More... | |
| struct | VerboseOptions |
|
Per-topic framework verbosity controls. More... | |
| struct | ValidateOptions |
|
Options for Session::validate(). More... | |
| struct | PullError |
|
Structured error returned by Run::pull() when status is Error. More... | |
| struct | BusMessage |
|
A single GStreamer bus message captured during pipeline build/run. More... | |
| struct | BoundaryFlowStats |
|
Per-boundary flow statistics — buffer counts at identity probes between Nodes. More... | |
| struct | NodeReport |
|
Per-Node entry in the report, listing what that Node produced in the GStreamer pipeline. More... | |
| struct | BuildAdaptationAction |
|
One line item from the build-adaptation log. More... | |
| struct | BuildAdaptationSummary |
|
Snapshot of build-time adaptation state — present for build(input) flows. More... | |
| struct | SessionReport |
|
Structured pipeline diagnostics — the framework's primary triage record. More... | |
Enumerations Index
| enum class | PowerMonitorProfile { ... } |
|
Named board-level power monitor profiles. More... | |
| enum class | RuntimeMetricsFormat { ... } |
| enum class | VerbosityLevel { ... } |
|
Coarse-grained framework verbosity selector. More... | |
Functions Index
| std::vector< PowerRailConfig > | default_modalix_som_power_rails () |
|
Default Modalix SOM PMIC rail table from the board measurement scripts. More... | |
| std::vector< PowerRailConfig > | default_modalix_dvt_power_rails () |
|
Default Modalix DVT PMIC rail table. More... | |
| PowerMonitorProfile | detect_default_power_monitor_profile () |
|
Detect the most likely built-in board power profile for the current host. More... | |
| std::string | power_monitor_profile_name (PowerMonitorProfile profile) |
|
Human-readable name for a power monitor profile. More... | |
| std::vector< PowerRailConfig > | power_rails_for_profile (PowerMonitorProfile profile) |
|
Resolve a built-in board profile to its rail table. More... | |
| PowerMonitorOptions | board_power_monitor_options (int sample_interval_ms=100, PowerMonitorProfile profile=PowerMonitorProfile::Auto) |
|
Convenience options enabling board power monitoring with optional auto-detect. More... | |
| PowerMonitorOptions | modalix_som_power_monitor_options (int sample_interval_ms=100) |
|
Convenience options enabling Modalix SOM power monitoring. More... | |
| PowerMonitorOptions | modalix_dvt_power_monitor_options (int sample_interval_ms=100) |
|
Convenience options enabling Modalix DVT power monitoring. More... | |
| PowerSnapshot | read_power_snapshot (const PowerMonitorOptions &options) |
|
Read one immediate power snapshot using native Linux I2C access. More... | |
| std::string | format_power_summary (const PowerSummary &summary) |
|
Format a compact human-readable power summary. More... | |
| std::string | power_summary_to_json (const PowerSummary &summary, int indent=2) |
|
Format power summary as a JSON object. More... | |
| std::string | format_runtime_metrics (const RuntimeMetrics &metrics, RuntimeMetricsFormat format=RuntimeMetricsFormat::Text) |
|
Render runtime metrics in the requested format. More... | |
| std::string | runtime_metrics_to_json (const RuntimeMetrics &metrics, int indent=0) |
|
Render runtime metrics as JSON. More... | |
| std::string | runtime_metrics_to_text (const RuntimeMetrics &metrics) |
|
Render runtime metrics as human-readable text. More... | |
| std::string | runtime_metrics_to_compact_text (const RuntimeMetrics &metrics) |
|
Render runtime metrics as one compact line. More... | |
Description
PipelineReport, debug probes, and observability helpers.
Enumerations
PowerMonitorProfile
| strong |
Named board-level power monitor profiles.
- Enumeration values
Definition at line 20 of file PowerTelemetry.h.
RuntimeMetricsFormat
| strong |
Output format for runtime metrics reports.
- Enumeration values
-
Text Human-readable multi-line report Json JSON object suitable for tools CompactText One-line headline summary
Definition at line 21 of file RuntimeMetrics.h.
VerbosityLevel
| strong |
Coarse-grained framework verbosity selector.
- Enumeration values
-
Quiet Suppress topic-specific messages; progress is controlled separately Production Concise phase updates suitable for end users Verbose Rich human-facing diagnostics across all framework topics
Combined with the per-topic flags in VerboseOptions to decide what diagnostic output the framework emits at runtime. Most users pick one of the three preset factories on VerboseOptions (quiet(), production(), debug_all()) rather than setting flags by hand.
Definition at line 49 of file SessionOptions.h.
Functions
board_power_monitor_options()
|
Convenience options enabling board power monitoring with optional auto-detect.
Definition at line 171 of file PowerTelemetry.h.
default_modalix_dvt_power_rails()
|
Default Modalix DVT PMIC rail table.
DVT Linux PMBus access is intentionally limited to the verified stable reading: bus 4, PMIC 0x4d, page 0, POUT register 0x96, exponent -2.
Definition at line 146 of file PowerTelemetry.h.
default_modalix_som_power_rails()
|
Default Modalix SOM PMIC rail table from the board measurement scripts.
Definition at line 137 of file PowerTelemetry.h.
detect_default_power_monitor_profile()
|
Detect the most likely built-in board power profile for the current host.
Definition at line 152 of file PowerTelemetry.h.
format_power_summary()
|
Format a compact human-readable power summary.
Definition at line 196 of file PowerTelemetry.h.
format_runtime_metrics()
|
Render runtime metrics in the requested format.
Definition at line 103 of file RuntimeMetrics.h.
modalix_dvt_power_monitor_options()
|
Convenience options enabling Modalix DVT power monitoring.
Definition at line 184 of file PowerTelemetry.h.
modalix_som_power_monitor_options()
|
Convenience options enabling Modalix SOM power monitoring.
Definition at line 178 of file PowerTelemetry.h.
power_monitor_profile_name()
|
Human-readable name for a power monitor profile.
Definition at line 158 of file PowerTelemetry.h.
power_rails_for_profile()
|
Resolve a built-in board profile to its rail table.
Definition at line 164 of file PowerTelemetry.h.
power_summary_to_json()
|
Format power summary as a JSON object.
Definition at line 202 of file PowerTelemetry.h.
read_power_snapshot()
|
Read one immediate power snapshot using native Linux I2C access.
Definition at line 190 of file PowerTelemetry.h.
runtime_metrics_to_compact_text()
|
Render runtime metrics as one compact line.
Definition at line 122 of file RuntimeMetrics.h.
runtime_metrics_to_json()
|
Render runtime metrics as JSON.
Definition at line 110 of file RuntimeMetrics.h.
runtime_metrics_to_text()
|
Render runtime metrics as human-readable text.
Definition at line 116 of file RuntimeMetrics.h.
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.