Integração com Axum
Integre o ImmutableLog em qualquer aplicação Axum com um middleware `from_fn_with_state` que captura automaticamente todas as requisições HTTP. O envio roda em `tokio::spawn` fire-and-forget — nunca bloqueia a resposta.
Dependências
Adicione as dependências abaixo ao seu `Cargo.toml`. O envio usa `reqwest` com timeout de 5s.
[dependencies]
axum = "0.7"
tokio = { version = "1", features = ["full"] }
reqwest = { version = "0.12", features = ["json"] }
serde_json = "1"
uuid = { version = "1", features = ["v4"] }Código do middleware
Salve em `src/immutablelog.rs`. O middleware lê `request_id` e a trilha de headers antes de `next.run(req)`, captura o status na resposta e envia o evento em uma task separada.
// src/immutablelog.rs
use std::collections::HashMap;
use std::sync::Arc;
use std::time::{Duration, Instant};
use axum::{extract::{Request, State}, middleware::Next, response::Response};
use serde_json::json;
use uuid::Uuid;
// Margem de seguranca: o limite real do servidor e 16KB (retorna 413 acima disso).
const MAX_PAYLOAD_BYTES: usize = 12_000;
#[derive(Clone)]
pub struct Config {
pub api_key: String,
pub api_url: String,
pub service: String,
pub env: String,
pub client_tz: String,
pub client_offset_minutes: i32,
pub http: reqwest::Client,
}
impl Config {
pub fn from_env(service: &str) -> Self {
Self {
api_key: std::env::var("IMTBL_API_KEY").unwrap_or_default(),
api_url: std::env::var("IMTBL_URL").unwrap_or_else(|_| "https://api.immutablelog.com".into()),
service: service.to_string(),
env: std::env::var("IMTBL_ENV").unwrap_or_else(|_| "production".into()),
// Timezone do cliente — usado pelo dashboard para exibir os timestamps.
client_tz: "America/Sao_Paulo".to_string(),
client_offset_minutes: -180,
http: reqwest::Client::builder()
.timeout(Duration::from_secs(5))
.build()
.expect("build http client"),
}
}
}
// Marcadores opcionais que um handler anexa na resposta.
#[derive(Clone)]
pub struct EventName(pub String);
#[derive(Clone)]
pub struct Trail(pub String);
// Normaliza o immutable_trail (trim, nao-vazio, max 256, sem ':').
// O servidor responde 400 invalid_immutable_trail se a regra for violada.
fn sanitize_trail(v: &str) -> Option<String> {
let mut s = v.trim().replace(':', "-");
if s.is_empty() { return None; }
if s.chars().count() > 256 { s = s.chars().take(256).collect(); }
Some(s)
}
fn kind_from(status: u16) -> &'static str {
if status >= 400 { "error" }
else if status >= 300 { "info" }
else if status >= 200 { "success" }
else { "info" }
}
// Registre com: middleware::from_fn_with_state(cfg.clone(), audit)
pub async fn audit(State(cfg): State<Arc<Config>>, req: Request, next: Next) -> Response {
let started = Instant::now();
let method = req.method().to_string();
let path = req.uri().path().to_string();
let request_id = req
.headers()
.get("x-request-id")
.and_then(|v| v.to_str().ok())
.map(str::to_string)
.unwrap_or_else(|| Uuid::new_v4().to_string());
let header_trail = req
.headers()
.get("x-imtbl-trail")
.and_then(|v| v.to_str().ok())
.and_then(sanitize_trail);
let res = next.run(req).await;
let status = res.status().as_u16();
// Handler pode anexar EventName/Trail nas extensions da resposta.
let event_name = res.extensions().get::<EventName>().map(|e| e.0.clone());
let route_trail = res.extensions().get::<Trail>().map(|tr| tr.0.clone());
tokio::spawn(emit(
cfg, method, path, status, started.elapsed(),
request_id, event_name, route_trail.or(header_trail),
));
res
}
async fn emit(
cfg: Arc<Config>, method: String, path: String, status: u16, elapsed: Duration,
request_id: String, event_name: Option<String>, trail: Option<String>,
) {
if cfg.api_key.is_empty() { return; }
let kind = kind_from(status);
let event_name = event_name.unwrap_or_else(|| format!("http.{}.{}", method, path));
let trail = trail.and_then(|t| sanitize_trail(&t));
let mut payload = json!({
"id": Uuid::new_v4().to_string(),
"kind": kind,
"message": format!("{} {} -> {}", method, path, status),
"request": { "request_id": request_id, "method": method, "path": path },
"metrics": { "latency_ms": elapsed.as_millis() as u64, "status_code": status },
"severity": if kind == "error" { "high" } else { "low" },
});
if kind == "error" {
payload["error"] = json!({
"status_code": status,
"retryable": [408, 429, 500, 502, 503, 504].contains(&status),
});
}
// clamp: remove o campo grande se passar do limite.
let mut payload_str = payload.to_string();
if payload_str.len() > MAX_PAYLOAD_BYTES {
if let Some(obj) = payload.as_object_mut() { obj.remove("error"); }
payload_str = payload.to_string();
}
// Todos os valores de meta precisam ser strings.
let mut meta: HashMap<&str, String> = HashMap::new();
meta.insert("type", kind.to_string());
meta.insert("event_name", event_name.clone());
meta.insert("service", cfg.service.clone());
meta.insert("request_id", request_id.clone());
meta.insert("env", cfg.env.clone());
if let Some(t) = &trail { meta.insert("immutable_trail", t.clone()); }
let event = json!({ "payload": payload_str, "meta": meta });
let mut builder = cfg.http
.post(format!("{}/v1/events", cfg.api_url))
.bearer_auth(&cfg.api_key)
.header("Content-Type", "application/json")
// Idempotency-Key e OBRIGATORIO (sem ele a API responde 400).
.header("Idempotency-Key", format!("{}-{}", event_name, request_id))
.header("Request-Id", &request_id)
.header("X-Client-TZ", &cfg.client_tz)
.header("X-Client-Offset-Minutes", cfg.client_offset_minutes.to_string());
if let Some(t) = &trail { builder = builder.header("X-Imtbl-Trail", t); }
let _ = builder.json(&event).send().await; // fire-and-forget
}Registro e Configuração
Registre o middleware com `from_fn_with_state` aplicando o `Config` compartilhado via `Arc`. Use variáveis de ambiente para as credenciais.
// src/main.rs
use std::sync::Arc;
use axum::{middleware, routing::{get, post}, Router};
mod immutablelog;
use immutablelog::{audit, Config};
#[tokio::main]
async fn main() {
let cfg = Arc::new(Config::from_env("my-axum-service"));
let app = Router::new()
.route("/users", get(|| async { "ok" }))
.route("/payments", post(payments_handler))
// Registre o middleware com o Config compartilhado via Arc.
.layer(middleware::from_fn_with_state(cfg.clone(), audit));
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
axum::serve(listener, app).await.unwrap();
}Nunca coloque o token no código. Carregue IMTBL_API_KEY de variáveis de ambiente (ex: via dotenvy).
Como funciona
from_fn_with_state
Lê request_id e trilha dos headers antes de next.run
next.run(req).await
Executa a cadeia; o status sai na Response
tokio::spawn(emit)
Evento enviado em task separada — não bloqueia a resposta
Evento e trilha customizados
Como o middleware lê a resposta após `next.run`, um handler pode anexar `EventName` e `Trail` nas extensions da resposta. O middleware lê esses marcadores ao emitir o evento.
use axum::{response::{IntoResponse, Response}, Json};
use serde_json::json;
use immutablelog::{EventName, Trail};
async fn payments_handler() -> Response {
let mut res = Json(json!({ "ok": true, "payment_id": "pay_123" })).into_response();
// Sobrescreve o nome do evento e agrupa numa trilha auditavel.
res.extensions_mut().insert(EventName("payment.created".into()));
res.extensions_mut().insert(Trail("order-7782".into()));
res
}Padrão automático: http.METHOD.path.
Trilha imutável (immutable_trail)
A trilha agrupa eventos relacionados em uma mesma linha do tempo auditável. Anexe `Trail(...)` na resposta de um handler, ou propague entre serviços com o header `X-Imtbl-Trail`. O valor passa por `sanitize_trail` antes do envio.
async fn run_flow(/* ... */) -> Response {
let mut res = Json(json!({ "status": "ok" })).into_response();
res.extensions_mut().insert(Trail("flow-123".into()));
res
}A trilha não pode ser vazia, exceder 256 caracteres ou conter `:` — violações retornam `400 invalid_immutable_trail`. O `sanitize_trail` corrige o valor antes do envio.
Resposta e códigos de status
A API de ingestão é assíncrona. Sucesso retorna 202 (novo) ou 200 (duplicata idempotente). Como o middleware é fire-and-forget, esses códigos importam principalmente se você enviar eventos manualmente.
| Status | Significado |
|---|---|
| 202 | Evento aceito e enfileirado (novo) |
| 200 | Idempotency-Key já existente — duplicate: true |
| 400 | Idempotency-Key ausente/vazia ou invalid_immutable_trail |
| 403 | Assinatura inativa/expirada, escopo ou retenção |
| 413 | payload_too_large (limite do servidor: 16KB) |
| 429 | monthly_limit_exceeded — não fazer retry |
| 503 | mempool_full — transitório, pode dar retry |
Esta documentação reflete o comportamento atual da integração. Para dúvidas ou integrações avançadas, entre em contato com o time de suporte.
