runmat-config 0.5.0

Shared configuration schema and loaders for RunMat
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use clap::ValueEnum;
use serde::{Deserialize, Serialize};

use super::defaults::default_true;

/// Telemetry configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct TelemetryConfig {
    /// Enable runtime telemetry
    #[serde(default = "default_true")]
    pub enabled: bool,
    /// Echo each payload to stdout for transparency
    #[serde(default)]
    pub show_payloads: bool,
    /// Optional HTTP endpoint override
    pub http_endpoint: Option<String>,
    /// Optional UDP endpoint override (host:port)
    pub udp_endpoint: Option<String>,
    /// Bounded queue size for async delivery
    #[serde(default = "default_telemetry_queue")]
    pub queue_size: usize,
    /// Deliver telemetry synchronously on the caller thread
    #[serde(default)]
    pub sync_mode: bool,
    /// Drain policy used when the process exits
    #[serde(default)]
    pub drain_mode: TelemetryDrainMode,
    /// Maximum time to wait for telemetry drain on shutdown
    #[serde(default = "default_telemetry_drain_timeout_ms")]
    pub drain_timeout_ms: u64,
    /// Require ingestion key (self-built binaries default to false)
    #[serde(default = "default_true")]
    pub require_ingestion_key: bool,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ValueEnum, Default)]
#[serde(rename_all = "kebab-case")]
pub enum TelemetryDrainMode {
    None,
    #[default]
    All,
}

impl Default for TelemetryConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            show_payloads: false,
            http_endpoint: None,
            udp_endpoint: Some("udp.telemetry.runmat.com:7846".to_string()),
            queue_size: default_telemetry_queue(),
            sync_mode: false,
            drain_mode: TelemetryDrainMode::All,
            drain_timeout_ms: default_telemetry_drain_timeout_ms(),
            require_ingestion_key: true,
        }
    }
}

pub(crate) fn default_telemetry_queue() -> usize {
    256
}

pub(crate) fn default_telemetry_drain_timeout_ms() -> u64 {
    50
}