feat: add structured logging to pf-proxy #11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update outdated dependencies: clap 3.2.25→4.5, nix 0.26→0.29, byteorder 1.3→1.5, num 0.2→0.4 - Normalize serde version constraints from '>=1.0' to '1.0' - Add comprehensive package metadata to all Cargo.toml files: - Add missing authors, descriptions, and license information - Fix repository URLs pointing to correct GitHub organization - Add relevant keywords and categories for Rust package discovery - Set homepage links to main repository - Establish workspace-level metadata inheritance - Add accessibility improvements to README.md banner image - Set rust-version metadata to 1.80 for toolchain consistency This improves package discoverability, maintainability, and follows Rust ecosystem best practices.
Replaced panicking unwrap/expect calls with proper error handling. Now gives cleaner error messages when config file is missing or invalid, and when command execution fails. Exit codes are preserved.
Replaced println statements with tracing for better observability. All proxy binaries now support RUST_LOG env var for log level control. Changes: - Added tracing and tracing-subscriber dependencies - Converted all println/eprintln to structured logging (info/error/warn) - Logs include contextual info like addresses, directions, and error details - Default log level is info, configurable via RUST_LOG env var This aligns with the roadmap item for improved logging in proxies.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added structured logging to all pf-proxy components using the
tracingcrate. This replaces the basic println statements with proper logging infrastructure that's more suitable for production deployments.Motivation
The roadmap mentions logging improvements for proxies in v0.11.0. Proxy components are critical infrastructure pieces that run long-lived processes, so having proper logging is essential for debugging and monitoring. The current println approach doesn't give operators enough control over log levels or output format.
Changes
Dependencies
tracingfor structured loggingtracing-subscriberwith env-filter supportAll proxy binaries updated:
Logging improvements:
RUST_LOGenvironment variableinfo, can be adjusted per-module if neededUsage
Set log level via environment variable:
Testing
Verified all binaries compile and logging format looks good. The structured fields make it easy to filter logs by connection direction, addresses, etc.