diff --git a/Cargo.toml b/Cargo.toml index f1b29417d4..616c3781ed 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,6 +8,7 @@ members = [ "opentelemetry-dynatrace", "opentelemetry-http", "opentelemetry-jaeger", + "opentelemetry-appender-log", "opentelemetry-otlp", "opentelemetry-prometheus", "opentelemetry-proto", @@ -32,6 +33,7 @@ members = [ "examples/http", "examples/hyper-prometheus", "examples/metrics-basic", + "examples/logs-basic", "examples/traceresponse", "examples/tracing-grpc", "examples/jaeger-remote-sampler", diff --git a/examples/logs-basic/Cargo.toml b/examples/logs-basic/Cargo.toml new file mode 100644 index 0000000000..20375f1652 --- /dev/null +++ b/examples/logs-basic/Cargo.toml @@ -0,0 +1,12 @@ +[package] +name = "logs-basic" +version = "0.1.0" +edition = "2021" +publish = false + +[dependencies] +opentelemetry_api = { path = "../../opentelemetry-api", features = ["logs"] } +opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["logs"] } +opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["logs"]} +opentelemetry-appender-log = { path = "../../opentelemetry-appender-log"} +log = {version = "0.4.17"} diff --git a/examples/logs-basic/README.md b/examples/logs-basic/README.md new file mode 100644 index 0000000000..3bca9129df --- /dev/null +++ b/examples/logs-basic/README.md @@ -0,0 +1,16 @@ +# Log Appender for API - Example + +This example shows how to use the opentelemetry-appender-log crate, which is a +[logging appender](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#log-appender--bridge) that bridges logs from the [log crate](https://docs.rs/log/latest/log/) to OpenTelemetry. +The example setups a LoggerProvider with stdout exporter, so logs are emitted to stdout. + +## Usage + +Run the following, and Logs emitted using [log](https://docs.rs/log/latest/log/) will be written out to stdout. + +```shell +$ cargo run +``` + + + diff --git a/examples/logs-basic/src/main.rs b/examples/logs-basic/src/main.rs new file mode 100644 index 0000000000..986af16c44 --- /dev/null +++ b/examples/logs-basic/src/main.rs @@ -0,0 +1,28 @@ +use log::{error, Level}; +use opentelemetry_api::KeyValue; +use opentelemetry_appender_log::OpenTelemetryLogBridge; +use opentelemetry_sdk::logs::{Config, LoggerProvider}; +use opentelemetry_sdk::Resource; + +fn main() { + // Setup LoggerProvider with a stdout exporter + let exporter = opentelemetry_stdout::LogExporter::default(); + let logger_provider = LoggerProvider::builder() + .with_config( + Config::default().with_resource(Resource::new(vec![KeyValue::new( + "service.name", + "logs-basic-example", + )])), + ) + .with_simple_exporter(exporter) + .build(); + + // Setup Log Appender for the log crate. + let otel_log_appender = OpenTelemetryLogBridge::new(&logger_provider); + log::set_boxed_logger(Box::new(otel_log_appender)).unwrap(); + log::set_max_level(Level::Error.to_level_filter()); + + // Emit logs using macros from the log crate. + // These logs gets piped through OpenTelemetry bridge and gets exported to stdout. + error!(target: "my-target", "hello from {}. My price is {}", "apple", 2.99); +} diff --git a/opentelemetry-appender-log/CHANGELOG.md b/opentelemetry-appender-log/CHANGELOG.md new file mode 100644 index 0000000000..4dc68c6ff8 --- /dev/null +++ b/opentelemetry-appender-log/CHANGELOG.md @@ -0,0 +1,2 @@ +# Changelog + diff --git a/opentelemetry-appender-log/CODEOWNERS b/opentelemetry-appender-log/CODEOWNERS new file mode 100644 index 0000000000..d6962a905a --- /dev/null +++ b/opentelemetry-appender-log/CODEOWNERS @@ -0,0 +1,5 @@ +# Code owners file. +# This file controls who is tagged for review for any given pull request. + +# For anything not explicitly taken by someone else: +* @open-telemetry/rust-approvers diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml new file mode 100644 index 0000000000..3c551beacb --- /dev/null +++ b/opentelemetry-appender-log/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "opentelemetry-appender-log" +version = "0.1.0" +edition = "2021" +description = "An OpenTelemetry appender for the log crate" +homepage = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-appender-log" +repository = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-appender-log" +readme = "README.md" +keywords = ["opentelemetry", "log", "logs"] +license = "Apache-2.0" +rust-version = "1.60" + +[dependencies] +opentelemetry_api = { version = "0.19", path = "../opentelemetry-api", features = ["logs"]} +opentelemetry_sdk = { version = "0.19", path = "../opentelemetry-sdk", features = ["logs"]} +log = {version = "0.4.17", features = ["kv_unstable", "std"]} + diff --git a/opentelemetry-appender-log/LICENSE b/opentelemetry-appender-log/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/opentelemetry-appender-log/LICENSE @@ -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/opentelemetry-appender-log/README.md b/opentelemetry-appender-log/README.md new file mode 100644 index 0000000000..60beac93d9 --- /dev/null +++ b/opentelemetry-appender-log/README.md @@ -0,0 +1,23 @@ +![OpenTelemetry — An observability framework for cloud-native software.][splash] + +[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png + +# OpenTelemetry Log Appender + +A [Log Appender](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#log-appender--bridge) that bridges logs from the [log crate](https://docs.rs/log/latest/log/) to OpenTelemetry. + +[![Crates.io: opentelemetry-appender-log](https://img.shields.io/crates/v/opentelemetry-appender-log.svg)](https://crates.io/crates/opentelemetry-appender-log) +[![Documentation](https://docs.rs/opentelemetry-appender-log/badge.svg)](https://docs.rs/opentelemetry-appender-log) +[![LICENSE](https://img.shields.io/crates/l/opentelemetry-appender-log)](./LICENSE) +[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain) +[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023) + +## Overview + +[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument, +generate, collect, and export telemetry data (metrics, logs, and traces) for +analysis in order to understand your software's performance and behavior. This +crate provides additional propagators and exporters for sending telemetry data +to vendors or using experimental propagators like `base64`. + +[`OpenTelemetry`]: https://crates.io/crates/opentelemetry diff --git a/opentelemetry-appender-log/src/lib.rs b/opentelemetry-appender-log/src/lib.rs new file mode 100644 index 0000000000..3707314fb8 --- /dev/null +++ b/opentelemetry-appender-log/src/lib.rs @@ -0,0 +1,59 @@ +use log::{Level, Metadata, Record}; +use opentelemetry_api::logs::{AnyValue, LogRecordBuilder, Logger, LoggerProvider, Severity}; + +pub struct OpenTelemetryLogBridge +where + P: LoggerProvider + Send + Sync, + L: Logger + Send + Sync, +{ + logger: L, + _phantom: std::marker::PhantomData

