fraiseql-server 2.0.0-alpha.1

HTTP server for FraiseQL v2 GraphQL engine
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! Prometheus metrics for observability.
//!
//! Tracks:
//! - GraphQL query execution time
//! - Query success/error rates
//! - Database query performance
//! - Connection pool statistics
//! - HTTP request/response metrics

use std::{
    sync::{
        Arc,
        atomic::{AtomicU64, Ordering},
    },
    time::Instant,
};

/// Metrics collector for the server.
#[derive(Debug, Clone)]
pub struct MetricsCollector {
    /// Total GraphQL queries executed
    pub queries_total: Arc<AtomicU64>,

    /// Total successful queries
    pub queries_success: Arc<AtomicU64>,

    /// Total failed queries
    pub queries_error: Arc<AtomicU64>,

    /// Total query execution time (microseconds)
    pub queries_duration_us: Arc<AtomicU64>,

    /// Total database queries executed
    pub db_queries_total: Arc<AtomicU64>,

    /// Total database query time (microseconds)
    pub db_queries_duration_us: Arc<AtomicU64>,

    /// Total validation errors
    pub validation_errors_total: Arc<AtomicU64>,

    /// Total parse errors
    pub parse_errors_total: Arc<AtomicU64>,

    /// Total execution errors
    pub execution_errors_total: Arc<AtomicU64>,

    /// Total HTTP requests
    pub http_requests_total: Arc<AtomicU64>,

    /// Total HTTP 2xx responses
    pub http_responses_2xx: Arc<AtomicU64>,

    /// Total HTTP 4xx responses
    pub http_responses_4xx: Arc<AtomicU64>,

    /// Total HTTP 5xx responses
    pub http_responses_5xx: Arc<AtomicU64>,

    /// Cache hits
    pub cache_hits: Arc<AtomicU64>,

    /// Cache misses
    pub cache_misses: Arc<AtomicU64>,

    // Federation Metrics
    /// Federation entity resolutions (total)
    pub federation_entity_resolutions_total: Arc<AtomicU64>,

    /// Federation entity resolutions (errors)
    pub federation_entity_resolutions_errors: Arc<AtomicU64>,

    /// Federation entity resolution duration (microseconds)
    pub federation_entity_resolution_duration_us: Arc<AtomicU64>,

    /// Federation subgraph requests (total)
    pub federation_subgraph_requests_total: Arc<AtomicU64>,

    /// Federation subgraph requests (errors)
    pub federation_subgraph_requests_errors: Arc<AtomicU64>,

    /// Federation subgraph request duration (microseconds)
    pub federation_subgraph_request_duration_us: Arc<AtomicU64>,

    /// Federation mutations (total)
    pub federation_mutations_total: Arc<AtomicU64>,

    /// Federation mutations (errors)
    pub federation_mutations_errors: Arc<AtomicU64>,

    /// Federation mutation duration (microseconds)
    pub federation_mutation_duration_us: Arc<AtomicU64>,

    /// Federation entity cache hits
    pub federation_entity_cache_hits: Arc<AtomicU64>,

    /// Federation entity cache misses
    pub federation_entity_cache_misses: Arc<AtomicU64>,

    /// Federation errors
    pub federation_errors_total: Arc<AtomicU64>,
}

impl MetricsCollector {
    /// Create new metrics collector.
    #[must_use]
    pub fn new() -> Self {
        Self {
            queries_total: Arc::new(AtomicU64::new(0)),
            queries_success: Arc::new(AtomicU64::new(0)),
            queries_error: Arc::new(AtomicU64::new(0)),
            queries_duration_us: Arc::new(AtomicU64::new(0)),
            db_queries_total: Arc::new(AtomicU64::new(0)),
            db_queries_duration_us: Arc::new(AtomicU64::new(0)),
            validation_errors_total: Arc::new(AtomicU64::new(0)),
            parse_errors_total: Arc::new(AtomicU64::new(0)),
            execution_errors_total: Arc::new(AtomicU64::new(0)),
            http_requests_total: Arc::new(AtomicU64::new(0)),
            http_responses_2xx: Arc::new(AtomicU64::new(0)),
            http_responses_4xx: Arc::new(AtomicU64::new(0)),
            http_responses_5xx: Arc::new(AtomicU64::new(0)),
            cache_hits: Arc::new(AtomicU64::new(0)),
            cache_misses: Arc::new(AtomicU64::new(0)),
            federation_entity_resolutions_total: Arc::new(AtomicU64::new(0)),
            federation_entity_resolutions_errors: Arc::new(AtomicU64::new(0)),
            federation_entity_resolution_duration_us: Arc::new(AtomicU64::new(0)),
            federation_subgraph_requests_total: Arc::new(AtomicU64::new(0)),
            federation_subgraph_requests_errors: Arc::new(AtomicU64::new(0)),
            federation_subgraph_request_duration_us: Arc::new(AtomicU64::new(0)),
            federation_mutations_total: Arc::new(AtomicU64::new(0)),
            federation_mutations_errors: Arc::new(AtomicU64::new(0)),
            federation_mutation_duration_us: Arc::new(AtomicU64::new(0)),
            federation_entity_cache_hits: Arc::new(AtomicU64::new(0)),
            federation_entity_cache_misses: Arc::new(AtomicU64::new(0)),
            federation_errors_total: Arc::new(AtomicU64::new(0)),
        }
    }
}

