otlp-arrow-library 0.6.4

Cross-platform Rust library for receiving OTLP messages via gRPC and writing to Arrow IPC files
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
//! Mock OTLP service for testing
//!
//! Provides a mock service that can receive OTLP messages via both gRPC interface
//! and public API methods for end-to-end testing.

use opentelemetry_proto::tonic::collector::metrics::v1::{
    ExportMetricsServiceRequest, ExportMetricsServiceResponse,
    metrics_service_server::{MetricsService, MetricsServiceServer},
};
use opentelemetry_proto::tonic::collector::trace::v1::{
    ExportTraceServiceRequest, ExportTraceServiceResponse,
    trace_service_server::{TraceService, TraceServiceServer},
};
use opentelemetry_sdk::metrics::data::ResourceMetrics;
use opentelemetry_sdk::trace::SpanData;
use std::net::SocketAddr;
use std::sync::Arc;
use tokio::sync::RwLock;
use tokio_stream::wrappers::TcpListenerStream;
use tonic::{Request, Response, Status};
use tracing::info;

// Re-export Arrow Flight types for mock service
use arrow::record_batch::RecordBatch;
use arrow_flight::{
    Action, ActionType, Criteria, Empty, FlightData, FlightDescriptor, FlightInfo,
    HandshakeRequest, HandshakeResponse, PollInfo, PutResult, SchemaResult, Ticket,
    flight_service_server::{FlightService, FlightServiceServer},
};
use std::pin::Pin;
use tokio_stream::{Stream, StreamExt};
use tonic::Streaming;

/// Mock OTLP service state
#[derive(Debug, Default)]
struct MockServiceState {
    /// Traces received via mock service
    received_traces: Vec<SpanData>,
    /// Metrics received via mock service
    received_metrics: Vec<ResourceMetrics>,
    /// Count of gRPC calls received
    grpc_calls: u64,
    /// Count of public API calls received
    api_calls: u64,
}

/// Mock OTLP service for testing
#[derive(Debug, Clone)]
pub struct MockOtlpService {
    state: Arc<RwLock<MockServiceState>>,
}

/// Result type for mock service start
pub struct MockServiceAddresses {
    /// Protobuf gRPC server address
    pub protobuf_addr: String,
    /// Arrow Flight gRPC server address
    pub arrow_flight_addr: String,
}

impl MockOtlpService {
    /// Create a new mock OTLP service
    pub fn new() -> Self {
        Self {
            state: Arc::new(RwLock::new(MockServiceState::default())),
        }
    }

    /// Start the mock service with both Protobuf and Arrow Flight servers
    /// Returns the addresses where the servers are listening
    pub async fn start(&self) -> Result<MockServiceAddresses, String> {
        // Start Protobuf server
        let protobuf_addr = "127.0.0.1:0"
            .parse::<SocketAddr>()
            .map_err(|e| format!("Failed to parse protobuf address: {}", e))?;
        let protobuf_listener = tokio::net::TcpListener::bind(&protobuf_addr)
            .await
            .map_err(|e| format!("Failed to bind protobuf listener: {}", e))?;
        let protobuf_addr = protobuf_listener
            .local_addr()
            .map_err(|e| format!("Failed to get protobuf local address: {}", e))?;
        let protobuf_addr_str = format!("http://{}", protobuf_addr);

        // Start Arrow Flight server
        let arrow_flight_addr = "127.0.0.1:0"
            .parse::<SocketAddr>()
            .map_err(|e| format!("Failed to parse arrow flight address: {}", e))?;
        let arrow_flight_listener = tokio::net::TcpListener::bind(&arrow_flight_addr)
            .await
            .map_err(|e| format!("Failed to bind arrow flight listener: {}", e))?;
        let arrow_flight_addr = arrow_flight_listener
            .local_addr()
            .map_err(|e| format!("Failed to get arrow flight local address: {}", e))?;
        let arrow_flight_addr_str = format!("http://{}", arrow_flight_addr);

        let state = self.state.clone();

        // Start Protobuf server in background
        let protobuf_state = state.clone();
        tokio::spawn(async move {
            let trace_service = MockTraceServiceImpl {
                state: protobuf_state.clone(),
            };
            let metrics_service = MockMetricsServiceImpl {
                state: protobuf_state,
            };

            let server = tonic::transport::Server::builder()
                .add_service(TraceServiceServer::new(trace_service))
                .add_service(MetricsServiceServer::new(metrics_service))
                .serve_with_incoming(TcpListenerStream::new(protobuf_listener))
                .await;

            if let Err(e) = server {
                eprintln!("Protobuf server error: {}", e);
            }
        });

        // Start Arrow Flight server in background
        let arrow_flight_state = state;
        tokio::spawn(async move {
            let flight_service = MockFlightServiceImpl {
                state: arrow_flight_state,
            };

            let svc = FlightServiceServer::new(flight_service);
            let server = tonic::transport::Server::builder()
                .add_service(svc)
                .serve_with_incoming(TcpListenerStream::new(arrow_flight_listener))
                .await;

            if let Err(e) = server {
                eprintln!("Arrow Flight server error: {}", e);
            }
        });

        info!(
            protobuf_addr = %protobuf_addr_str,
            arrow_flight_addr = %arrow_flight_addr_str,
            "Mock OTLP service started"
        );

        Ok(MockServiceAddresses {
            protobuf_addr: protobuf_addr_str,
            arrow_flight_addr: arrow_flight_addr_str,
        })
    }

