split out log-ingest modules to their own crate

This commit is contained in:
Chris Beck
2025-12-13 21:40:30 -07:00
parent 2ecc614bb5
commit 2682ee8ee6
10 changed files with 49 additions and 13 deletions
@@ -0,0 +1,230 @@
//! Relaxed JSON Lines reader that allows newlines within JSON objects.
//!
//! Standard JSON Lines requires each JSON value to be on a single line.
//! This implementation relaxes that by tracking brace/bracket depth and
//! only treating newlines as delimiters when outside of JSON structures.
use tokio::io::{AsyncRead, AsyncReadExt, BufReader};
/// Read a single JSON value from a relaxed JSON Lines stream.
///
/// Returns:
/// - `Ok(Some(bytes))` - A complete JSON value was read
/// - `Ok(None)` - EOF reached (no more values)
/// - `Err(InvalidData)` - Malformed JSON structure (imbalanced braces/brackets)
/// - `Err(other)` - I/O error
///
/// This parser tracks brace and bracket depth to allow newlines within
/// JSON objects and arrays. A newline only ends the value when we're at
/// depth 0 (outside any object or array).
pub async fn read_json_lines_value<R>(reader: &mut BufReader<R>) -> std::io::Result<Option<Vec<u8>>>
where
R: AsyncRead + Unpin,
{
let mut buf = Vec::<u8>::with_capacity(256);
let mut brace_depth = 0usize;
let mut bracket_depth = 0usize;
let mut quoted = false;
let mut escaped = false;
loop {
let b = match reader.read_u8().await {
Ok(b) => b,
Err(e) if e.kind() == std::io::ErrorKind::UnexpectedEof => {
// EOF - return what we have if anything
if buf.is_empty() {
return Ok(None);
}
break;
}
Err(e) => return Err(e),
};
if escaped {
escaped = false;
buf.push(b);
continue;
}
if quoted {
if b == b'\\' {
escaped = true;
} else if b == b'"' {
quoted = false;
}
buf.push(b);
continue;
}
// Not escaped, not quoted
match b {
b'"' => {
quoted = true;
buf.push(b);
}
b'{' => {
brace_depth += 1;
buf.push(b);
}
b'[' => {
bracket_depth += 1;
buf.push(b);
}
b'}' => {
if brace_depth == 0 {
let rendered_buf = String::from_utf8_lossy(&buf);
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
format!("imbalanced braces: {rendered_buf}}}"),
));
}
brace_depth -= 1;
buf.push(b);
}
b']' => {
if bracket_depth == 0 {
let rendered_buf = String::from_utf8_lossy(&buf);
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
format!("imbalanced brackets: {rendered_buf}]"),
));
}
bracket_depth -= 1;
buf.push(b);
}
b'\n' => {
if brace_depth == 0 && bracket_depth == 0 {
// Clean line break at depth 0 - end of value
if buf.is_empty() {
// Skip empty lines
continue;
}
break;
}
// Newline inside object/array - keep it
buf.push(b);
}
_ => {
buf.push(b);
}
}
}
Ok(Some(buf))
}
#[cfg(test)]
mod tests {
use super::*;
#[tokio::test]
async fn test_simple_json_object() {
let data: &[u8] = b"{\"msg\": \"hello\"}\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"{\"msg\": \"hello\"}".to_vec()));
}
#[tokio::test]
async fn test_json_with_internal_newlines() {
let data: &[u8] = b"{\n \"msg\": \"hello\",\n \"level\": \"info\"\n}\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(
result,
Some(b"{\n \"msg\": \"hello\",\n \"level\": \"info\"\n}".to_vec())
);
}
#[tokio::test]
async fn test_eof_returns_none() {
let data: &[u8] = b"";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, None);
}
#[tokio::test]
async fn test_eof_returns_partial_buffer() {
// No trailing newline
let data: &[u8] = b"{\"msg\": \"hello\"}";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"{\"msg\": \"hello\"}".to_vec()));
}
#[tokio::test]
async fn test_multiple_values() {
let data: &[u8] = b"{\"a\": 1}\n{\"b\": 2}\n";
let mut reader = BufReader::new(data);
let r1 = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(r1, Some(b"{\"a\": 1}".to_vec()));
let r2 = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(r2, Some(b"{\"b\": 2}".to_vec()));
let r3 = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(r3, None);
}
#[tokio::test]
async fn test_skips_empty_lines() {
let data: &[u8] = b"\n\n{\"msg\": \"hello\"}\n\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"{\"msg\": \"hello\"}".to_vec()));
}
#[tokio::test]
async fn test_nested_braces() {
let data: &[u8] = b"{\"nested\": {\"deep\": {}}}\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"{\"nested\": {\"deep\": {}}}".to_vec()));
}
#[tokio::test]
async fn test_array_value() {
let data: &[u8] = b"[1, 2, 3]\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"[1, 2, 3]".to_vec()));
}
#[tokio::test]
async fn test_string_with_escaped_quote() {
let data: &[u8] = b"{\"msg\": \"hello \\\"world\\\"\"}\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"{\"msg\": \"hello \\\"world\\\"\"}".to_vec()));
}
#[tokio::test]
async fn test_string_with_newline() {
// Newline inside a string should be preserved (though this is technically invalid JSON)
let data: &[u8] = b"{\"msg\": \"line1\nline2\"}\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await.unwrap();
assert_eq!(result, Some(b"{\"msg\": \"line1\nline2\"}".to_vec()));
}
#[tokio::test]
async fn test_imbalanced_brace_error() {
let data: &[u8] = b"{\"msg\": \"hello\"}}\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
#[tokio::test]
async fn test_imbalanced_bracket_error() {
let data: &[u8] = b"[1, 2]]\n";
let mut reader = BufReader::new(data);
let result = read_json_lines_value(&mut reader).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
}
+668
View File
@@ -0,0 +1,668 @@
//! JSON listener for receiving log messages in a logstash-compatible format.
//!
//! This module accepts JSON log messages over UDP and TCP, converting them to LogMessage.
//! It's designed to be flexible and accept various common formats.
//!
//! TCP connections use a relaxed JSON Lines format that allows newlines within
//! JSON objects (standard JSON Lines requires each value on a single line).
use chrono::{DateTime, TimeZone, Utc};
use conf::Conf;
use serde::Deserialize;
use signal_gateway::{Gateway, Level, LogMessage};
use std::{net::SocketAddr, sync::Arc};
use tokio::{
io::BufReader,
net::{TcpListener, TcpStream, UdpSocket},
};
use tracing::{error, info, trace};
mod json_lines;
use json_lines::read_json_lines_value;
/// Configuration for the JSON log message listener.
///
/// Listens for JSON log messages on both UDP and TCP using the same address.
///
/// See [`JsonLogMessage`] for the JSON schema.
#[derive(Clone, Conf, Debug)]
#[conf(serde)]
pub struct JsonConfig {
/// Socket address to listen for JSON log messages.
/// Both UDP and TCP listeners are started on this address.
///
/// - **UDP**: Each datagram should contain a single JSON object.
/// - **TCP**: Uses a relaxed JSON Lines format where each JSON object is
/// separated by newlines.
///
/// See [`JsonLogMessage`] for the JSON schema. It is roughly compatible
/// with logstash, graylog, etc.
///
/// * "message", "Message", "msg" for the log mesage string itself
/// * "timestamp", "@timestamp", "time" for the timestamp, which can be a numeric unix typestamp,
/// or a string in RFC3339 form
/// * "level", "severity" for the log level string
/// * "host" or "hostname" for the originating host
/// * "app" or "appname" or "application" or "service" for the originating program
/// * "file" or "filename" or "source_file" for the source file that wrote the log line
/// * "line" or "lineno" for the source file line number that wrote the log line
/// * "module" or "module_path" or "logger" or "logger_name" for the source module that wrote the log line
#[conf(long, env)]
pub listen_addr: SocketAddr,
}
impl JsonConfig {
/// Bind UDP and TCP sockets and start background tasks to handle incoming JSON log messages.
///
/// Returns join handles for the background tasks.
pub async fn start_tasks(
&self,
gateway: Arc<Gateway>,
) -> std::io::Result<(tokio::task::JoinHandle<()>, tokio::task::JoinHandle<()>)> {
let udp_handle = self.start_udp_task(gateway.clone()).await?;
let tcp_handle = self.start_tcp_task(gateway).await?;
Ok((udp_handle, tcp_handle))
}
async fn start_udp_task(
&self,
gateway: Arc<Gateway>,
) -> std::io::Result<tokio::task::JoinHandle<()>> {
let udp_socket = UdpSocket::bind(self.listen_addr).await?;
info!("Listening for JSON UDP on {}", self.listen_addr);
Ok(tokio::task::spawn(async move {
let mut buf = vec![0u8; 8192];
loop {
let Ok((len, _addr)) = udp_socket
.recv_from(&mut buf)
.await
.inspect_err(|err| error!("Error receiving UDP packet: {err}"))
else {
continue;
};
let Ok(text) = std::str::from_utf8(&buf[0..len])
.inspect_err(|err| error!("UDP packet was not utf8: {err}"))
else {
continue;
};
let Ok(json_msg) = serde_json::from_str::<JsonLogMessage>(text)
.inspect_err(|err| error!("UDP packet was not valid JSON: {err}:\n{text}"))
else {
continue;
};
let log_msg = json_msg.into_log_message();
gateway.handle_log_message(log_msg).await;
}
}))
}
async fn start_tcp_task(
&self,
gateway: Arc<Gateway>,
) -> std::io::Result<tokio::task::JoinHandle<()>> {
let tcp_listener = TcpListener::bind(self.listen_addr).await?;
info!("Listening for JSON TCP on {}", self.listen_addr);
Ok(tokio::task::spawn(async move {
loop {
let Ok((stream, addr)) = tcp_listener
.accept()
.await
.inspect_err(|err| error!("Error accepting JSON TCP connection: {err}"))
else {
continue;
};
trace!("Accepted JSON TCP connection from {addr}");
let gateway = gateway.clone();
// Spawn a task for each connection
tokio::spawn(async move {
if let Err(err) = handle_tcp_connection(stream, &gateway).await {
error!("JSON TCP connection from {addr} error: {err}");
} else {
trace!("JSON TCP connection from {addr} closed");
}
});
}
}))
}
}
/// Handle a single TCP connection using relaxed JSON Lines framing.
async fn handle_tcp_connection(stream: TcpStream, gateway: &Gateway) -> std::io::Result<()> {
let mut reader = BufReader::new(stream);
loop {
let Some(msg_bytes) = read_json_lines_value(&mut reader).await? else {
return Ok(()); // Clean EOF
};
let text = std::str::from_utf8(&msg_bytes)
.map_err(|err| std::io::Error::new(std::io::ErrorKind::InvalidData, err))?;
let json_msg: JsonLogMessage = serde_json::from_str(text)
.map_err(|err| std::io::Error::new(std::io::ErrorKind::InvalidData, err))?;
let log_msg = json_msg.into_log_message();
gateway.handle_log_message(log_msg).await;
}
}
/// A flexible JSON log message format compatible with logstash and similar systems.
///
/// Supports various field names and formats commonly used in logging systems.
#[non_exhaustive]
#[derive(Debug, Deserialize)]
pub struct JsonLogMessage {
/// The log message text - accepts "message" or "msg"
#[serde(alias = "msg")]
pub message: String,
/// Log level - accepts various formats (error, ERROR, err, etc.)
#[serde(
default,
alias = "severity",
deserialize_with = "deserialize_opt_level"
)]
pub level: Option<Level>,
/// Timestamp - accepts Unix epoch seconds (int or string) or RFC3339 string
#[serde(
default,
alias = "time",
alias = "@timestamp",
deserialize_with = "deserialize_timestamp"
)]
pub timestamp: Option<DateTime<Utc>>,
/// Hostname
#[serde(alias = "host")]
pub hostname: Option<String>,
/// Application name
#[serde(alias = "app", alias = "application", alias = "service")]
pub appname: Option<String>,
/// Module path
#[serde(alias = "module", alias = "logger", alias = "logger_name")]
pub module_path: Option<String>,
/// Source file
#[serde(alias = "filename", alias = "source_file")]
pub file: Option<String>,
/// Line number - accepts integer or string
#[serde(default, alias = "lineno", deserialize_with = "deserialize_line")]
pub line: Option<String>,
}
impl JsonLogMessage {
/// Convert to a LogMessage
///
/// TODO: Allow this to take configuration options to customize how fields are mapped
pub fn into_log_message(self) -> LogMessage {
let level = self.level.unwrap_or(Level::ERROR);
let mut builder = LogMessage::builder(level, self.message);
if let Some(ts) = self.timestamp {
builder = builder.timestamp(ts.timestamp());
builder = builder.timestamp_nanos(ts.timestamp_subsec_nanos());
}
if let Some(hostname) = self.hostname {
builder = builder.hostname(hostname);
}
if let Some(appname) = self.appname {
builder = builder.appname(appname);
}
if let Some(module_path) = self.module_path {
builder = builder.module_path(module_path);
}
if let Some(file) = self.file {
builder = builder.file(file);
}
if let Some(line) = self.line {
builder = builder.line(line);
}
builder.build()
}
}
/// Deserialize an optional log level, returning None for unknown values.
fn deserialize_opt_level<'de, D>(deserializer: D) -> Result<Option<Level>, D::Error>
where
D: serde::Deserializer<'de>,
{
let opt: Option<String> = Option::deserialize(deserializer)?;
Ok(opt.and_then(|s| Level::parse(&s)))
}
/// Deserialize a timestamp from Unix epoch (int or string) or RFC3339 string
fn deserialize_timestamp<'de, D>(deserializer: D) -> Result<Option<DateTime<Utc>>, D::Error>
where
D: serde::Deserializer<'de>,
{
use serde::de::Error;
#[derive(Deserialize)]
#[serde(untagged)]
enum TimestampValue {
Integer(i64),
Float(f64),
String(String),
}
let opt: Option<TimestampValue> = Option::deserialize(deserializer)?;
match opt {
None => Ok(None),
Some(TimestampValue::Integer(secs)) => Ok(Utc.timestamp_opt(secs, 0).single()),
Some(TimestampValue::Float(secs)) => {
let whole_secs = secs.trunc() as i64;
let nanos = ((secs.fract()) * 1_000_000_000.0) as u32;
Ok(Utc.timestamp_opt(whole_secs, nanos).single())
}
Some(TimestampValue::String(s)) => {
// Try parsing as integer first (Unix timestamp as string)
if let Ok(secs) = s.parse::<i64>() {
return Ok(Utc.timestamp_opt(secs, 0).single());
}
// Try parsing as float (Unix timestamp with fractional seconds)
if let Ok(secs) = s.parse::<f64>() {
let whole_secs = secs.trunc() as i64;
let nanos = ((secs.fract()) * 1_000_000_000.0) as u32;
return Ok(Utc.timestamp_opt(whole_secs, nanos).single());
}
// Try parsing as RFC3339
DateTime::parse_from_rfc3339(&s)
.map(|dt| Some(dt.with_timezone(&Utc)))
.map_err(|e| D::Error::custom(format!("invalid timestamp: {e}")))
}
}
}
/// Deserialize a line number from integer or string
fn deserialize_line<'de, D>(deserializer: D) -> Result<Option<String>, D::Error>
where
D: serde::Deserializer<'de>,
{
#[derive(Deserialize)]
#[serde(untagged)]
enum LineValue {
Integer(u64),
String(String),
}
let opt: Option<LineValue> = Option::deserialize(deserializer)?;
Ok(match opt {
None => None,
Some(LineValue::Integer(n)) => Some(n.to_string()),
Some(LineValue::String(s)) => Some(s),
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_basic_message_with_message_field() {
let json = r#"{"message": "Hello, world!"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.message, "Hello, world!");
let log_msg = msg.into_log_message();
assert_eq!(&*log_msg.msg, "Hello, world!");
assert_eq!(log_msg.level, Level::ERROR); // default
}
#[test]
fn test_basic_message_with_msg_field() {
let json = r#"{"msg": "Hello from msg!"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.message, "Hello from msg!");
}
#[test]
fn test_level_variations() {
// Lowercase
let json = r#"{"message": "test", "level": "error"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::ERROR));
// Uppercase
let json = r#"{"message": "test", "level": "ERROR"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::ERROR));
// Short form
let json = r#"{"message": "test", "level": "err"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::ERROR));
// Warning variations
let json = r#"{"message": "test", "level": "warn"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::WARNING));
let json = r#"{"message": "test", "level": "warning"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::WARNING));
// Fatal -> Critical
let json = r#"{"message": "test", "level": "fatal"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::CRITICAL));
// Severity alias
let json = r#"{"message": "test", "severity": "error"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, Some(Level::ERROR));
}
#[test]
fn test_timestamp_as_integer() {
let json = r#"{"message": "test", "timestamp": 1733500000}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let ts = msg.timestamp.unwrap();
assert_eq!(ts.timestamp(), 1733500000);
}
#[test]
fn test_timestamp_as_float() {
let json = r#"{"message": "test", "timestamp": 1733500000.123456}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let ts = msg.timestamp.unwrap();
assert_eq!(ts.timestamp(), 1733500000);
assert!(ts.timestamp_subsec_nanos() > 123000000);
assert!(ts.timestamp_subsec_nanos() < 124000000);
}
#[test]
fn test_timestamp_as_string_integer() {
let json = r#"{"message": "test", "timestamp": "1733500000"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let ts = msg.timestamp.unwrap();
assert_eq!(ts.timestamp(), 1733500000);
}
#[test]
fn test_timestamp_as_rfc3339() {
let json = r#"{"message": "test", "timestamp": "2024-12-06T12:00:00Z"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let ts = msg.timestamp.unwrap();
assert_eq!(ts.timestamp(), 1733486400);
}
#[test]
fn test_timestamp_as_rfc3339_with_offset() {
let json = r#"{"message": "test", "timestamp": "2024-12-06T12:00:00+05:30"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let ts = msg.timestamp.unwrap();
// 12:00 +05:30 = 06:30 UTC
assert_eq!(ts.timestamp(), 1733486400 - 5 * 3600 - 30 * 60);
}
#[test]
fn test_timestamp_aliases() {
// @timestamp (logstash style)
let json = r#"{"message": "test", "@timestamp": "2024-12-06T12:00:00Z"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert!(msg.timestamp.is_some());
// time
let json = r#"{"message": "test", "time": 1733500000}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert!(msg.timestamp.is_some());
}
#[test]
fn test_line_as_integer() {
let json = r#"{"message": "test", "line": 42}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.line, Some("42".to_string()));
}
#[test]
fn test_line_as_string() {
let json = r#"{"message": "test", "line": "42"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.line, Some("42".to_string()));
}
#[test]
fn test_line_aliases() {
let json = r#"{"message": "test", "lineno": 123}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.line, Some("123".to_string()));
}
#[test]
fn test_hostname_aliases() {
let json = r#"{"message": "test", "host": "myserver"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.hostname, Some("myserver".to_string()));
let json = r#"{"message": "test", "hostname": "myserver2"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.hostname, Some("myserver2".to_string()));
}
#[test]
fn test_appname_aliases() {
let json = r#"{"message": "test", "app": "myapp"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.appname, Some("myapp".to_string()));
let json = r#"{"message": "test", "application": "myapp2"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.appname, Some("myapp2".to_string()));
let json = r#"{"message": "test", "service": "myservice"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.appname, Some("myservice".to_string()));
}
#[test]
fn test_module_path_aliases() {
let json = r#"{"message": "test", "module": "mymodule"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.module_path, Some("mymodule".to_string()));
let json = r#"{"message": "test", "logger": "mylogger"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.module_path, Some("mylogger".to_string()));
let json = r#"{"message": "test", "logger_name": "com.example.MyClass"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.module_path, Some("com.example.MyClass".to_string()));
}
#[test]
fn test_file_aliases() {
let json = r#"{"message": "test", "file": "main.rs"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.file, Some("main.rs".to_string()));
let json = r#"{"message": "test", "filename": "app.py"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.file, Some("app.py".to_string()));
let json = r#"{"message": "test", "source_file": "Handler.java"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.file, Some("Handler.java".to_string()));
}
#[test]
fn test_full_logstash_style_message() {
let json = r#"{
"@timestamp": "2024-12-06T12:00:00Z",
"message": "User logged in",
"level": "info",
"host": "web-01",
"service": "auth-service",
"logger_name": "com.example.auth.LoginHandler",
"filename": "LoginHandler.java",
"lineno": 123
}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let log_msg = msg.into_log_message();
assert_eq!(&*log_msg.msg, "User logged in");
assert_eq!(log_msg.level, Level::INFO);
assert_eq!(log_msg.hostname.as_deref(), Some("web-01"));
assert_eq!(log_msg.appname.as_deref(), Some("auth-service"));
assert_eq!(
log_msg.module_path.as_deref(),
Some("com.example.auth.LoginHandler")
);
assert_eq!(log_msg.file.as_deref(), Some("LoginHandler.java"));
assert_eq!(log_msg.line.as_deref(), Some("123"));
assert!(log_msg.timestamp.is_some());
}
#[test]
fn test_minimal_message() {
let json = r#"{"msg": "simple log"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
let log_msg = msg.into_log_message();
assert_eq!(&*log_msg.msg, "simple log");
assert_eq!(log_msg.level, Level::ERROR);
assert!(log_msg.hostname.is_none());
assert!(log_msg.appname.is_none());
assert!(log_msg.timestamp.is_none());
}
#[test]
fn test_unknown_level_defaults_to_none() {
let json = r#"{"message": "test", "level": "unknown_level"}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.level, None);
// Should default to ERROR when converted
let log_msg = msg.into_log_message();
assert_eq!(log_msg.level, Level::ERROR);
}
#[test]
fn test_extra_fields_are_ignored() {
let json =
r#"{"message": "test", "extra_field": "ignored", "nested": {"also": "ignored"}}"#;
let msg: JsonLogMessage = serde_json::from_str(json).unwrap();
assert_eq!(msg.message, "test");
}
// Tests for TCP stream parsing (read_json_lines_value + JSON parsing)
use tokio::io::AsyncRead;
/// Test helper that mimics handle_tcp_connection's parsing logic
async fn parse_next_message<R: AsyncRead + Unpin>(
reader: &mut BufReader<R>,
) -> std::io::Result<Option<LogMessage>> {
let Some(msg_bytes) = read_json_lines_value(reader).await? else {
return Ok(None);
};
let text = std::str::from_utf8(&msg_bytes)
.map_err(|err| std::io::Error::new(std::io::ErrorKind::InvalidData, err))?;
let json_msg: JsonLogMessage = serde_json::from_str(text)
.map_err(|err| std::io::Error::new(std::io::ErrorKind::InvalidData, err))?;
Ok(Some(json_msg.into_log_message()))
}
#[tokio::test]
async fn test_tcp_valid_message() {
let data: &[u8] = b"{\"message\": \"hello\"}\n";
let mut reader = BufReader::new(data);
let result = parse_next_message(&mut reader).await.unwrap();
assert!(result.is_some());
let msg = result.unwrap();
assert_eq!(&*msg.msg, "hello");
}
#[tokio::test]
async fn test_tcp_multiple_messages() {
let data: &[u8] = b"{\"message\": \"first\"}\n{\"message\": \"second\"}\n";
let mut reader = BufReader::new(data);
let msg1 = parse_next_message(&mut reader).await.unwrap().unwrap();
assert_eq!(&*msg1.msg, "first");
let msg2 = parse_next_message(&mut reader).await.unwrap().unwrap();
assert_eq!(&*msg2.msg, "second");
let msg3 = parse_next_message(&mut reader).await.unwrap();
assert!(msg3.is_none()); // EOF
}
#[tokio::test]
async fn test_tcp_eof_returns_none() {
let data: &[u8] = b"";
let mut reader = BufReader::new(data);
let result = parse_next_message(&mut reader).await.unwrap();
assert!(result.is_none());
}
#[tokio::test]
async fn test_tcp_invalid_utf8_returns_error() {
// Invalid UTF-8 bytes inside a "JSON" structure
let data: &[u8] = b"{\"\xff\xfe\": \"bad\"}\n";
let mut reader = BufReader::new(data);
let result = parse_next_message(&mut reader).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
#[tokio::test]
async fn test_tcp_invalid_json_returns_error() {
let data: &[u8] = b"{not valid json}\n";
let mut reader = BufReader::new(data);
let result = parse_next_message(&mut reader).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
#[tokio::test]
async fn test_tcp_missing_required_field_returns_error() {
// Valid JSON but missing required "message" field
let data: &[u8] = b"{\"level\": \"info\"}\n";
let mut reader = BufReader::new(data);
let result = parse_next_message(&mut reader).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
#[tokio::test]
async fn test_tcp_error_stops_processing() {
// First message valid, second invalid - error should stop further processing
let data: &[u8] = b"{\"message\": \"ok\"}\n{invalid}\n{\"message\": \"never reached\"}\n";
let mut reader = BufReader::new(data);
// First message succeeds
let msg1 = parse_next_message(&mut reader).await.unwrap();
assert!(msg1.is_some());
// Second message fails with error
let result = parse_next_message(&mut reader).await;
assert!(result.is_err());
// After error, caller should close connection - no third read attempted
}
#[tokio::test]
async fn test_tcp_multiline_json() {
let data: &[u8] = b"{\n \"message\": \"hello\",\n \"level\": \"error\"\n}\n";
let mut reader = BufReader::new(data);
let result = parse_next_message(&mut reader).await.unwrap();
assert!(result.is_some());
let msg = result.unwrap();
assert_eq!(&*msg.msg, "hello");
assert_eq!(msg.level, Level::ERROR);
}
}
+11
View File
@@ -0,0 +1,11 @@
//! Log ingestion modules for signal-gateway.
//!
//! This crate provides listeners for receiving log messages in various formats:
//! - JSON (logstash-compatible) over UDP and TCP
//! - Syslog (RFC 5424) over UDP and TCP
pub mod json;
pub mod syslog;
pub use json::JsonConfig;
pub use syslog::SyslogConfig;
+483
View File
@@ -0,0 +1,483 @@
//! Syslog listener for receiving RFC 5424 syslog messages over UDP and TCP.
//!
//! TCP transport follows RFC 6587, supporting both octet counting and
//! non-transparent framing methods.
use conf::Conf;
use signal_gateway::{Gateway, Level, LogMessage};
use std::{net::SocketAddr, str::FromStr, sync::Arc};
use syslog_rfc5424::{SyslogMessage, SyslogSeverity};
use tokio::{
io::{AsyncRead, AsyncReadExt, BufReader},
net::{TcpListener, TcpStream, UdpSocket},
};
use tracing::{error, info, trace};
/// Configuration for the syslog listener (supports both UDP and TCP).
#[derive(Clone, Conf, Debug)]
#[conf(serde)]
pub struct SyslogConfig {
/// Socket address to listen for syslog messages.
/// Both UDP and TCP listeners are started on this address.
/// Messages use RFC 5424 format; TCP transport follows RFC 6587.
#[conf(long, env)]
pub listen_addr: SocketAddr,
/// Structured data ID for tracing metadata (module, file, line) in syslog messages.
#[conf(long, env, default_value = "tracing-meta@64700")]
pub sd_id: String,
/// If true, use CR (\r) as the message delimiter for non-transparent framing instead of LF (\n).
/// See RFC 6587 (Syslog over TCP) section 3.4.2.
/// Default delimiters: NUL or LF. With this flag: NUL or CR.
#[conf(long, env)]
pub tcp_cr_is_delimiter: bool,
}
impl SyslogConfig {
/// Bind UDP and TCP sockets and start background tasks to handle incoming syslog messages.
///
/// Returns join handles for the background tasks.
pub async fn start_tasks(
&self,
gateway: Arc<Gateway>,
) -> std::io::Result<(tokio::task::JoinHandle<()>, tokio::task::JoinHandle<()>)> {
let udp_handle = self.start_udp_task(gateway.clone()).await?;
let tcp_handle = self.start_tcp_task(gateway).await?;
Ok((udp_handle, tcp_handle))
}
async fn start_udp_task(
&self,
gateway: Arc<Gateway>,
) -> std::io::Result<tokio::task::JoinHandle<()>> {
let udp_socket = UdpSocket::bind(self.listen_addr).await?;
info!("Listening for syslog UDP on {}", self.listen_addr);
let sd_id = self.sd_id.clone();
Ok(tokio::task::spawn(async move {
let mut buf = vec![0u8; 8192];
loop {
let Ok((len, _addr)) = udp_socket
.recv_from(&mut buf)
.await
.inspect_err(|err| error!("Error receiving syslog UDP packet: {err}"))
else {
continue;
};
let Ok(text) = std::str::from_utf8(&buf[0..len])
.inspect_err(|err| error!("Syslog UDP packet was not utf8: {err}"))
else {
continue;
};
let Ok(syslog_msg) = SyslogMessage::from_str(text).inspect_err(|err| {
error!("Syslog UDP packet was not valid syslog: {err}:\n{text}")
}) else {
continue;
};
let log_msg = syslog_to_log_message(syslog_msg, &sd_id);
gateway.handle_log_message(log_msg).await;
}
}))
}
async fn start_tcp_task(
&self,
gateway: Arc<Gateway>,
) -> std::io::Result<tokio::task::JoinHandle<()>> {
let tcp_listener = TcpListener::bind(self.listen_addr).await?;
info!("Listening for syslog TCP on {}", self.listen_addr);
let config = self.clone();
Ok(tokio::task::spawn(async move {
loop {
let Ok((stream, addr)) = tcp_listener
.accept()
.await
.inspect_err(|err| error!("Error accepting syslog TCP connection: {err}"))
else {
continue;
};
trace!("Accepted syslog TCP connection from {addr}");
let gateway = gateway.clone();
let config = config.clone();
// Spawn a task for each connection
tokio::spawn(async move {
if let Err(err) = handle_tcp_connection(stream, &gateway, &config).await {
error!("Syslog TCP connection from {addr} error: {err}");
} else {
trace!("Syslog TCP connection from {addr} closed");
}
});
}
}))
}
}
/// Handle a single TCP connection using RFC 6587 framing.
async fn handle_tcp_connection(
stream: TcpStream,
gateway: &Gateway,
config: &SyslogConfig,
) -> std::io::Result<()> {
let mut reader = BufReader::new(stream);
loop {
let Some(msg_bytes) =
read_framed_syslog_bytes(&mut reader, config.tcp_cr_is_delimiter).await?
else {
return Ok(()); // Clean EOF
};
// Parse and process the message
let Ok(text) = std::str::from_utf8(&msg_bytes)
.inspect_err(|err| error!("Syslog TCP message was not utf8: {err}"))
else {
continue;
};
let Ok(syslog_msg) = SyslogMessage::from_str(text)
.inspect_err(|err| error!("Syslog TCP message was not valid: {err}:\n{text}"))
else {
continue;
};
let log_msg = syslog_to_log_message(syslog_msg, &config.sd_id);
gateway.handle_log_message(log_msg).await;
}
}
/// Read a single framed syslog message using RFC 6587 framing detection.
///
/// Returns:
/// - `Ok(Some(bytes))` - A complete message was read
/// - `Ok(None)` - EOF reached (no more messages)
/// - `Err(InvalidData)` - Invalid framing (e.g., unexpected first byte)
/// - `Err(other)` - I/O error
async fn read_framed_syslog_bytes<R>(
reader: &mut BufReader<R>,
cr_is_delimiter: bool,
) -> std::io::Result<Option<Vec<u8>>>
where
R: AsyncRead + Unpin,
{
loop {
// Read first byte to determine framing method
let first_byte = match reader.read_u8().await {
Ok(b) => b,
Err(e) if e.kind() == std::io::ErrorKind::UnexpectedEof => return Ok(None),
Err(e) => return Err(e),
};
match first_byte {
// Whitespace: skip and continue
b' ' | b'\t' | b'\n' | b'\r' => continue,
// Octet counting: starts with non-zero digit
b'1'..=b'9' => {
return read_octet_counted_message(reader, first_byte)
.await
.map(Some);
}
// Non-transparent framing: starts with '<' (beginning of syslog PRI)
b'<' => {
return read_non_transparent_message(reader, first_byte, cr_is_delimiter)
.await
.map(Some);
}
// Invalid first byte
_ => {
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
format!(
"invalid first byte 0x{:02x} ({:?})",
first_byte,
char::from(first_byte)
),
));
}
}
}
}
/// Read an octet-counted message (RFC 6587 section 3.4.1).
/// Format: MSG-LEN SP SYSLOG-MSG
async fn read_octet_counted_message<R>(
reader: &mut BufReader<R>,
first_digit: u8,
) -> std::io::Result<Vec<u8>>
where
R: AsyncRead + Unpin,
{
let mut len: usize = (first_digit - b'0') as usize;
// Read remaining digits until space
loop {
let b = reader.read_u8().await?;
match b {
b'0'..=b'9' => {
len = len
.checked_mul(10)
.and_then(|l| l.checked_add((b - b'0') as usize))
.ok_or_else(|| {
std::io::Error::new(
std::io::ErrorKind::InvalidData,
"message length overflow",
)
})?;
}
b' ' => break,
_ => {
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
format!("expected digit or space in octet count, got 0x{b:02x}"),
));
}
}
}
// Read exactly `len` bytes
let mut buf = vec![0u8; len];
reader.read_exact(&mut buf).await?;
Ok(buf)
}
/// Read a non-transparent framed message (RFC 6587 section 3.4.2).
/// Delimiter is NUL or LF by default, or NUL or CR if `tcp_cr_is_delimiter` is set.
/// Returns the message buffer on EOF (connection closed) as well as on delimiter.
async fn read_non_transparent_message<R>(
reader: &mut BufReader<R>,
first_byte: u8,
cr_is_delimiter: bool,
) -> std::io::Result<Vec<u8>>
where
R: AsyncRead + Unpin,
{
let mut msg = vec![first_byte];
let line_delimiter = if cr_is_delimiter { b'\r' } else { b'\n' };
loop {
let b = match reader.read_u8().await {
Ok(b) => b,
Err(e) if e.kind() == std::io::ErrorKind::UnexpectedEof => break, // EOF
Err(e) => return Err(e),
};
if b == b'\0' || b == line_delimiter {
break;
}
msg.push(b);
}
Ok(msg)
}
/// Convert SyslogSeverity to our Level enum
fn severity_to_level(sev: SyslogSeverity) -> Level {
match sev {
SyslogSeverity::SEV_EMERG => Level::EMERGENCY,
SyslogSeverity::SEV_ALERT => Level::ALERT,
SyslogSeverity::SEV_CRIT => Level::CRITICAL,
SyslogSeverity::SEV_ERR => Level::ERROR,
SyslogSeverity::SEV_WARNING => Level::WARNING,
SyslogSeverity::SEV_NOTICE => Level::NOTICE,
SyslogSeverity::SEV_INFO => Level::INFO,
SyslogSeverity::SEV_DEBUG => Level::DEBUG,
}
}
/// Convert a SyslogMessage to a LogMessage, extracting structured data for tracing metadata
fn syslog_to_log_message(msg: SyslogMessage, sd_id: &str) -> LogMessage {
let level = severity_to_level(msg.severity);
let mut builder = LogMessage::builder(level, msg.msg);
if let Some(ts) = msg.timestamp {
builder = builder.timestamp(ts);
}
if let Some(nanos) = msg.timestamp_nanos {
builder = builder.timestamp_nanos(nanos);
}
if let Some(hostname) = msg.hostname {
builder = builder.hostname(hostname);
}
if let Some(appname) = msg.appname {
builder = builder.appname(appname);
}
// Extract tracing metadata from structured data
if let Some(sd_element) = msg.sd.find_sdid(sd_id) {
if let Some(module) = sd_element.get("module") {
builder = builder.module_path(module.clone());
}
if let Some(file) = sd_element.get("file") {
builder = builder.file(file.clone());
}
if let Some(line) = sd_element.get("line") {
builder = builder.line(line.clone());
}
}
builder.build()
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_syslog_parsing() {
SyslogMessage::from_str(
"<12>1 2025-11-08T02:24:10.815221698+00:00 ip-172-31-5-8 app 92748 - - Dropped 3/4 reports",
)
.unwrap();
SyslogMessage::from_str(
"<12>1 2025-11-08T02:24:10.815221698+00:00 ip-172-31-5-8 app 92748 - - Dropped 3/4 reports",
)
.unwrap();
SyslogMessage::from_str(
"<12>1 2025-11-08T02:24:10.815+00:00 ip-172-31-5-8 app 92748 - - Dropped 3/4 reports due to staleness"
)
.unwrap();
}
#[tokio::test]
async fn test_framing_eof_returns_none() {
let data: &[u8] = b"";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, None);
}
#[tokio::test]
async fn test_framing_octet_counting() {
let data: &[u8] = b"5 hello";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(b"hello".to_vec()));
}
#[tokio::test]
async fn test_framing_octet_counting_multidigit_length() {
let msg = "a]".repeat(50); // 100 bytes
let data = format!("100 {msg}");
let mut reader = BufReader::new(data.as_bytes());
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(msg.as_bytes().to_vec()));
}
#[tokio::test]
async fn test_framing_non_transparent_lf_delimiter() {
let data: &[u8] = b"<14>1 test message\n";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(b"<14>1 test message".to_vec()));
}
#[tokio::test]
async fn test_framing_non_transparent_nul_delimiter() {
let data: &[u8] = b"<14>1 test message\0";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(b"<14>1 test message".to_vec()));
}
#[tokio::test]
async fn test_framing_non_transparent_cr_delimiter() {
let data: &[u8] = b"<14>1 test message\r";
let mut reader = BufReader::new(data);
// With cr_is_delimiter=true, CR is a delimiter
let result = read_framed_syslog_bytes(&mut reader, true).await.unwrap();
assert_eq!(result, Some(b"<14>1 test message".to_vec()));
}
#[tokio::test]
async fn test_framing_non_transparent_cr_not_delimiter_by_default() {
let data: &[u8] = b"<14>1 test\rmessage\n";
let mut reader = BufReader::new(data);
// With cr_is_delimiter=false, CR is part of the message
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(b"<14>1 test\rmessage".to_vec()));
}
#[tokio::test]
async fn test_framing_non_transparent_eof_returns_buffer() {
// No delimiter, just EOF - should return the accumulated buffer
let data: &[u8] = b"<14>1 test message";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(b"<14>1 test message".to_vec()));
}
#[tokio::test]
async fn test_framing_whitespace_skipping() {
let data: &[u8] = b" \n\t\r5 hello";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, Some(b"hello".to_vec()));
}
#[tokio::test]
async fn test_framing_whitespace_only_then_eof() {
let data: &[u8] = b" \n\t\r";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(result, None);
}
#[tokio::test]
async fn test_framing_invalid_first_byte() {
let data: &[u8] = b"xyz";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
#[tokio::test]
async fn test_framing_zero_not_valid_start() {
// '0' is not a valid start for octet counting (must be 1-9)
let data: &[u8] = b"0 hello";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
#[tokio::test]
async fn test_framing_multiple_messages() {
let data: &[u8] = b"5 hello<14>1 world\n3 foo";
let mut reader = BufReader::new(data);
let r1 = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(r1, Some(b"hello".to_vec()));
let r2 = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(r2, Some(b"<14>1 world".to_vec()));
let r3 = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(r3, Some(b"foo".to_vec()));
let r4 = read_framed_syslog_bytes(&mut reader, false).await.unwrap();
assert_eq!(r4, None);
}
#[tokio::test]
async fn test_framing_octet_counting_invalid_separator() {
// After digits, we expect a space, not another character
let data: &[u8] = b"5xhello";
let mut reader = BufReader::new(data);
let result = read_framed_syslog_bytes(&mut reader, false).await;
assert!(result.is_err());
assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::InvalidData);
}
}