lxy 0.1.1

A convenient async http and RPC framework in Rust
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Configuration for OpenTelemetry integration.

use serde::Deserialize;

use crate::config::Config;

/// Protocol used for exporting telemetry data.
#[derive(Debug, Clone, Default, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum ExporterProtocol {
  /// gRPC protocol for OTLP
  Grpc,
  /// HTTP protocol for OTLP (default)
  #[default]
  Http,
}

/// Span processor type.
#[derive(Debug, Clone, Default, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum SpanProcessorType {
  /// Simple span processor - exports spans immediately (default)
  #[default]
  Simple,
  /// Batch span processor - batches spans before exporting (more efficient, requires async runtime)
  Batch,
}

/// Configuration for OpenTelemetry integration.
///
/// OpenTelemetry is automatically enabled when the `otel` feature is specified.
///
/// # Example Configuration
///
/// ```toml
/// [otel]
/// service_name = "my-service"
/// endpoint = "http://localhost:4317"
/// protocol = "grpc"
/// processor = "batch"
/// ```
#[derive(Debug, Clone, Deserialize)]
pub struct OtelConfig {
  /// Service name reported to the telemetry backend.
  #[serde(default = "default_service_name")]
  pub service_name: String,

  /// OTLP endpoint URL.
  #[serde(default = "default_endpoint")]
  pub endpoint: String,

  /// Protocol for exporting (grpc or http).
  #[serde(default)]
  pub protocol: ExporterProtocol,

  /// Span processor type (simple or batch).
  #[serde(default)]
  pub processor: SpanProcessorType,
}

impl Default for OtelConfig {
  fn default() -> Self {
    Self {
      service_name: default_service_name(),
      endpoint: default_endpoint(),
      protocol: ExporterProtocol::default(),
      processor: SpanProcessorType::default(),
    }
  }
}

fn default_service_name() -> String {
  "lxy-service".to_string()
}

fn default_endpoint() -> String {
  "http://localhost:4317".to_string()
}

impl Config for OtelConfig {
  fn name() -> &'static str {
    "otel"
  }
}

#[cfg(test)]
mod tests {
  use super::*;

  #[test]
  fn test_otel_config_defaults() {
    let config = OtelConfig::default();
    assert_eq!(config.service_name, "lxy-service");
    assert_eq!(config.endpoint, "http://localhost:4317");
    assert_eq!(config.protocol, ExporterProtocol::Http);
    assert_eq!(config.processor, SpanProcessorType::Simple);
  }

  #[test]
  fn test_otel_config_deserialize() {
    let toml_str = r#"
      service_name = "test-service"
      endpoint = "http://otel-collector:4317"
      protocol = "grpc"
      processor = "batch"
    "#;

    let config: OtelConfig = toml::from_str(toml_str).unwrap();

    assert_eq!(config.service_name, "test-service");
    assert_eq!(config.endpoint, "http://otel-collector:4317");
    assert_eq!(config.protocol, ExporterProtocol::Grpc);
    assert_eq!(config.processor, SpanProcessorType::Batch);
  }

  #[test]
  fn test_otel_config_deserialize_http_protocol() {
    let toml_str = r#"
      service_name = "http-service"
      endpoint = "http://localhost:4318"
      protocol = "http"
      processor = "simple"
    "#;

    let config: OtelConfig = toml::from_str(toml_str).unwrap();

    assert_eq!(config.protocol, ExporterProtocol::Http);
    assert_eq!(config.processor, SpanProcessorType::Simple);
  }

  #[test]
  fn test_otel_config_partial_deserialize() {
    let toml_str = r#"
      service_name = "minimal-service"
    "#;

    let config: OtelConfig = toml::from_str(toml_str).unwrap();

    assert_eq!(config.service_name, "minimal-service");
    assert_eq!(config.endpoint, "http://localhost:4317");
    assert_eq!(config.protocol, ExporterProtocol::Http);
    assert_eq!(config.processor, SpanProcessorType::Simple);
  }
}