impl MetricsCollector {
    /// Record entity resolution completion (all strategies).
    ///
    /// # Arguments
    ///
    /// * `duration_us` - Resolution duration in microseconds
    /// * `success` - Whether resolution succeeded
    pub fn record_entity_resolution(&self, duration_us: u64, success: bool) {
        self.federation_entity_resolutions_total.fetch_add(1, Ordering::Relaxed);
        self.federation_entity_resolution_duration_us
            .fetch_add(duration_us, Ordering::Relaxed);
        if !success {
            self.federation_entity_resolutions_errors.fetch_add(1, Ordering::Relaxed);
            self.federation_errors_total.fetch_add(1, Ordering::Relaxed);
        }
    }

    /// Record subgraph request completion.
    ///
    /// # Arguments
    ///
    /// * `duration_us` - Request duration in microseconds
    /// * `success` - Whether request succeeded (HTTP 2xx)
    pub fn record_subgraph_request(&self, duration_us: u64, success: bool) {
        self.federation_subgraph_requests_total.fetch_add(1, Ordering::Relaxed);
        self.federation_subgraph_request_duration_us
            .fetch_add(duration_us, Ordering::Relaxed);
        if !success {
            self.federation_subgraph_requests_errors.fetch_add(1, Ordering::Relaxed);
            self.federation_errors_total.fetch_add(1, Ordering::Relaxed);
        }
    }

    /// Record federation mutation execution.
    ///
    /// # Arguments
    ///
    /// * `duration_us` - Mutation duration in microseconds
    /// * `success` - Whether mutation succeeded
    pub fn record_mutation(&self, duration_us: u64, success: bool) {
        self.federation_mutations_total.fetch_add(1, Ordering::Relaxed);
        self.federation_mutation_duration_us.fetch_add(duration_us, Ordering::Relaxed);
        if !success {
            self.federation_mutations_errors.fetch_add(1, Ordering::Relaxed);
            self.federation_errors_total.fetch_add(1, Ordering::Relaxed);
        }
    }

    /// Record entity cache hit.
    pub fn record_entity_cache_hit(&self) {
        self.federation_entity_cache_hits.fetch_add(1, Ordering::Relaxed);
    }

    /// Record entity cache miss.
    pub fn record_entity_cache_miss(&self) {
        self.federation_entity_cache_misses.fetch_add(1, Ordering::Relaxed);
    }
}

impl Default for MetricsCollector {
    fn default() -> Self {
        Self::new()
    }
}

/// Guard for timing metrics.
pub struct TimingGuard {
    start:           Instant,
    duration_atomic: Arc<AtomicU64>,
}

impl TimingGuard {
    /// Create new timing guard.
    pub fn new(duration_atomic: Arc<AtomicU64>) -> Self {
        Self {
            start: Instant::now(),
            duration_atomic,
        }
    }

    /// Record duration in microseconds and consume guard.
    pub fn record(self) {
        let duration_us = self.start.elapsed().as_micros() as u64;
        self.duration_atomic.fetch_add(duration_us, Ordering::Relaxed);
    }
}