    /// Receive a trace via public API
    pub async fn receive_trace(&self, span: SpanData) {
        let mut state = self.state.write().await;
        state.received_traces.push(span);
        state.api_calls += 1;
    }

    /// Receive metrics via public API
    pub async fn receive_metric(&self, metrics: ResourceMetrics) {
        let mut state = self.state.write().await;
        state.received_metrics.push(metrics);
        state.api_calls += 1;
    }

    /// Assert that the expected number of traces were received
    pub async fn assert_traces_received(&self, expected_count: usize) -> Result<(), String> {
        let state = self.state.read().await;
        if state.received_traces.len() != expected_count {
            Err(format!(
                "Expected {} traces, but received {}",
                expected_count,
                state.received_traces.len()
            ))
        } else {
            Ok(())
        }
    }

    /// Assert that the expected number of metrics were received
    pub async fn assert_metrics_received(&self, expected_count: usize) -> Result<(), String> {
        let state = self.state.read().await;
        if state.received_metrics.len() != expected_count {
            Err(format!(
                "Expected {} metrics, but received {}",
                expected_count,
                state.received_metrics.len()
            ))
        } else {
            Ok(())
        }
    }

    /// Get the number of gRPC calls received
    pub async fn grpc_calls_count(&self) -> u64 {
        let state = self.state.read().await;
        state.grpc_calls
    }

    /// Get the number of API calls received
    pub async fn api_calls_count(&self) -> u64 {
        let state = self.state.read().await;
        state.api_calls
    }

    /// Reset the mock service state (for test isolation)
    pub async fn reset(&self) {
        let mut state = self.state.write().await;
        *state = MockServiceState::default();
    }
}

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

/// Mock Trace Service implementation for Protobuf
#[derive(Debug, Clone)]
struct MockTraceServiceImpl {
    state: Arc<RwLock<MockServiceState>>,
}

#[tonic::async_trait]
impl TraceService for MockTraceServiceImpl {
    async fn export(
        &self,
        request: Request<ExportTraceServiceRequest>,
    ) -> Result<Response<ExportTraceServiceResponse>, Status> {
        let req = request.into_inner();

        // Convert protobuf to spans using the same conversion as the real server
        let spans = crate::otlp::server::convert_trace_request_to_spans(&req)
            .map_err(|e| Status::internal(format!("Failed to convert traces: {}", e)))?;

        // Store in mock state
        {
            let mut state = self.state.write().await;
            state.received_traces.extend(spans);
            state.grpc_calls += 1;
        }

        Ok(Response::new(ExportTraceServiceResponse {
            partial_success: None,
        }))
    }
}

/// Mock Metrics Service implementation for Protobuf
#[derive(Debug, Clone)]
struct MockMetricsServiceImpl {
    state: Arc<RwLock<MockServiceState>>,
}

#[tonic::async_trait]
impl MetricsService for MockMetricsServiceImpl {
    async fn export(
        &self,
        request: Request<ExportMetricsServiceRequest>,
    ) -> Result<Response<ExportMetricsServiceResponse>, Status> {
        let req = request.into_inner();

        // Convert protobuf to ResourceMetrics using the same conversion as the real server
        let resource_metrics =
            crate::otlp::server::convert_metrics_request_to_resource_metrics(&req)
                .map_err(|e| Status::internal(format!("Failed to convert metrics: {}", e)))?;

        // Store in mock state
        if let Some(metrics) = resource_metrics {
            let mut state = self.state.write().await;
            state.received_metrics.push(metrics);
            state.grpc_calls += 1;
        }

        Ok(Response::new(ExportMetricsServiceResponse {
            partial_success: None,
        }))
    }
}

/// Mock Arrow Flight Service implementation
#[derive(Debug, Clone)]
struct MockFlightServiceImpl {
    state: Arc<RwLock<MockServiceState>>,
}

