diff --git a/opentelemetry-derive/CHANGELOG.md b/opentelemetry-derive/CHANGELOG.md new file mode 100644 index 00000000..6745afa4 --- /dev/null +++ b/opentelemetry-derive/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +## vNext + +### Added + +- Add derive macros for conversion into `Key`, `Value`, `Stringvalue` and `KeyValue`. diff --git a/opentelemetry-derive/CODEOWNERS b/opentelemetry-derive/CODEOWNERS new file mode 100644 index 00000000..d6962a90 --- /dev/null +++ b/opentelemetry-derive/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-derive/Cargo.toml b/opentelemetry-derive/Cargo.toml new file mode 100644 index 00000000..24c0e172 --- /dev/null +++ b/opentelemetry-derive/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "opentelemetry-derive" +version = "0.1.0" +description = "Derive macros for OpenTelemetry" +homepage = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-derive" +repository = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-derive" +readme = "README.md" +categories = ["development-tools::procedural-macro-helpers"] +keywords = ["opentelemetry", "derive", "macro", "macros"] +license = "Apache-2.0" +edition = "2021" +rust-version = "1.71.1" + +[dependencies] +opentelemetry-derive-impl = { version = "0.1", path = "opentelemetry-derive-impl" } + +[dev-dependencies] +opentelemetry = { workspace = true } diff --git a/opentelemetry-derive/LICENSE b/opentelemetry-derive/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/opentelemetry-derive/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-derive/README.md b/opentelemetry-derive/README.md new file mode 100644 index 00000000..57afa096 --- /dev/null +++ b/opentelemetry-derive/README.md @@ -0,0 +1,27 @@ +![OpenTelemetry — An observability framework for cloud-native software.][splash] + +[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png + +# OpenTelemetry derive macros + +Derive macros for [`OpenTelemetry`]. + +[![Crates.io: opentelemetry-derive](https://img.shields.io/crates/v/opentelemetry-derive.svg)](https://crates.io/crates/opentelemetry-derive) +[![Documentation](https://docs.rs/opentelemetry-derive/badge.svg)](https://docs.rs/opentelemetry-derive) +[![LICENSE](https://img.shields.io/crates/l/opentelemetry-derive)](./LICENSE) +[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust-contrib/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust-contrib/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 derive macros for conversions into [`OpenTelemetry`] common types. + +## Usage + +See on [docs.rs](https://docs.rs/opentelemetry-derive/latest/opentelemetry_derive/#usage). + +[`OpenTelemetry`]: https://crates.io/crates/opentelemetry diff --git a/opentelemetry-derive/opentelemetry-derive-impl/CHANGELOG.md b/opentelemetry-derive/opentelemetry-derive-impl/CHANGELOG.md new file mode 100644 index 00000000..e1896a31 --- /dev/null +++ b/opentelemetry-derive/opentelemetry-derive-impl/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +## vNext + +### Added + +- Add derive macro implementations for conversion into `Key`, `Value`, `Stringvalue` and `KeyValue`. diff --git a/opentelemetry-derive/opentelemetry-derive-impl/CODEOWNERS b/opentelemetry-derive/opentelemetry-derive-impl/CODEOWNERS new file mode 100644 index 00000000..d6962a90 --- /dev/null +++ b/opentelemetry-derive/opentelemetry-derive-impl/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-derive/opentelemetry-derive-impl/Cargo.toml b/opentelemetry-derive/opentelemetry-derive-impl/Cargo.toml new file mode 100644 index 00000000..e6780ce8 --- /dev/null +++ b/opentelemetry-derive/opentelemetry-derive-impl/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "opentelemetry-derive-impl" +version = "0.1.0" +description = "Implementation of derive macros for OpenTelemetry" +homepage = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-derive/opentelemetry-derive-impl" +repository = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-derive/opentelemetry-derive-impl" +readme = "README.md" +categories = ["development-tools::procedural-macro-helpers"] +keywords = ["opentelemetry", "derive", "macro", "macros"] +license = "Apache-2.0" +edition = "2021" +rust-version = "1.71.1" + +[lib] +proc-macro = true + +[dependencies] +darling = "0.20" +proc-macro2 = "1" +quote = "1" +syn = "2" diff --git a/opentelemetry-derive/opentelemetry-derive-impl/LICENSE b/opentelemetry-derive/opentelemetry-derive-impl/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/opentelemetry-derive/opentelemetry-derive-impl/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-derive/opentelemetry-derive-impl/README.md b/opentelemetry-derive/opentelemetry-derive-impl/README.md new file mode 100644 index 00000000..848770b0 --- /dev/null +++ b/opentelemetry-derive/opentelemetry-derive-impl/README.md @@ -0,0 +1,24 @@ +![OpenTelemetry — An observability framework for cloud-native software.][splash] + +[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png + +# OpenTelemetry derive macro implementations + +Implementation of derive macros for [`OpenTelemetry`]. + +[![Crates.io: opentelemetry-derive-impl](https://img.shields.io/crates/v/opentelemetry-derive-impl.svg)](https://crates.io/crates/opentelemetry-derive-impl) +[![Documentation](https://docs.rs/opentelemetry-derive-impl/badge.svg)](https://docs.rs/opentelemetry-derive-impl) +[![LICENSE](https://img.shields.io/crates/l/opentelemetry-derive-impl)](./LICENSE) +[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust-contrib/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust-contrib/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 the implementation of derive macros, it should not be used directly, +but through the `opentelemetry-derive` crate. + +[`OpenTelemetry`]: https://crates.io/crates/opentelemetry diff --git a/opentelemetry-derive/opentelemetry-derive-impl/src/lib.rs b/opentelemetry-derive/opentelemetry-derive-impl/src/lib.rs new file mode 100644 index 00000000..f9d710fb --- /dev/null +++ b/opentelemetry-derive/opentelemetry-derive-impl/src/lib.rs @@ -0,0 +1,129 @@ +use darling::{util::Ignored, FromDeriveInput}; +use proc_macro2::TokenStream; +use quote::quote; +use syn::{parse_macro_input, DeriveInput, Path}; + +#[derive(FromDeriveInput)] +#[darling(attributes(otel))] +struct Options { + key: Key, + variant: Variant, +} + +#[proc_macro_derive(Key, attributes(otel))] +pub fn key(input: proc_macro::TokenStream) -> proc_macro::TokenStream { + derive(input, key_impl) +} + +fn key_impl(input: DeriveInput) -> syn::Result { + let options = Options::, Option>::from_derive_input(&input)?; + let ident = input.ident; + let key = options.key.unwrap_or(ident.to_string().to_lowercase()); + Ok(quote! { + impl #ident { + const KEY: opentelemetry::Key = opentelemetry::Key::from_static_str(#key); + } + + #[automatically_derived] + impl From<&#ident> for opentelemetry::Key { + fn from(_: &#ident) -> Self { + #ident::KEY + } + } + + #[automatically_derived] + impl From<#ident> for opentelemetry::Key { + fn from(_: #ident) -> Self { + #ident::KEY + } + } + }) +} + +#[proc_macro_derive(KeyValue)] +pub fn key_value(input: proc_macro::TokenStream) -> proc_macro::TokenStream { + derive(input, key_value_impl) +} + +fn key_value_impl(input: DeriveInput) -> syn::Result { + let ident = input.ident; + Ok(quote! { + #[automatically_derived] + impl From<&#ident> for opentelemetry::KeyValue { + fn from(value: &#ident) -> Self { + Self::new(value, value) + } + } + + #[automatically_derived] + impl From<#ident> for opentelemetry::KeyValue { + fn from(value: #ident) -> Self { + Self::from(&value) + } + } + }) +} + +#[proc_macro_derive(StringValue)] +pub fn string_value(input: proc_macro::TokenStream) -> proc_macro::TokenStream { + derive(input, string_value_impl) +} + +fn string_value_impl(input: DeriveInput) -> syn::Result { + let ident = input.ident; + Ok(quote! { + const _: () = { + struct AssertToString where #ident: ToString; + }; + + #[automatically_derived] + impl From<&#ident> for opentelemetry::StringValue { + fn from(value: &#ident) -> Self { + value.to_string().into() + } + } + + #[automatically_derived] + impl From<#ident> for opentelemetry::StringValue { + fn from(value: #ident) -> Self { + Self::from(&value) + } + } + }) +} + +#[proc_macro_derive(Value, attributes(otel))] +pub fn value(input: proc_macro::TokenStream) -> proc_macro::TokenStream { + derive(input, value_impl) +} + +fn value_impl(input: DeriveInput) -> syn::Result { + let options = Options::, Path>::from_derive_input(&input)?; + let ident = input.ident; + let variant = options.variant; + Ok(quote! { + #[automatically_derived] + impl From<&#ident> for opentelemetry::Value { + fn from(value: &#ident) -> Self { + #variant::from(value).into() + } + } + + #[automatically_derived] + impl From<#ident> for opentelemetry::Value { + fn from(value: #ident) -> Self { + Self::from(&value) + } + } + }) +} + +fn derive( + input: proc_macro::TokenStream, + f: fn(DeriveInput) -> syn::Result, +) -> proc_macro::TokenStream { + let input = parse_macro_input!(input as DeriveInput); + f(input) + .unwrap_or_else(syn::Error::into_compile_error) + .into() +} diff --git a/opentelemetry-derive/src/lib.rs b/opentelemetry-derive/src/lib.rs new file mode 100644 index 00000000..5f75f192 --- /dev/null +++ b/opentelemetry-derive/src/lib.rs @@ -0,0 +1,286 @@ +//! # Usage +//! +//! Add the crate to your `Cargo.toml`: +//! +//! ```toml +//! opentelemetry_derive = "0.1" +//! ``` +//! +//! You also need to have `opentelemetry` as a dependency, because the macros will generate code +//! that references `opentelemetry::{Key, KeyValue, StringValue, Value}`. The version does not +//! matter as long as it publishes those types. +//! +//! ## `Key` +//! +//! If you do not set the key explicitly, the macro will autogenerate one, +//! which will be your type's name, lowercased: +//! +//! ```rust +//! use opentelemetry_derive::Key; +//! +//! #[derive(Key)] +//! struct Auto; +//! +//! #[derive(Key)] +//! #[otel(key = "custom")] +//! struct Overriden; +//! ``` +//! +//! ## `Value` +//! +//! You must specify an intermediate type, into which your own type will be converted, +//! that is itself already convertible into a [Value]: +//! +//! ```rust +//! use opentelemetry_derive::Value; +//! +//! #[derive(Value)] +//! #[otel(variant = i64)] +//! struct Counter { +//! count: i64, +//! } +//! +//! impl From<&Counter> for i64 { +//! fn from(value: &Counter) -> Self { +//! value.count +//! } +//! } +//! ``` +//! +//! ## `StringValue` +//! +//! Your type must implement [ToString] (probably through [Display](std::fmt::Display)): +//! +//! ```rust +//! use std::fmt; +//! +//! use opentelemetry_derive::StringValue; +//! +//! #[derive(StringValue)] +//! enum Method { +//! Get, +//! Post, +//! } +//! +//! impl fmt::Display for Method { +//! fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { +//! write!( +//! f, +//! "{}", +//! match self { +//! Self::Get => "get", +//! Self::Post => "post", +//! } +//! ) +//! } +//! } +//! ``` +//! +//! ## `KeyValue` +//! +//! References to your type must be both `Into` and `Into`: +//! +//! ```rust +//! use opentelemetry::{Key, Value}; +//! use opentelemetry_derive::KeyValue; +//! +//! #[derive(KeyValue)] +//! struct Config { +//! value: bool, +//! } +//! +//! const KEY: &str = "config"; +//! +//! impl From<&Config> for Key { +//! fn from(_: &Config) -> Self { +//! Self::from(KEY) +//! } +//! } +//! +//! impl From<&Config> for Value { +//! fn from(value: &Config) -> Self { +//! Value::from(value.value) +//! } +//! } +//! ``` +//! +//! Of course you can combine all the derives instead of manually implementing the required conversions: +//! +//! ```rust +//! use std::fmt; +//! +//! use opentelemetry::StringValue; +//! use opentelemetry_derive::{Key, KeyValue, StringValue, Value}; +//! +//! #[derive(Key, KeyValue, StringValue, Value)] +//! #[otel(key = "req", variant = StringValue)] +//! struct Request { +//! query: String, +//! } +//! +//! impl fmt::Display for Request { +//! fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { +//! write!(f, "{}", self.query) +//! } +//! } +//! ``` +//! +//! [Value]: https://docs.rs/opentelemetry/latest/opentelemetry/enum.Value.html + +/// Derive conversion into [Key]. +/// +/// The optional `key` attribute overrides the autogenerated key (type name, lowercased). +/// +/// [Key]: https://docs.rs/opentelemetry/latest/opentelemetry/struct.Key.html +pub use opentelemetry_derive_impl::Key; + +/// Derive conversion into [KeyValue]. +/// +/// [KeyValue]: https://docs.rs/opentelemetry/latest/opentelemetry/struct.KeyValue.html +pub use opentelemetry_derive_impl::KeyValue; + +/// Derive conversion into [StringValue]. +/// +/// [StringValue]: https://docs.rs/opentelemetry/latest/opentelemetry/struct.StringValue.html +pub use opentelemetry_derive_impl::StringValue; + +/// Derive conversion into [Value]. +/// +/// The mandatory `variant` attribute is the intermediate type, into which your value will be converted +/// (e.g. [StringValue] +/// if your type should be represented as a string, or [i64]). +/// This variant should itself be one of the types than can be implicitly converted to [Value]. +/// +/// [StringValue]: https://docs.rs/opentelemetry/latest/opentelemetry/struct.StringValue.html +/// [Value]: https://docs.rs/opentelemetry/latest/opentelemetry/enum.Value.html +pub use opentelemetry_derive_impl::Value; + +#[cfg(test)] +mod tests { + extern crate self as opentelemetry_derive; + + use std::fmt; + + use opentelemetry::{Key, KeyValue, StringValue, Value}; + + use crate::{Key, KeyValue, StringValue, Value}; + + #[test] + fn test_key() { + #[derive(Key)] + struct Auto; + + assert_eq!(Key::from(Auto).as_str(), "auto"); + assert_eq!(Key::from(&Auto).as_str(), "auto"); + + #[derive(Key)] + #[otel(key = "custom")] + struct Overriden; + + assert_eq!(Key::from(Overriden).as_str(), "custom"); + assert_eq!(Key::from(&Overriden).as_str(), "custom"); + } + + #[test] + fn test_value() { + #[derive(Value)] + #[otel(variant = i64)] + struct Counter { + count: i64, + } + + impl From<&Counter> for i64 { + fn from(value: &Counter) -> Self { + value.count + } + } + + let count = 3; + let counter = Counter { count }; + + assert_eq!(Value::from(&counter).as_str(), count.to_string()); + assert_eq!(Value::from(counter).as_str(), count.to_string()); + } + + #[test] + fn test_string_value() { + #[derive(StringValue)] + enum Method { + Get, + Post, + } + + impl fmt::Display for Method { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!( + f, + "{}", + match self { + Self::Get => "get", + Self::Post => "post", + } + ) + } + } + + assert_eq!( + StringValue::from(&Method::Get).as_str(), + Method::Get.to_string() + ); + assert_eq!( + StringValue::from(Method::Post).as_str(), + Method::Post.to_string() + ); + } + + #[test] + fn test_key_value() { + #[derive(KeyValue)] + struct Config { + value: bool, + } + + const KEY: &str = "config"; + + impl From<&Config> for Key { + fn from(_: &Config) -> Self { + Self::from(KEY) + } + } + + impl From<&Config> for Value { + fn from(value: &Config) -> Self { + Value::from(value.value) + } + } + + let value = true; + let config = Config { value }; + + assert_eq!(KeyValue::from(&config), KeyValue::new(KEY, value)); + assert_eq!(KeyValue::from(config), KeyValue::new(KEY, value)); + } + + #[test] + fn test_all() { + #[derive(Key, KeyValue, StringValue, Value)] + #[otel(key = "req", variant = StringValue)] + struct Request { + query: String, + } + + impl fmt::Display for Request { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", self.query) + } + } + + let query = "foo=bar"; + let request = Request { + query: query.to_string(), + }; + + assert_eq!(KeyValue::from(&request), KeyValue::new("req", query)); + assert_eq!(KeyValue::from(request), KeyValue::new("req", query)); + } +}