/// Prometheus metrics output format.
#[derive(Debug)]
pub struct PrometheusMetrics {
    /// Total GraphQL queries executed
    pub queries_total:              u64,
    /// Successful GraphQL queries
    pub queries_success:            u64,
    /// Failed GraphQL queries
    pub queries_error:              u64,
    /// Average query duration in milliseconds
    pub queries_avg_duration_ms:    f64,
    /// Total database queries executed
    pub db_queries_total:           u64,
    /// Average database query duration in milliseconds
    pub db_queries_avg_duration_ms: f64,
    /// Total validation errors
    pub validation_errors_total:    u64,
    /// Total parse errors
    pub parse_errors_total:         u64,
    /// Total execution errors
    pub execution_errors_total:     u64,
    /// Total HTTP requests processed
    pub http_requests_total:        u64,
    /// HTTP 2xx responses
    pub http_responses_2xx:         u64,
    /// HTTP 4xx responses
    pub http_responses_4xx:         u64,
    /// HTTP 5xx responses
    pub http_responses_5xx:         u64,
    /// Cache hit count
    pub cache_hits:                 u64,
    /// Cache miss count
    pub cache_misses:               u64,
    /// Cache hit ratio (0.0 to 1.0)
    pub cache_hit_ratio:            f64,
}

impl PrometheusMetrics {
    /// Generate Prometheus text format output.
    #[must_use]
    pub fn to_prometheus_format(&self) -> String {
        format!(
            r"# HELP fraiseql_graphql_queries_total Total GraphQL queries executed
# TYPE fraiseql_graphql_queries_total counter
fraiseql_graphql_queries_total {}

# HELP fraiseql_graphql_queries_success Total successful GraphQL queries
# TYPE fraiseql_graphql_queries_success counter
fraiseql_graphql_queries_success {}

# HELP fraiseql_graphql_queries_error Total failed GraphQL queries
# TYPE fraiseql_graphql_queries_error counter
fraiseql_graphql_queries_error {}

# HELP fraiseql_graphql_query_duration_ms Average query execution time in milliseconds
# TYPE fraiseql_graphql_query_duration_ms gauge
fraiseql_graphql_query_duration_ms {}

# HELP fraiseql_database_queries_total Total database queries executed
# TYPE fraiseql_database_queries_total counter
fraiseql_database_queries_total {}

# HELP fraiseql_database_query_duration_ms Average database query time in milliseconds
# TYPE fraiseql_database_query_duration_ms gauge
fraiseql_database_query_duration_ms {}

# HELP fraiseql_validation_errors_total Total validation errors
# TYPE fraiseql_validation_errors_total counter
fraiseql_validation_errors_total {}

# HELP fraiseql_parse_errors_total Total parse errors
# TYPE fraiseql_parse_errors_total counter
fraiseql_parse_errors_total {}

# HELP fraiseql_execution_errors_total Total execution errors
# TYPE fraiseql_execution_errors_total counter
fraiseql_execution_errors_total {}

# HELP fraiseql_http_requests_total Total HTTP requests
# TYPE fraiseql_http_requests_total counter
fraiseql_http_requests_total {}

# HELP fraiseql_http_responses_2xx Total 2xx HTTP responses
# TYPE fraiseql_http_responses_2xx counter
fraiseql_http_responses_2xx {}

# HELP fraiseql_http_responses_4xx Total 4xx HTTP responses
# TYPE fraiseql_http_responses_4xx counter
fraiseql_http_responses_4xx {}

# HELP fraiseql_http_responses_5xx Total 5xx HTTP responses
# TYPE fraiseql_http_responses_5xx counter
fraiseql_http_responses_5xx {}

# HELP fraiseql_cache_hits Total cache hits
# TYPE fraiseql_cache_hits counter
fraiseql_cache_hits {}

# HELP fraiseql_cache_misses Total cache misses
# TYPE fraiseql_cache_misses counter
fraiseql_cache_misses {}

# HELP fraiseql_cache_hit_ratio Cache hit ratio (0-1)
# TYPE fraiseql_cache_hit_ratio gauge
fraiseql_cache_hit_ratio {:.3}
",
            self.queries_total,
            self.queries_success,
            self.queries_error,
            self.queries_avg_duration_ms,
            self.db_queries_total,
            self.db_queries_avg_duration_ms,
            self.validation_errors_total,
            self.parse_errors_total,
            self.execution_errors_total,
            self.http_requests_total,
            self.http_responses_2xx,
            self.http_responses_4xx,
            self.http_responses_5xx,
            self.cache_hits,
            self.cache_misses,
            self.cache_hit_ratio,
        )
    }
}