#[tonic::async_trait]
impl FlightService for MockFlightServiceImpl {
    type HandshakeStream = Pin<Box<dyn Stream<Item = Result<HandshakeResponse, Status>> + Send>>;
    type DoGetStream = Pin<Box<dyn Stream<Item = Result<FlightData, Status>> + Send>>;
    type DoPutStream = Pin<Box<dyn Stream<Item = Result<PutResult, Status>> + Send>>;
    type DoActionStream = Pin<Box<dyn Stream<Item = Result<arrow_flight::Result, Status>> + Send>>;
    type DoExchangeStream = Pin<Box<dyn Stream<Item = Result<FlightData, Status>> + Send>>;
    type ListActionsStream = Pin<Box<dyn Stream<Item = Result<ActionType, Status>> + Send>>;
    type ListFlightsStream = Pin<Box<dyn Stream<Item = Result<FlightInfo, Status>> + Send>>;

    async fn handshake(
        &self,
        _request: Request<Streaming<HandshakeRequest>>,
    ) -> Result<Response<Self::HandshakeStream>, Status> {
        Err(Status::unimplemented("Handshake not implemented"))
    }

    async fn list_flights(
        &self,
        _request: Request<Criteria>,
    ) -> Result<Response<Self::ListFlightsStream>, Status> {
        Err(Status::unimplemented("ListFlights not implemented"))
    }

    async fn get_flight_info(
        &self,
        _request: Request<FlightDescriptor>,
    ) -> Result<Response<FlightInfo>, Status> {
        Err(Status::unimplemented("GetFlightInfo not implemented"))
    }

    async fn poll_flight_info(
        &self,
        _request: Request<FlightDescriptor>,
    ) -> Result<Response<PollInfo>, Status> {
        Err(Status::unimplemented("PollFlightInfo not implemented"))
    }

    async fn get_schema(
        &self,
        _request: Request<FlightDescriptor>,
    ) -> Result<Response<SchemaResult>, Status> {
        Err(Status::unimplemented("GetSchema not implemented"))
    }

    async fn do_get(
        &self,
        _request: Request<Ticket>,
    ) -> Result<Response<Self::DoGetStream>, Status> {
        Err(Status::unimplemented("DoGet not implemented"))
    }

    async fn do_put(
        &self,
        request: Request<Streaming<FlightData>>,
    ) -> Result<Response<Self::DoPutStream>, Status> {
        let mut stream = request.into_inner();
        let state = self.state.clone();

        // Process incoming FlightData stream
        tokio::spawn(async move {
            let mut batches = Vec::new();

            while let Some(Ok(flight_data)) = stream.next().await {
                // Decode FlightData to RecordBatch
                if let Ok(batch) = decode_flight_data(&flight_data) {
                    batches.push(batch);
                }
            }

            // Convert batches to spans/metrics and store in mock state
            for batch in batches {
                // Try to convert to traces
                if let Ok(spans) = crate::otlp::server_arrow::convert_arrow_batch_to_spans(&batch)
                    && !spans.is_empty()
                {
                    let mut state = state.write().await;
                    state.received_traces.extend(spans);
                    state.grpc_calls += 1;
                    continue;
                }

                // Try to convert to metrics
                if let Ok(Some(metrics)) =
                    crate::otlp::server_arrow::convert_arrow_batch_to_resource_metrics(&batch)
                {
                    let mut state = state.write().await;
                    state.received_metrics.push(metrics);
                    state.grpc_calls += 1;
                }
            }
        });

        // Return empty stream as acknowledgment
        let output = futures::stream::empty();
        Ok(Response::new(Box::pin(output)))
    }

    async fn do_action(
        &self,
        _request: Request<Action>,
    ) -> Result<Response<Self::DoActionStream>, Status> {
        Err(Status::unimplemented("DoAction not implemented"))
    }

    async fn list_actions(
        &self,
        _request: Request<Empty>,
    ) -> Result<Response<Self::ListActionsStream>, Status> {
        Err(Status::unimplemented("ListActions not implemented"))
    }

    async fn do_exchange(
        &self,
        _request: Request<Streaming<FlightData>>,
    ) -> Result<Response<Self::DoExchangeStream>, Status> {
        Err(Status::unimplemented("DoExchange not implemented"))
    }
}

/// Decode Arrow Flight data to RecordBatch
fn decode_flight_data(flight_data: &FlightData) -> Result<RecordBatch, anyhow::Error> {
    use arrow::ipc::reader::StreamReader;
    use std::io::Cursor;

    let data = &flight_data.data_header;
    let cursor = Cursor::new(data);
    let mut reader = StreamReader::try_new(cursor, None)
        .map_err(|e| anyhow::anyhow!("Failed to create StreamReader: {}", e))?;

    let batch = reader
        .next()
        .ok_or_else(|| anyhow::anyhow!("No batch in FlightData"))?
        .map_err(|e| anyhow::anyhow!("Failed to read batch: {}", e))?;

    Ok(batch)
}