wip

Cargo.toml

@@ -7,14 +7,11 @@ edition = "2021"
 name = "apache_prometheus_exporter"
 path = "src/main.rs"
 
-[profile.release]
-strip = true
-lto = true
-codegen-units = 1
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-hyper = { version = "0.14.27", default-features = false, features = ["http1", "server", "runtime"] }
-linemux = "0.3.0"
+actix-web = "4.1.0"
+linemux = "0.2.4"
 path-slash = "0.2.1"
-prometheus-client = "0.21.2"
-tokio = { version = "1.32.0", features = ["rt", "macros", "signal"] }
+prometheus-client = "0.18.0"
+tokio = { version = "1", features = ["rt", "macros", "signal"] }

docker/README.md

@@ -12,9 +12,9 @@ This configuration will create a Docker volume for the logs, and the following c
    - **User** : `admin`
    - **Password** : `admin`
 3. **Prometheus** configured with the exporter's endpoint.
-4. **Exporter** built using the source code from this repository, with its metrics endpoint exposed as: http://localhost:2004/metrics
+4. **Exporter** built using the source code from this repository.
 
-This example is unsuitable for production. You can use it as inspiration, but you will have to modify it in order to persist container data and follow the latest security practices:
+This example is not suitable for production. You can use it as inspiration, but you will have to modify it in order to persist container data and follow the latest security practices:
 
 - Create Docker volumes for persistent storage of container data and configuration files
 - Create a dedicated user for each container instead of running as `root`

docker/docker-compose.yml

@@ -38,15 +38,14 @@ services:
   exporter:
     container_name: ape_dev_exporter
     build: "../"
-    ports:
-      - "127.0.0.1:2004:9240"
+    expose:
+      - "9240"
     volumes:
       - logs:/logs
     environment:
       HTTP_HOST: "0.0.0.0"
       ACCESS_LOG_FILE_PATTERN: "/logs/*.access.log"
       ERROR_LOG_FILE_PATTERN: "/logs/*.error.log"
-    stop_signal: SIGINT
     restart: "always"
 
 volumes: 

src/apache_metrics.rs

@@ -2,7 +2,7 @@ use prometheus_client::metrics::counter::Counter;
 use prometheus_client::metrics::family::Family;
 use prometheus_client::registry::Registry;
 
-type SingleLabel = [(&'static str, String); 1];
+type SingleLabel = (&'static str, String);
 
 #[derive(Clone)]
 pub struct ApacheMetrics {
@@ -19,9 +19,9 @@ impl ApacheMetrics {
 			errors_total: Family::<SingleLabel, Counter>::default()
 		};
 		
-		registry.register("apache_requests", "Number of received requests", metrics.requests_total.clone());
-		registry.register("apache_errors", "Number of logged errors", metrics.errors_total.clone());
+		registry.register("apache_requests", "Number of received requests", Box::new(metrics.requests_total.clone()));
+		registry.register("apache_errors", "Number of logged errors", Box::new(metrics.errors_total.clone()));
 		
-		(registry, metrics)
+		return (registry, metrics);
 	}
 }

src/log_file_pattern.rs

@@ -14,7 +14,7 @@ use path_slash::PathExt;
 /// 2. A path with a wildcard anywhere in the file name.
 /// 3. A path with a standalone wildcard component (i.e. no prefix or suffix in the folder name).
 pub fn parse_log_file_pattern_from_env(variable_name: &str) -> Result<LogFilePattern, String> {
-	match env::var(variable_name) {
+	return match env::var(variable_name) {
 		Ok(str) => {
 			let pattern_str = Path::new(&str).to_slash().ok_or(format!("Environment variable {} contains an invalid path.", variable_name))?;
 			parse_log_file_pattern_from_str(&pattern_str)
@@ -23,7 +23,7 @@ pub fn parse_log_file_pattern_from_env(variable_name: &str) -> Result<LogFilePat
 			VarError::NotPresent => Err(format!("Environment variable {} must be set.", variable_name)),
 			VarError::NotUnicode(_) => Err(format!("Environment variable {} contains invalid characters.", variable_name))
 		}
-	}
+	};
 }
 
 fn parse_log_file_pattern_from_str(pattern_str: &str) -> Result<LogFilePattern, String> {
@@ -31,11 +31,11 @@ fn parse_log_file_pattern_from_str(pattern_str: &str) -> Result<LogFilePattern,
 		return Err(String::from("Path is empty."));
 	}
 	
-	if let Some((left, right)) = pattern_str.split_once('*') {
+	return if let Some((left, right)) = pattern_str.split_once('*') {
 		parse_log_file_pattern_split_on_wildcard(left, right)
 	} else {
 		Ok(LogFilePattern::WithoutWildcard(pattern_str.to_string()))
-	}
+	};
 }
 
 fn parse_log_file_pattern_split_on_wildcard(left: &str, right: &str) -> Result<LogFilePattern, String> {
@@ -54,7 +54,7 @@ fn parse_log_file_pattern_split_on_wildcard(left: &str, right: &str) -> Result<L
 		return Err(String::from("Path has a folder wildcard with a prefix or suffix."));
 	}
 	
-	if let Some((folder_path, file_name_prefix)) = left.rsplit_once('/') {
+	return if let Some((folder_path, file_name_prefix)) = left.rsplit_once('/') {
 		Ok(LogFilePattern::WithFileNameWildcard(PatternWithFileNameWildcard {
 			path: folder_path.to_string(),
 			file_name_prefix: file_name_prefix.to_string(),
@@ -66,7 +66,7 @@ fn parse_log_file_pattern_split_on_wildcard(left: &str, right: &str) -> Result<L
 			file_name_prefix: left.to_string(),
 			file_name_suffix: right.to_string(),
 		}))
-	}
+	};
 }
 
 #[derive(Debug)]
