khora_core/telemetry/mod.rs
1// Copyright 2025 eraflo
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Provides the foundational traits and data structures for engine telemetry.
16//!
17//! This module defines the "common language" for all metrics and monitoring within
18//! Khora. It contains the core contracts and data types that allow different parts
19//! of the engine to report performance data and resource usage in a standardized way.
20//!
21//! Following the CLAD architecture, this module defines the abstract "what" of
22//! telemetry, while `khora-telemetry` provides the central service for aggregating
23//! it, and `khora-infra` provides the concrete implementations for collecting it.
24
25pub mod metrics;
26pub mod monitoring;
27
28pub use self::metrics::{Metric, MetricId, MetricValue, MetricsError, MetricsResult};
29pub use self::monitoring::{
30 GpuReport, MemoryReport, MonitoredResourceType, ResourceMonitor, ResourceUsageReport,
31 VramProvider, VramReport,
32};