From dc83e1e89a7d2d41c7e29b0187f6f25744bbf9af Mon Sep 17 00:00:00 2001 From: 8192K Date: Mon, 12 Feb 2024 20:49:47 +0100 Subject: [PATCH] Initial commit --- .github/workflows/rust.yml | 22 ++++ .gitignore | 11 ++ Cargo.toml | 24 +++++ LICENSE-APACHE.txt | 201 +++++++++++++++++++++++++++++++++++++ LICENSE-MIT.txt | 20 ++++ README.md | 41 ++++++++ rustfmt.toml | 1 + src/defaults.rs | 44 ++++++++ src/error.rs | 14 +++ src/lib.rs | 141 ++++++++++++++++++++++++++ 10 files changed, 519 insertions(+) create mode 100644 .github/workflows/rust.yml create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE.txt create mode 100644 LICENSE-MIT.txt create mode 100644 README.md create mode 100644 rustfmt.toml create mode 100644 src/defaults.rs create mode 100644 src/error.rs create mode 100644 src/lib.rs diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..31000a2 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,22 @@ +name: Rust + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..114a4ab --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +**/debug +**/target +**/Cargo.lock +**/*.rs.bk +*.pdb +.vscode +.idea +.envs +**/*.log +**/.env +.DS_Store \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..27588c6 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,24 @@ +[package] +name = "redis_logger" +version = "0.3.0" +edition = "2018" +description = "A logger implementing the log::Log trait that writes log messages to a Redis pub/sub channel, a stream or both using the redis_rs crate" +repository = "https://github.com/8192K/redis-logger" +authors = ["Sebastian Frehmel <8192K@sebastianfrehmel.de>"] +license = "MIT/Apache-2.0" +categories = ["development-tools", "development-tools::debugging", "database"] +keywords = ["log", "logger", "logging", "redis", "redis_rs"] +readme = "README.md" + +[dependencies] +log = { version = "0.4" , features = ["std"] } +redis = "0.24" +thiserror = "1.0.57" +serde_json = { version="1.0.113", optional = true } + +[features] +default_encoding = ["dep:serde_json"] + +[profile.release] +lto = true +codegen-units = 1 \ No newline at end of file diff --git a/LICENSE-APACHE.txt b/LICENSE-APACHE.txt new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT.txt b/LICENSE-MIT.txt new file mode 100644 index 0000000..ef3e1f3 --- /dev/null +++ b/LICENSE-MIT.txt @@ -0,0 +1,20 @@ +Copyright (c) 2024 Sebastian Frehmel + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..409f775 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# threaded-proxy-logger + +[![Crates.io](https://img.shields.io/crates/v/threaded-proxy-logger.svg)](https://crates.io/crates/threaded-proxy-logger) +[![Docs](https://docs.rs/threaded-proxy-logger/badge.svg)](https://docs.rs/threaded-proxy-logger) +[![MIT/APACHE-2.0](https://img.shields.io/crates/l/threaded-proxy-logger.svg)](https://crates.io/crates/threaded-proxy-logger) + +A simple logger that does not do logging by itself but passes all log events to an arbitrary number of passed loggers which run in a separate thread. + +Very useful when logging is a bottleneck such as in realtime scenarios or when logging to a network or database etc. + +## Usage + +Add the dependency to your `Cargo.toml`: + +```toml +[dependencies] +log = "0.4" +threaded_proxy_logger = "0.5" +``` + +How to use in your application: + +```rust +use threaded_proxy_logger::ThreadedProxyLogger; + +fn main() { + ThreadedProxyLogger::init(log::LevelFilter::Info, any_logger_that_implements_the_Log_trait>); +} +``` +To pass multiple loggers, use a bundling logger like `simplelog::CombinedLogger` for example. + +Make sure not to pass other loggers by using their respective `init` methods, but to use their `new` methods instead. +Do not register any other logger with the log crate before as the ThreadedProxyLogger will take that place. + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000..979a314 --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1 @@ +max_width = 130 \ No newline at end of file diff --git a/src/defaults.rs b/src/defaults.rs new file mode 100644 index 0000000..da6b728 --- /dev/null +++ b/src/defaults.rs @@ -0,0 +1,44 @@ +use super::{PubSubEncoder, Record, StreamEncoder}; + +pub struct DefaultPubSubEncoder; + +impl DefaultPubSubEncoder { + pub fn new() -> Self { + Self {} + } +} + +impl PubSubEncoder for DefaultPubSubEncoder { + fn encode(&self, record: &Record) -> Vec { + let json = serde_json::json!({ + "level": record.level().as_str(), + "args": record.args().to_string(), + "module_path": record.module_path().map(str::to_owned), + "target": record.target().to_owned(), + "file": record.file().map(str::to_owned), + "line": record.line() + }); + json.to_string().into_bytes() + } +} + +pub struct DefaultStreamEncoder; + +impl DefaultStreamEncoder { + pub fn new() -> Self { + Self {} + } +} + +impl StreamEncoder for DefaultStreamEncoder { + fn encode(&self, record: &Record) -> Vec<(&str, Vec)> { + vec![ + ("level", record.level().as_str().to_owned().into_bytes()), + ("args", record.args().to_string().into_bytes()), + ("module_path", record.module_path().unwrap_or("null").to_owned().into_bytes()), + ("target", record.target().to_owned().into_bytes()), + ("file", record.file().unwrap_or("null").to_owned().into_bytes()), + ("line", record.line().unwrap_or(0).to_string().into_bytes()), + ] + } +} diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..75f491a --- /dev/null +++ b/src/error.rs @@ -0,0 +1,14 @@ +use log::SetLoggerError; +use redis::RedisError; + +#[derive(Debug, thiserror::Error)] +pub enum RedisLoggerConfigError { + #[error("Redis client not set")] + ClientNotSet(), + #[error("Channels not set. Set at least one pub/sub channel and/or one stream name.")] + ChannelNotSet(), + #[error("Error handling Redis: {0}")] + RedisError(#[from] RedisError), + #[error("Error initializing logger: {0}")] + SetLoggerError(#[from] SetLoggerError), +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..d9a2436 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,141 @@ +use std::sync::Mutex; + +use log::{LevelFilter, Log, Metadata, Record}; +use redis::{Client, Connection}; + +mod error; +pub use error::RedisLoggerConfigError; + +#[cfg(feature = "default_encoding")] +mod defaults; +#[cfg(feature = "default_encoding")] +pub use defaults::*; + +pub trait PubSubEncoder: Send + Sync { + fn encode(&self, record: &Record) -> Vec; +} + +pub trait StreamEncoder: Send + Sync { + fn encode(&self, record: &Record) -> Vec<(&str, Vec)>; +} + +pub struct RedisLogger { + level: LevelFilter, + config: RedisLoggerConfig, +} + +impl RedisLogger { + pub fn new(level: LevelFilter, config: RedisLoggerConfig) -> Box { + Box::new(Self { level, config }) + } + + pub fn init(level: LevelFilter, config: RedisLoggerConfig) -> Result<(), RedisLoggerConfigError> { + let redis_logger = RedisLogger::new(level, config); + log::set_max_level(level); + log::set_boxed_logger(redis_logger)?; + Ok(()) + } +} + +impl Log for RedisLogger { + fn enabled(&self, metadata: &Metadata) -> bool { + metadata.level() <= self.level + } + + fn log(&self, record: &Record) { + if self.enabled(record.metadata()) { + let config = &self.config; + let mut pipe = redis::pipe(); + if let Some((channels, encoder)) = &config.channels { + let message = encoder.encode(record); + for channel in channels { + pipe.publish(channel, &message); + } + } + if let Some((streams, encoder)) = &config.streams { + let message = encoder.encode(record); + let message = message.as_slice(); + for stream in streams { + pipe.xadd(stream, "*", message); + } + } + // this unwrap only panics if the connection is poisoned, so we can't do much anyway and will panic, too! + if let Err(e) = pipe.query::<()>(&mut config.connection.lock().unwrap()) { + eprintln!("Error logging to Redis: {}", e); + } + } + } + + fn flush(&self) {} +} + +pub struct RedisLoggerConfig { + connection: Mutex, + channels: Option<(Vec, Box)>, + streams: Option<(Vec, Box)>, +} + +impl RedisLoggerConfig { + pub fn builder() -> RedisLoggerConfigBuilder { + RedisLoggerConfigBuilder::new() + } +} + +pub struct RedisLoggerConfigBuilder { + client: Option, + channels: Option<(Vec, Box)>, + streams: Option<(Vec, Box)>, +} + +impl RedisLoggerConfigBuilder { + fn new() -> Self { + Self { + client: None, + channels: None, + streams: None, + } + } + + pub fn with_client(mut self, client: Client) -> Self { + self.client = Some(client); + self + } + + #[cfg(feature = "default_encoding")] + pub fn with_pubsub(mut self, channels: (Vec, Option>)) -> Self { + self.channels = Some((channels.0, channels.1.unwrap_or(Box::new(DefaultPubSubEncoder::new())))); + self + } + + #[cfg(feature = "default_encoding")] + pub fn with_streams(mut self, streams: (Vec, Option>)) -> Self { + self.streams = Some((streams.0, streams.1.unwrap_or(Box::new(DefaultStreamEncoder::new())))); + self + } + + #[cfg(not(feature = "default_encoding"))] + pub fn with_pubsub(mut self, channels: (Vec, Box)) -> Self { + self.channels = Some(channels); + self + } + + #[cfg(not(feature = "default_encoding"))] + pub fn with_streams(mut self, streams: (Vec, Box)) -> Self { + self.streams = Some(streams); + self + } + + pub fn build(self) -> Result { + let client = self.client.ok_or(RedisLoggerConfigError::ClientNotSet())?; + if self.channels.is_none() && self.streams.is_none() { + return Err(RedisLoggerConfigError::ChannelNotSet()); + }; + + let connection = client.get_connection()?; + Ok(RedisLoggerConfig { + connection: Mutex::new(connection), + channels: self.channels, + streams: self.streams, + }) + } +}