feat: add server-sent events for logging and activity tracking
- Implemented a custom tracing layer (`AppLogLayer`) to capture log events and broadcast them to SSE clients. - Created admin routes for streaming server logs and listing recent activity logs. - Added an activity log repository interface and SQLite implementation for persisting activity events. - Integrated activity logging into user authentication and channel CRUD operations. - Developed frontend components for displaying server logs and activity logs in the admin panel. - Enhanced the video player with a stats overlay for monitoring streaming metrics.
This commit is contained in:
@@ -56,6 +56,8 @@ uuid = { version = "1.19.0", features = ["v4", "serde"] }
|
||||
|
||||
# Logging
|
||||
tracing = "0.1"
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt"] }
|
||||
tokio-stream = { version = "0.1", features = ["sync"] }
|
||||
|
||||
reqwest = { version = "0.12", features = ["json"] }
|
||||
handlebars = "6"
|
||||
|
||||
@@ -59,6 +59,32 @@ pub struct ConfigResponse {
|
||||
pub provider_capabilities: domain::ProviderCapabilities,
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Admin DTOs
|
||||
// ============================================================================
|
||||
|
||||
/// An activity log entry returned by GET /admin/activity.
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct ActivityEventResponse {
|
||||
pub id: Uuid,
|
||||
pub timestamp: DateTime<Utc>,
|
||||
pub event_type: String,
|
||||
pub detail: String,
|
||||
pub channel_id: Option<Uuid>,
|
||||
}
|
||||
|
||||
impl From<domain::ActivityEvent> for ActivityEventResponse {
|
||||
fn from(e: domain::ActivityEvent) -> Self {
|
||||
Self {
|
||||
id: e.id,
|
||||
timestamp: e.timestamp,
|
||||
event_type: e.event_type,
|
||||
detail: e.detail,
|
||||
channel_id: e.channel_id,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Channel DTOs
|
||||
// ============================================================================
|
||||
|
||||
72
k-tv-backend/api/src/log_layer.rs
Normal file
72
k-tv-backend/api/src/log_layer.rs
Normal file
@@ -0,0 +1,72 @@
|
||||
//! Custom tracing layer that captures log events and broadcasts them to SSE clients.
|
||||
|
||||
use chrono::Utc;
|
||||
use serde::Serialize;
|
||||
use std::collections::VecDeque;
|
||||
use std::sync::{Arc, Mutex};
|
||||
use tokio::sync::broadcast;
|
||||
use tracing::Event;
|
||||
use tracing_subscriber::Layer;
|
||||
|
||||
/// A single structured log line sent to SSE clients.
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct LogLine {
|
||||
pub level: String,
|
||||
pub target: String,
|
||||
pub message: String,
|
||||
pub timestamp: String,
|
||||
}
|
||||
|
||||
/// Tracing layer that fans log events out to a broadcast channel + ring buffer.
|
||||
pub struct AppLogLayer {
|
||||
tx: broadcast::Sender<LogLine>,
|
||||
history: Arc<Mutex<VecDeque<LogLine>>>,
|
||||
}
|
||||
|
||||
impl AppLogLayer {
|
||||
pub fn new(
|
||||
tx: broadcast::Sender<LogLine>,
|
||||
history: Arc<Mutex<VecDeque<LogLine>>>,
|
||||
) -> Self {
|
||||
Self { tx, history }
|
||||
}
|
||||
}
|
||||
|
||||
impl<S: tracing::Subscriber> Layer<S> for AppLogLayer {
|
||||
fn on_event(&self, event: &Event<'_>, _ctx: tracing_subscriber::layer::Context<'_, S>) {
|
||||
let mut visitor = MsgVisitor(String::new());
|
||||
event.record(&mut visitor);
|
||||
|
||||
let line = LogLine {
|
||||
level: event.metadata().level().to_string(),
|
||||
target: event.metadata().target().to_string(),
|
||||
message: visitor.0,
|
||||
timestamp: Utc::now().to_rfc3339(),
|
||||
};
|
||||
|
||||
if let Ok(mut history) = self.history.lock() {
|
||||
if history.len() >= 200 {
|
||||
history.pop_front();
|
||||
}
|
||||
history.push_back(line.clone());
|
||||
}
|
||||
|
||||
let _ = self.tx.send(line);
|
||||
}
|
||||
}
|
||||
|
||||
struct MsgVisitor(String);
|
||||
|
||||
impl tracing::field::Visit for MsgVisitor {
|
||||
fn record_str(&mut self, field: &tracing::field::Field, value: &str) {
|
||||
if field.name() == "message" {
|
||||
self.0 = value.to_owned();
|
||||
}
|
||||
}
|
||||
|
||||
fn record_debug(&mut self, field: &tracing::field::Field, value: &dyn std::fmt::Debug) {
|
||||
if field.name() == "message" {
|
||||
self.0 = format!("{value:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2,27 +2,30 @@
|
||||
//!
|
||||
//! Configures and starts the HTTP server with JWT-based authentication.
|
||||
|
||||
use std::collections::VecDeque;
|
||||
use std::net::SocketAddr;
|
||||
use std::sync::{Arc, Mutex};
|
||||
use std::time::Duration as StdDuration;
|
||||
|
||||
use axum::Router;
|
||||
use axum::http::{HeaderName, HeaderValue};
|
||||
use std::sync::Arc;
|
||||
use tokio::sync::broadcast;
|
||||
use tower_http::cors::{AllowHeaders, AllowMethods, AllowOrigin, CorsLayer};
|
||||
use tracing::info;
|
||||
use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};
|
||||
|
||||
use domain::{ChannelService, IMediaProvider, IProviderRegistry, ProviderCapabilities, ScheduleEngineService, StreamingProtocol, UserService};
|
||||
use infra::factory::{build_channel_repository, build_schedule_repository, build_user_repository};
|
||||
use infra::factory::{build_activity_log_repository, build_channel_repository, build_schedule_repository, build_user_repository};
|
||||
use infra::run_migrations;
|
||||
use k_core::http::server::{ServerConfig, apply_standard_middleware};
|
||||
use k_core::logging;
|
||||
use tokio::net::TcpListener;
|
||||
use tracing::info;
|
||||
|
||||
mod config;
|
||||
mod dto;
|
||||
mod error;
|
||||
mod events;
|
||||
mod extractors;
|
||||
mod log_layer;
|
||||
mod poller;
|
||||
mod routes;
|
||||
mod scheduler;
|
||||
@@ -34,7 +37,16 @@ use crate::state::AppState;
|
||||
|
||||
#[tokio::main]
|
||||
async fn main() -> anyhow::Result<()> {
|
||||
logging::init("api");
|
||||
// Set up broadcast channel + ring buffer for SSE log streaming.
|
||||
let (log_tx, _) = broadcast::channel::<log_layer::LogLine>(512);
|
||||
let log_history = Arc::new(Mutex::new(VecDeque::<log_layer::LogLine>::new()));
|
||||
|
||||
// Initialize tracing with our custom layer in addition to the fmt layer.
|
||||
tracing_subscriber::registry()
|
||||
.with(EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info")))
|
||||
.with(fmt::layer())
|
||||
.with(log_layer::AppLogLayer::new(log_tx.clone(), Arc::clone(&log_history)))
|
||||
.init();
|
||||
|
||||
let config = Config::from_env();
|
||||
|
||||
@@ -71,6 +83,7 @@ async fn main() -> anyhow::Result<()> {
|
||||
let user_repo = build_user_repository(&db_pool).await?;
|
||||
let channel_repo = build_channel_repository(&db_pool).await?;
|
||||
let schedule_repo = build_schedule_repository(&db_pool).await?;
|
||||
let activity_log_repo = build_activity_log_repository(&db_pool).await?;
|
||||
|
||||
let user_service = UserService::new(user_repo);
|
||||
let channel_service = ChannelService::new(channel_repo.clone());
|
||||
@@ -177,6 +190,9 @@ async fn main() -> anyhow::Result<()> {
|
||||
registry,
|
||||
config.clone(),
|
||||
event_tx.clone(),
|
||||
log_tx,
|
||||
log_history,
|
||||
activity_log_repo,
|
||||
)
|
||||
.await?;
|
||||
|
||||
|
||||
95
k-tv-backend/api/src/routes/admin.rs
Normal file
95
k-tv-backend/api/src/routes/admin.rs
Normal file
@@ -0,0 +1,95 @@
|
||||
//! Admin routes: SSE log stream + activity log.
|
||||
|
||||
use axum::{
|
||||
Json,
|
||||
extract::State,
|
||||
response::{
|
||||
IntoResponse,
|
||||
sse::{Event, KeepAlive, Sse},
|
||||
},
|
||||
};
|
||||
use tokio_stream::{StreamExt, wrappers::BroadcastStream};
|
||||
|
||||
use crate::{
|
||||
dto::ActivityEventResponse,
|
||||
error::ApiError,
|
||||
extractors::OptionalCurrentUser,
|
||||
state::AppState,
|
||||
};
|
||||
|
||||
use axum::Router;
|
||||
use axum::routing::get;
|
||||
|
||||
pub fn router() -> Router<AppState> {
|
||||
Router::new()
|
||||
.route("/logs", get(stream_logs))
|
||||
.route("/activity", get(list_activity))
|
||||
}
|
||||
|
||||
/// Stream server log lines as Server-Sent Events.
|
||||
///
|
||||
/// Auth: requires a valid JWT passed as `?token=<jwt>` (EventSource cannot set headers).
|
||||
/// On connect: flushes the recent history ring buffer, then streams live events.
|
||||
pub async fn stream_logs(
|
||||
State(state): State<AppState>,
|
||||
OptionalCurrentUser(user): OptionalCurrentUser,
|
||||
) -> Result<impl IntoResponse, ApiError> {
|
||||
if user.is_none() {
|
||||
return Err(ApiError::Unauthorized(
|
||||
"Authentication required for log stream".to_string(),
|
||||
));
|
||||
}
|
||||
|
||||
// Snapshot history and subscribe before releasing the lock so we don't miss events.
|
||||
let rx = state.log_tx.subscribe();
|
||||
let history: Vec<_> = state
|
||||
.log_history
|
||||
.lock()
|
||||
.map(|h| h.iter().cloned().collect())
|
||||
.unwrap_or_default();
|
||||
|
||||
let history_stream = tokio_stream::iter(history).map(|line| {
|
||||
let data = serde_json::to_string(&line).unwrap_or_default();
|
||||
Ok::<Event, String>(Event::default().data(data))
|
||||
});
|
||||
|
||||
let live_stream = BroadcastStream::new(rx).filter_map(|result| match result {
|
||||
Ok(line) => {
|
||||
let data = serde_json::to_string(&line).unwrap_or_default();
|
||||
Some(Ok::<Event, String>(Event::default().data(data)))
|
||||
}
|
||||
Err(tokio_stream::wrappers::errors::BroadcastStreamRecvError::Lagged(n)) => {
|
||||
let data = format!(
|
||||
r#"{{"level":"WARN","target":"sse","message":"[{n} log lines dropped — buffer overrun]","timestamp":""}}"#
|
||||
);
|
||||
Some(Ok(Event::default().data(data)))
|
||||
}
|
||||
});
|
||||
|
||||
let combined = history_stream.chain(live_stream);
|
||||
|
||||
Ok(Sse::new(combined).keep_alive(KeepAlive::default()))
|
||||
}
|
||||
|
||||
/// Return recent activity log entries.
|
||||
///
|
||||
/// Auth: requires a valid JWT (Authorization: Bearer or ?token=).
|
||||
pub async fn list_activity(
|
||||
State(state): State<AppState>,
|
||||
OptionalCurrentUser(user): OptionalCurrentUser,
|
||||
) -> Result<impl IntoResponse, ApiError> {
|
||||
if user.is_none() {
|
||||
return Err(ApiError::Unauthorized(
|
||||
"Authentication required".to_string(),
|
||||
));
|
||||
}
|
||||
|
||||
let events = state
|
||||
.activity_log_repo
|
||||
.recent(50)
|
||||
.await
|
||||
.map_err(ApiError::from)?;
|
||||
|
||||
let response: Vec<ActivityEventResponse> = events.into_iter().map(Into::into).collect();
|
||||
Ok(Json(response))
|
||||
}
|
||||
@@ -35,6 +35,7 @@ pub(super) async fn login(
|
||||
}
|
||||
|
||||
let token = create_jwt(&user, &state)?;
|
||||
let _ = state.activity_log_repo.log("user_login", user.email.as_ref(), None).await;
|
||||
|
||||
Ok((
|
||||
StatusCode::OK,
|
||||
|
||||
@@ -69,6 +69,7 @@ pub(super) async fn create_channel(
|
||||
}
|
||||
|
||||
let _ = state.event_tx.send(domain::DomainEvent::ChannelCreated { channel: channel.clone() });
|
||||
let _ = state.activity_log_repo.log("channel_created", &channel.name, Some(channel.id)).await;
|
||||
Ok((StatusCode::CREATED, Json(ChannelResponse::from(channel))))
|
||||
}
|
||||
|
||||
@@ -144,6 +145,7 @@ pub(super) async fn update_channel(
|
||||
|
||||
let channel = state.channel_service.update(channel).await?;
|
||||
let _ = state.event_tx.send(domain::DomainEvent::ChannelUpdated { channel: channel.clone() });
|
||||
let _ = state.activity_log_repo.log("channel_updated", &channel.name, Some(channel.id)).await;
|
||||
Ok(Json(ChannelResponse::from(channel)))
|
||||
}
|
||||
|
||||
@@ -155,5 +157,6 @@ pub(super) async fn delete_channel(
|
||||
// ChannelService::delete enforces ownership internally
|
||||
state.channel_service.delete(channel_id, user.id).await?;
|
||||
let _ = state.event_tx.send(domain::DomainEvent::ChannelDeleted { channel_id });
|
||||
let _ = state.activity_log_repo.log("channel_deleted", &channel_id.to_string(), Some(channel_id)).await;
|
||||
Ok(StatusCode::NO_CONTENT)
|
||||
}
|
||||
|
||||
@@ -37,6 +37,8 @@ pub(super) async fn generate_schedule(
|
||||
channel_id,
|
||||
schedule: schedule.clone(),
|
||||
});
|
||||
let detail = format!("{} slots", schedule.slots.len());
|
||||
let _ = state.activity_log_repo.log("schedule_generated", &detail, Some(channel_id)).await;
|
||||
Ok((StatusCode::CREATED, Json(ScheduleResponse::from(schedule))))
|
||||
}
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
use crate::state::AppState;
|
||||
use axum::Router;
|
||||
|
||||
pub mod admin;
|
||||
pub mod auth;
|
||||
pub mod channels;
|
||||
pub mod config;
|
||||
@@ -15,6 +16,7 @@ pub mod library;
|
||||
/// Construct the API v1 router
|
||||
pub fn api_v1_router() -> Router<AppState> {
|
||||
Router::new()
|
||||
.nest("/admin", admin::router())
|
||||
.nest("/auth", auth::router())
|
||||
.nest("/channels", channels::router())
|
||||
.nest("/config", config::router())
|
||||
|
||||
@@ -8,11 +8,14 @@ use axum_extra::extract::cookie::Key;
|
||||
use infra::auth::jwt::{JwtConfig, JwtValidator};
|
||||
#[cfg(feature = "auth-oidc")]
|
||||
use infra::auth::oidc::OidcService;
|
||||
use std::sync::Arc;
|
||||
use std::collections::VecDeque;
|
||||
use std::sync::{Arc, Mutex};
|
||||
use tokio::sync::broadcast;
|
||||
|
||||
use crate::config::Config;
|
||||
use crate::events::EventBus;
|
||||
use domain::{ChannelService, ScheduleEngineService, UserService};
|
||||
use crate::log_layer::LogLine;
|
||||
use domain::{ActivityLogRepository, ChannelService, ScheduleEngineService, UserService};
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct AppState {
|
||||
@@ -27,6 +30,12 @@ pub struct AppState {
|
||||
pub jwt_validator: Option<Arc<JwtValidator>>,
|
||||
pub config: Arc<Config>,
|
||||
pub event_tx: EventBus,
|
||||
/// Broadcast channel for streaming log lines to SSE clients.
|
||||
pub log_tx: broadcast::Sender<LogLine>,
|
||||
/// Ring buffer of recent log lines sent to new SSE clients on connect.
|
||||
pub log_history: Arc<Mutex<VecDeque<LogLine>>>,
|
||||
/// Repository for persisted in-app activity events.
|
||||
pub activity_log_repo: Arc<dyn ActivityLogRepository>,
|
||||
/// Index for the local-files provider, used by the rescan route.
|
||||
#[cfg(feature = "local-files")]
|
||||
pub local_index: Option<Arc<infra::LocalIndex>>,
|
||||
@@ -46,6 +55,9 @@ impl AppState {
|
||||
provider_registry: Arc<infra::ProviderRegistry>,
|
||||
config: Config,
|
||||
event_tx: EventBus,
|
||||
log_tx: broadcast::Sender<LogLine>,
|
||||
log_history: Arc<Mutex<VecDeque<LogLine>>>,
|
||||
activity_log_repo: Arc<dyn ActivityLogRepository>,
|
||||
) -> anyhow::Result<Self> {
|
||||
let cookie_key = Key::derive_from(config.cookie_secret.as_bytes());
|
||||
|
||||
@@ -118,6 +130,9 @@ impl AppState {
|
||||
jwt_validator,
|
||||
config: Arc::new(config),
|
||||
event_tx,
|
||||
log_tx,
|
||||
log_history,
|
||||
activity_log_repo,
|
||||
#[cfg(feature = "local-files")]
|
||||
local_index: None,
|
||||
#[cfg(feature = "local-files")]
|
||||
|
||||
Reference in New Issue
Block a user