, // P is not used in this struct +} + +impl log::Log for OpenTelemetryLogBridge +where + P: LoggerProvider + Send + Sync, + L: Logger + Send + Sync, +{ + fn enabled(&self, _metadata: &Metadata) -> bool { + // TODO: This should be dynamic instead of the current hardcoded value. + true + } + + fn log(&self, record: &Record) { + if self.enabled(record.metadata()) { + self.logger.emit( + LogRecordBuilder::new() + .with_severity_number(map_severity_to_otel_severity(record.level())) + .with_severity_text(record.level().as_str()) + .with_body(AnyValue::from(record.args().to_string())) + .build(), + ); + } + } + + fn flush(&self) {} +} + +impl OpenTelemetryLogBridge +where + P: LoggerProvider + Send + Sync, + L: Logger + Send + Sync, +{ + pub fn new(provider: &P) -> Self { + OpenTelemetryLogBridge { + logger: provider.logger("opentelemetry-log-appender"), + _phantom: Default::default(), + } + } +} + +fn map_severity_to_otel_severity(level: Level) -> Severity { + match level { + Level::Error => Severity::Error, + Level::Warn => Severity::Warn, + Level::Info => Severity::Info, + Level::Debug => Severity::Debug, + Level::Trace => Severity::Trace, + } +} diff --git a/opentelemetry-sdk/src/logs/config.rs b/opentelemetry-sdk/src/logs/config.rs index 19a3ce0572..6e8efb6284 100644 --- a/opentelemetry-sdk/src/logs/config.rs +++ b/opentelemetry-sdk/src/logs/config.rs @@ -1,8 +1,18 @@ use std::borrow::Cow; +use crate::Resource; + /// Log emitter configuration. #[derive(Debug, Default)] pub struct Config { /// Contains attributes representing an entity that produces telemetry. pub resource: Cow<'static, crate::Resource>, } + +impl Config { + /// Specify the attributes representing the entity that produces telemetry + pub fn with_resource(mut self, resource: Resource) -> Self { + self.resource = Cow::Owned(resource); + self + } +} diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 432121a2d1..a5f2ce7001 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -1,7 +1,7 @@ use super::{BatchLogProcessor, Config, LogProcessor, LogRuntime, SimpleLogProcessor}; use crate::export::logs::{LogData, LogExporter}; use opentelemetry_api::{ - global::{handle_error, Error}, + global::{self}, logs::{LogRecord, LogResult}, trace::TraceContextExt, Context, InstrumentationLibrary, @@ -96,29 +96,22 @@ impl LoggerProvider { } } -impl Drop for LoggerProvider { - fn drop(&mut self) { - match self.try_shutdown() { - None => handle_error(Error::Other( - "canont shutdown LoggerProvider when child Loggers are still active".into(), - )), - Some(results) => { - for result in results { - if let Err(err) = result { - handle_error(err) - } - } - } - } - } -} - #[derive(Debug)] pub(crate) struct LoggerProviderInner { processors: Vec>, config: Config, } +impl Drop for LoggerProviderInner { + fn drop(&mut self) { + for processor in &mut self.processors { + if let Err(err) = processor.shutdown() { + global::handle_error(err); + } + } + } +} + #[derive(Debug, Default)] /// Builder for provider attributes. pub struct Builder {