micromegas 0.22.0

Micromegas is a scalable observability solution.
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

//! axum-utils : observability middleware

// crate-specific lint exceptions:
#![allow(clippy::missing_errors_doc)]

use anyhow::Result;
use async_stream::stream;
use axum::response::Response;
use axum::{extract::Request, middleware::Next};
use micromegas_analytics::response_writer::ResponseWriter;
use micromegas_tracing::prelude::*;
use std::sync::Arc;
use tokio::sync::mpsc::Receiver;

use super::http_utils::get_client_ip;

/// observability_middleware logs http requests, their duration and status code
pub async fn observability_middleware(request: Request, next: Next) -> Response {
    let (parts, body) = request.into_parts();
    let uri = parts.uri.clone();
    let client_ip = get_client_ip(&parts.headers, &parts.extensions);
    info!(
        "request method={} uri={uri} client_ip={client_ip}",
        parts.method
    );
    let begin_ticks = now();
    let response = next.run(Request::from_parts(parts, body)).await;
    let end_ticks = now();
    let duration = end_ticks - begin_ticks;
    imetric!("request_duration", "ticks", duration as u64);
    info!(
        "response status={} uri={uri} client_ip={client_ip}",
        response.status()
    );
    response
}

/// Makes a streaming body from a Tokio MPSC receiver.
pub fn make_body_from_channel_receiver(mut rx: Receiver<bytes::Bytes>) -> axum::body::Body {
    let read_stream = stream! {
        while let Some(value) = rx.recv().await{
                yield Result::<bytes::Bytes>::Ok(value);
        }
    };
    axum::body::Body::from_stream(read_stream)
}

/// Streams a response by executing a callback that writes to a `ResponseWriter`.
///
/// This function creates a channel and a `ResponseWriter` that writes to this channel.
/// The `callback` is then executed in a separate Tokio task, allowing it to stream data
/// back to the client as it becomes available.
pub fn stream_request<F, Fut>(callback: F) -> Response
where
    F: FnOnce(Arc<ResponseWriter>) -> Fut + 'static + Send,
    Fut: std::future::Future<Output = Result<()>> + Send,
{
    let (tx, rx) = tokio::sync::mpsc::channel(10);
    let writer = Arc::new(ResponseWriter::new(Some(tx)));
    let response_body = make_body_from_channel_receiver(rx);
    spawn_with_context(async move {
        let service_call = callback(writer.clone());
        if let Err(e) = service_call.await {
            if writer.is_closed() {
                info!("Error happened, but connection is closed: {e:?}");
            } else {
                // the connection is live, this looks like a real error
                error!("{e:?}");
                if let Err(e) = writer.write_string(format!("{e:?}")).await {
                    //error writing can happen, probably not a big deal
                    info!("{e:?}");
                }
            }
        }
    });

    Response::builder().status(200).body(response_body).unwrap()
}