@@ -82,10 +82,11 @@ impl PatternWithFileNameWildcard {
 	}
 	
 	fn match_wildcard_on_dir_entry(&self, dir_entry: &DirEntry) -> Option<String> {
-		dir_entry.file_name()
-			.to_str()
-			.and_then(|file_name| self.match_wildcard(file_name))
-			.map(|wildcard_match| wildcard_match.to_string())
+		return if let Some(wildcard_match) = dir_entry.file_name().to_str().and_then(|file_name| self.match_wildcard(file_name)) {
+			Some(wildcard_match.to_string())
+		} else {
+			None
+		};
 	}
 }
 
@@ -114,22 +115,22 @@ pub enum LogFilePattern {
 
 impl LogFilePattern {
 	pub fn search(&self) -> Result<Vec<LogFilePath>, io::Error> { // TODO error message
-		match self {
+		return match self {
 			Self::WithoutWildcard(path) => Self::search_without_wildcard(path),
 			Self::WithFileNameWildcard(pattern) => Self::search_with_file_name_wildcard(pattern),
 			Self::WithFolderNameWildcard(pattern) => Self::search_with_folder_name_wildcard(pattern)
-		}
+		};
 	}
 	
 	fn search_without_wildcard(path_str: &String) -> Result<Vec<LogFilePath>, io::Error> {
 		let path = Path::new(path_str);
 		let is_valid = path.is_file() || matches!(path.parent(), Some(parent) if parent.is_dir());
 		
-		if is_valid {
+		return if is_valid {
 			Ok(vec![LogFilePath::with_empty_label(path_str)])
 		} else {
 			Err(io::Error::from(ErrorKind::NotFound))
-		}
+		};
 	}
 	
 	fn search_with_file_name_wildcard(pattern: &PatternWithFileNameWildcard) -> Result<Vec<LogFilePath>, io::Error> {
@@ -142,7 +143,7 @@ impl LogFilePattern {
 			}
 		}
 		
-		Ok(result)
+		return Ok(result);
 	}
 	
 	fn search_with_folder_name_wildcard(pattern: &PatternWithFolderNameWildcard) -> Result<Vec<LogFilePath>, io::Error> {
@@ -158,7 +159,7 @@ impl LogFilePattern {
 			}
 		}
 		
-		Ok(result)
+		return Ok(result);
 	}
 }
 