impl From<&MetricsCollector> for PrometheusMetrics {
    fn from(collector: &MetricsCollector) -> Self {
        let queries_total = collector.queries_total.load(Ordering::Relaxed);
        let queries_success = collector.queries_success.load(Ordering::Relaxed);
        let queries_error = collector.queries_error.load(Ordering::Relaxed);
        let queries_duration_us = collector.queries_duration_us.load(Ordering::Relaxed);

        let db_queries_total = collector.db_queries_total.load(Ordering::Relaxed);
        let db_queries_duration_us = collector.db_queries_duration_us.load(Ordering::Relaxed);

        let cache_hits = collector.cache_hits.load(Ordering::Relaxed);
        let cache_misses = collector.cache_misses.load(Ordering::Relaxed);
        let cache_total = cache_hits + cache_misses;

        Self {
            queries_total,
            queries_success,
            queries_error,
            queries_avg_duration_ms: if queries_total > 0 {
                (queries_duration_us as f64 / queries_total as f64) / 1000.0
            } else {
                0.0
            },
            db_queries_total,
            db_queries_avg_duration_ms: if db_queries_total > 0 {
                (db_queries_duration_us as f64 / db_queries_total as f64) / 1000.0
            } else {
                0.0
            },
            validation_errors_total: collector.validation_errors_total.load(Ordering::Relaxed),
            parse_errors_total: collector.parse_errors_total.load(Ordering::Relaxed),
            execution_errors_total: collector.execution_errors_total.load(Ordering::Relaxed),
            http_requests_total: collector.http_requests_total.load(Ordering::Relaxed),
            http_responses_2xx: collector.http_responses_2xx.load(Ordering::Relaxed),
            http_responses_4xx: collector.http_responses_4xx.load(Ordering::Relaxed),
            http_responses_5xx: collector.http_responses_5xx.load(Ordering::Relaxed),
            cache_hits,
            cache_misses,
            cache_hit_ratio: if cache_total > 0 {
                cache_hits as f64 / cache_total as f64
            } else {
                0.0
            },
        }
    }
}

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

    #[test]
    fn test_metrics_collector_creation() {
        let collector = MetricsCollector::new();
        assert_eq!(collector.queries_total.load(Ordering::Relaxed), 0);
        assert_eq!(collector.queries_success.load(Ordering::Relaxed), 0);
    }

    #[test]
    fn test_metrics_increment() {
        let collector = MetricsCollector::new();
        collector.queries_total.fetch_add(5, Ordering::Relaxed);
        collector.queries_success.fetch_add(4, Ordering::Relaxed);
        collector.queries_error.fetch_add(1, Ordering::Relaxed);

        assert_eq!(collector.queries_total.load(Ordering::Relaxed), 5);
        assert_eq!(collector.queries_success.load(Ordering::Relaxed), 4);
        assert_eq!(collector.queries_error.load(Ordering::Relaxed), 1);
    }

    #[test]
    fn test_prometheus_output_format() {
        let collector = MetricsCollector::new();
        collector.queries_total.store(100, Ordering::Relaxed);
        collector.queries_success.store(95, Ordering::Relaxed);
        collector.queries_error.store(5, Ordering::Relaxed);

        let metrics = PrometheusMetrics::from(&collector);
        let output = metrics.to_prometheus_format();

        assert!(output.contains("fraiseql_graphql_queries_total 100"));
        assert!(output.contains("fraiseql_graphql_queries_success 95"));
        assert!(output.contains("fraiseql_graphql_queries_error 5"));
        assert!(output.contains("# HELP"));
        assert!(output.contains("# TYPE"));
    }

    #[test]
    fn test_timing_guard() {
        let duration_atomic = Arc::new(AtomicU64::new(0));
        let guard = TimingGuard::new(duration_atomic.clone());

        // Add a small delay to ensure measurable time
        std::thread::sleep(std::time::Duration::from_micros(100));
        guard.record();

        let recorded = duration_atomic.load(Ordering::Relaxed);
        assert!(recorded >= 100);
        assert!(recorded < 1_000_000); // Should be less than 1 second
    }

    #[test]
    fn test_cache_hit_ratio_calculation() {
        let collector = MetricsCollector::new();
        collector.cache_hits.store(75, Ordering::Relaxed);
        collector.cache_misses.store(25, Ordering::Relaxed);

        let metrics = PrometheusMetrics::from(&collector);
        assert!((metrics.cache_hit_ratio - 0.75).abs() < 0.001);
    }

    #[test]
    fn test_average_duration_calculation() {
        let collector = MetricsCollector::new();
        collector.queries_total.store(10, Ordering::Relaxed);
        collector.queries_duration_us.store(50_000, Ordering::Relaxed); // 50ms total

        let metrics = PrometheusMetrics::from(&collector);
        assert!((metrics.queries_avg_duration_ms - 5.0).abs() < 0.01); // 5ms average
    }
}