RuntimeMetrics.h File

Unified runtime metrics schema and serializers. More...

Included Headers

#include "pipeline/PowerTelemetry.h" #include <cstdint> #include <string> #include <utility> #include <vector>

Namespaces Index

namespace	simaai
namespace	neat

Classes Index

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...

Description

Unified runtime metrics schema and serializers.

File Listing

The file content with the documentation metadata removed is:

1

6#pragma once

7

8#include "pipeline/PowerTelemetry.h"

9

10#include <cstdint>

11#include <string>

12#include <utility>

13#include <vector>

14

15namespace simaai::neat {

16

21enum class RuntimeMetricsFormat {

22 Text,

23 Json,

24 CompactText

25};

26

31struct RuntimeMetricsOptions {

32 bool include_power = true;

33 bool include_diagnostics = false;

34 bool include_pipeline = false;

35 bool include_percentiles = false;

36};

37

42struct RuntimeLatencyMetrics {

43 double avg_ms = 0.0;

44 double min_ms = 0.0;

45 double max_ms = 0.0;

46 double p50_ms = 0.0;

47 double p95_ms = 0.0;

48 bool has_percentiles = false;

49};

50

55struct RuntimeCounters {

56 std::uint64_t inputs_enqueued = 0;

57 std::uint64_t inputs_dropped = 0;

58 std::uint64_t inputs_pushed = 0;

59 std::uint64_t outputs_ready = 0;

60 std::uint64_t outputs_pulled = 0;

61 std::uint64_t outputs_dropped = 0;

62};

63

68struct RuntimeMetricValue {

69 std::string name;

70 double value = 0.0;

71 std::string unit;

72};

73

78struct RuntimeMetricGroup {

79 std::string name;

80 std::vector<RuntimeMetricValue> values;

81};

82

87struct RuntimeMetrics {

88 std::string source_kind;

89 std::string source_name;

90 double elapsed_seconds = 0.0;

91 double throughput_fps = 0.0;

92 RuntimeLatencyMetrics latency;

93 RuntimeCounters counters;

94 PowerSummary power;

95 std::vector<std::pair<std::string, std::string>> metadata;

96 std::vector<RuntimeMetricGroup> groups;

97};

98

103std::string format_runtime_metrics(const RuntimeMetrics& metrics,

104 RuntimeMetricsFormat format = RuntimeMetricsFormat::Text);

105

110std::string runtime_metrics_to_json(const RuntimeMetrics& metrics, int indent = 0);

111

116std::string runtime_metrics_to_text(const RuntimeMetrics& metrics);

117

122std::string runtime_metrics_to_compact_text(const RuntimeMetrics& metrics);

123

124} // namespace simaai::neat

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.