@@ -169,10 +170,10 @@ pub struct LogFilePath {
 
 impl LogFilePath {
 	fn with_empty_label(s: &String) -> LogFilePath {
-		LogFilePath {
+		return LogFilePath {
 			path: PathBuf::from(s),
 			label: String::default(),
-		}
+		};
 	}
 }
 
@@ -208,12 +209,12 @@ mod tests {
 	
 	#[test]
 	fn valid_with_file_name_wildcard_prefix() {
-		assert!(matches!(parse_log_file_pattern_from_str("/path/to/files/access_*"), Ok(LogFilePattern::WithFileNameWildcard(pattern)) if pattern.path == "/path/to/files" && pattern.file_name_prefix == "access_" && pattern.file_name_suffix.is_empty()));
+		assert!(matches!(parse_log_file_pattern_from_str("/path/to/files/access_*"), Ok(LogFilePattern::WithFileNameWildcard(pattern)) if pattern.path == "/path/to/files" && pattern.file_name_prefix == "access_" && pattern.file_name_suffix == ""));
 	}
 	
 	#[test]
 	fn valid_with_file_name_wildcard_suffix() {
-		assert!(matches!(parse_log_file_pattern_from_str("/path/to/files/*_access.log"), Ok(LogFilePattern::WithFileNameWildcard(pattern)) if pattern.path == "/path/to/files" && pattern.file_name_prefix.is_empty() && pattern.file_name_suffix == "_access.log"));
+		assert!(matches!(parse_log_file_pattern_from_str("/path/to/files/*_access.log"), Ok(LogFilePattern::WithFileNameWildcard(pattern)) if pattern.path == "/path/to/files" && pattern.file_name_prefix == "" && pattern.file_name_suffix == "_access.log"));
 	}
 	
 	#[test]

src/log_watcher.rs

@@ -6,7 +6,7 @@ use std::path::PathBuf;
 use linemux::{Line, MuxedLines};
 use tokio::sync::mpsc::UnboundedSender;
 
-use crate::ApacheMetrics;
+use crate::{ApacheMetrics, log_parser};
 use crate::log_file_pattern::LogFilePath;
 
 #[derive(Copy, Clone, PartialEq)]
@@ -21,8 +21,8 @@ struct LogFileInfo<'a> {
 }
 
 impl<'a> LogFileInfo<'a> {
-	fn get_label_set(&self) -> [(&'static str, String); 1] {
-		[("file", self.label.clone())]
+	fn get_label_set(&self) -> (&'static str, String) {
+		return ("file", self.label.clone());
 	}
 }
 
@@ -40,10 +40,10 @@ struct LogWatcher<'a> {
 
 impl<'a> LogWatcher<'a> {
 	fn new() -> io::Result<LogWatcher<'a>> {
-		Ok(LogWatcher {
+		return Ok(LogWatcher {
 			reader: MuxedLines::new()?,
 			files: HashMap::new(),
-		})
+		});
 	}
 	
 	fn count_files_of_kind(&self, kind: LogFileKind) -> usize {
@@ -77,22 +77,33 @@ impl<'a> LogWatcher<'a> {
 		}
 	}
 	
-	fn handle_line(&mut self, event: Line, metrics: &ApacheMetrics) {
-		match self.files.get(event.source()) {
-			Some(metadata) => {
-				let label = metadata.label;
-				let (kind, family) = match metadata.kind {
-					LogFileKind::Access => ("access log", &metrics.requests_total),
-					LogFileKind::Error => ("error log", &metrics.errors_total),
-				};
-				
-				println!("[LogWatcher] Received {} line from \"{}\": {}", kind, label, event.line());
-				family.get_or_create(&metadata.get_label_set()).inc();
+	fn handle_line(&self, event: Line, metrics: &ApacheMetrics) {
+		if let Some(file) = self.files.get(event.source()) {
+			match file.kind {
+				LogFileKind::Access => self.handle_access_log_line(event.line(), file, metrics),
+				LogFileKind::Error => self.handle_error_log_line(event.line(), file, metrics),
 			}
-			None => {
+		} else {
 			println!("[LogWatcher] Received line from unknown file: {}", event.source().display());
 		}
 	}
+	
+	fn handle_access_log_line(&self, line: &str, file: &LogFileInfo, metrics: &ApacheMetrics) {
+		match log_parser::AccessLogLineParts::parse(line) {
+			Ok(parts) => {
+				println!("[LogWatcher] Received access log line from \"{}\": {}", file.label, parts)
+			}
+			Err(err) => {
+				println!("[LogWatcher] Received access log line from \"{}\" with invalid format ({:?}): {}", file.label, err, line)
+			}
+		}
+		
+		metrics.requests_total.get_or_create(&file.get_label_set()).inc();
+	}
+	
+	fn handle_error_log_line(&self, line: &str, file: &LogFileInfo, metrics: &ApacheMetrics) {
+		println!("[LogWatcher] Received error log line from \"{}\": {}", file.label, line);
+		metrics.errors_total.get_or_create(&file.get_label_set()).inc();
 	}
 }
 

src/main.rs

@@ -1,7 +1,5 @@
 use std::env;
-use std::net::{IpAddr, SocketAddr};
 use std::process::ExitCode;
-use std::str::FromStr;
 use std::sync::Mutex;
 
 use tokio::signal;
@@ -10,7 +8,7 @@ use tokio::sync::mpsc;
 use crate::apache_metrics::ApacheMetrics;
 use crate::log_file_pattern::{LogFilePath, parse_log_file_pattern_from_env};
 use crate::log_watcher::watch_logs_task;
-use crate::web_server::WebServer;
+use crate::web_server::{create_web_server, run_web_server};
 
 mod apache_metrics;
 mod log_file_pattern;
@@ -18,8 +16,8 @@ mod log_parser;
 mod log_watcher;
 mod web_server;
 
-const ACCESS_LOG_FILE_PATTERN: &str = "ACCESS_LOG_FILE_PATTERN";
-const ERROR_LOG_FILE_PATTERN: &str = "ERROR_LOG_FILE_PATTERN";
+const ACCESS_LOG_FILE_PATTERN: &'static str = "ACCESS_LOG_FILE_PATTERN";
+const ERROR_LOG_FILE_PATTERN: &'static str = "ERROR_LOG_FILE_PATTERN";
 
 fn find_log_files(environment_variable_name: &str, log_kind: &str) -> Option<Vec<LogFilePath>> {
 	let log_file_pattern = match parse_log_file_pattern_from_env(environment_variable_name) {
@@ -47,19 +45,12 @@ fn find_log_files(environment_variable_name: &str, log_kind: &str) -> Option<Vec
 		println!("Found {} file: {} (label \"{}\")", log_kind, log_file.path.display(), log_file.label);
 	}
 	
-	Some(log_files)
+	return Some(log_files);
 }
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() -> ExitCode {
 	let host = env::var("HTTP_HOST").unwrap_or(String::from("127.0.0.1"));
-	let bind_ip = match IpAddr::from_str(&host) {
-		Ok(addr) => addr,
-		Err(_) => {
-			println!("Invalid HTTP host: {}", host);
-			return ExitCode::FAILURE;
-		}
-	};
 	
 	println!("Initializing exporter...");
 	
@@ -73,16 +64,11 @@ async fn main() -> ExitCode {
 		None => return ExitCode::FAILURE,
 	};
 	
-	let server = match WebServer::try_bind(SocketAddr::new(bind_ip, 9240)) {
-		Some(server) => server,
-		None => return ExitCode::FAILURE
-	};
-	
 	let (metrics_registry, metrics) = ApacheMetrics::new();
 	let (shutdown_send, mut shutdown_recv) = mpsc::unbounded_channel();
 	
 	tokio::spawn(watch_logs_task(access_log_files, error_log_files, metrics.clone(), shutdown_send.clone()));
-	tokio::spawn(server.serve(Mutex::new(metrics_registry)));
+	tokio::spawn(run_web_server(create_web_server(host.as_str(), 9240, Mutex::new(metrics_registry))));
 	
 	drop(shutdown_send);
 	

src/web_server.rs

@@ -1,95 +1,54 @@
-use std::fmt;
-use std::net::SocketAddr;
-use std::sync::{Arc, Mutex};
+use std::str;
+use std::sync::Mutex;
 use std::time::Duration;
 
-use hyper::{Body, Error, header, Method, Request, Response, Server, StatusCode};
-use hyper::http::Result;
-use hyper::server::Builder;
-use hyper::server::conn::AddrIncoming;
-use hyper::service::{make_service_fn, service_fn};
+use actix_web::{App, HttpResponse, HttpServer, Result, web};
+use actix_web::dev::Server;
 use prometheus_client::encoding::text::encode;
 use prometheus_client::registry::Registry;
 
-const MAX_BUFFER_SIZE: usize = 1024 * 32;
+//noinspection HttpUrlsUsage
+pub fn create_web_server(host: &str, port: u16, metrics_registry: Mutex<Registry>) -> Server {
+	let metrics_registry = web::Data::new(metrics_registry);
 	
-pub struct WebServer {
-	builder: Builder<AddrIncoming>,
-}
-
-impl WebServer {
-	//noinspection HttpUrlsUsage
-	pub fn try_bind(addr: SocketAddr) -> Option<WebServer> {
-		println!("[WebServer] Starting web server on {0} with metrics endpoint: http://{0}/metrics", addr);
-		let builder = match Server::try_bind(&addr) {
-			Ok(builder) => builder,
-			Err(e) => {
-				println!("[WebServer] Could not bind to {}: {}", addr, e);
-				return None;
-			}
-		};
-		
-		let builder = builder.tcp_keepalive(Some(Duration::from_secs(60)));
-		let builder = builder.http1_only(true);
-		let builder = builder.http1_keepalive(true);
-		let builder = builder.http1_max_buf_size(MAX_BUFFER_SIZE);
-		let builder = builder.http1_header_read_timeout(Duration::from_secs(10));
-		
-		Some(WebServer { builder })
-	}
-	
-	pub async fn serve(self, metrics_registry: Mutex<Registry>) {
-		let metrics_registry = Arc::new(metrics_registry);
-		let service = make_service_fn(move |_| {
-			let metrics_registry = Arc::clone(&metrics_registry);
-			async move {
-				Ok::<_, Error>(service_fn(move |req| handle_request(req, Arc::clone(&metrics_registry))))
-			}
+	let server = HttpServer::new(move || {
+		App::new()
+			.app_data(metrics_registry.clone())
+			.service(web::resource("/metrics").route(web::get().to(metrics_handler)))
 	});
 	
-		if let Err(e) = self.builder.serve(service).await {
-			println!("[WebServer] Error starting web server: {}", e);
-		}
+	let server = server.keep_alive(Duration::from_secs(60));
+	let server = server.shutdown_timeout(0);
+	let server = server.disable_signals();
+	let server = server.workers(1);
+	let server = server.bind((host, port));
+
+	println!("[WebServer] Starting web server on {0}:{1} with metrics endpoint: http://{0}:{1}/metrics", host, port);
+	return server.unwrap().run();
+}
+
+pub async fn run_web_server(server: Server) {
+	if let Err(e) = server.await {
+		println!("[WebServer] Error running web server: {}", e);
 	}
 }
 
-async fn handle_request(req: Request<Body>, metrics_registry: Arc<Mutex<Registry>>) -> Result<Response<Body>> {
-	if req.method() == Method::GET && req.uri().path() == "/metrics" {
-		metrics_handler(Arc::clone(&metrics_registry)).await
+async fn metrics_handler(metrics_registry: web::Data<Mutex<Registry>>) -> Result<HttpResponse> {
+	let mut buf = Vec::new();
+	
+	{
+		if let Ok(metrics_registry) = metrics_registry.lock() {
+			encode(&mut buf, &metrics_registry)?;
 		} else {
-		Response::builder().status(StatusCode::NOT_FOUND).body(Body::empty())
-	}
-}
-
-//noinspection SpellCheckingInspection
-async fn metrics_handler(metrics_registry: Arc<Mutex<Registry>>) -> Result<Response<Body>> {
-	match encode_metrics(metrics_registry) {
-		MetricsEncodeResult::Ok(buf) => {
-			Response::builder().status(StatusCode::OK).header(header::CONTENT_TYPE, "application/openmetrics-text; version=1.0.0; charset=utf-8").body(Body::from(buf))
-		}
-		MetricsEncodeResult::FailedAcquiringRegistryLock => {
 			println!("[WebServer] Failed acquiring lock on registry.");
-			Response::builder().status(StatusCode::INTERNAL_SERVER_ERROR).body(Body::empty())
-		}
-		MetricsEncodeResult::FailedEncodingMetrics(e) => {
-			println!("[WebServer] Error encoding metrics: {}", e);
-			Response::builder().status(StatusCode::INTERNAL_SERVER_ERROR).body(Body::empty())
+			return Ok(HttpResponse::InternalServerError().body(""));
 		}
 	}
-}
 	
-enum MetricsEncodeResult {
-	Ok(String),
-	FailedAcquiringRegistryLock,
-	FailedEncodingMetrics(fmt::Error),
-}
-
-fn encode_metrics(metrics_registry: Arc<Mutex<Registry>>) -> MetricsEncodeResult {
-	let mut buf = String::new();
-	
-	return if let Ok(metrics_registry) = metrics_registry.lock() {
-		encode(&mut buf, &metrics_registry).map_or_else(MetricsEncodeResult::FailedEncodingMetrics, |_| MetricsEncodeResult::Ok(buf))
+	if let Ok(buf) = String::from_utf8(buf) {
+		Ok(HttpResponse::Ok().content_type("application/openmetrics-text; version=1.0.0; charset=utf-8").body(buf))
 	} else {
-		MetricsEncodeResult::FailedAcquiringRegistryLock
-	};
+		println!("[WebServer] Failed converting buffer to UTF-8.");
+		Ok(HttpResponse::InternalServerError().body(""))
+	}
 }