diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml index b86f73555..e5b044764 100644 --- a/.github/workflows/ci-instrumentation.yml +++ b/.github/workflows/ci-instrumentation.yml @@ -45,6 +45,7 @@ jobs: - httpx - koala - lmdb + - logger - net_http - rack - rails diff --git a/.toys/.data/releases.yml b/.toys/.data/releases.yml index a90d626e3..64c87a77f 100644 --- a/.toys/.data/releases.yml +++ b/.toys/.data/releases.yml @@ -30,10 +30,6 @@ commit_lint: # * changelog_path: Path to CHANGLEOG.md relative to the gem directory. # (Required only if it is not in the expected location.) gems: - - name: opentelemetry-instrumentation-gruf - directory: instrumentation/gruf - version_constant: [OpenTelemetry, Instrumentation, Gruf, VERSION] - - name: opentelemetry-helpers-mysql directory: helpers/mysql version_constant: [OpenTelemetry, Helpers, MySQL, VERSION] @@ -47,6 +43,14 @@ gems: directory: instrumentation/grape version_constant: [OpenTelemetry, Instrumentation, Grape, VERSION] + - name: opentelemetry-instrumentation-gruf + directory: instrumentation/gruf + version_constant: [OpenTelemetry, Instrumentation, Gruf, VERSION] + + - name: opentelemetry-instrumentation-logger + directory: instrumentation/logger + version_constant: [OpenTelemetry, Instrumentation, Logger, VERSION] + - name: opentelemetry-instrumentation-racecar directory: instrumentation/racecar version_constant: [OpenTelemetry, Instrumentation, Racecar, VERSION] diff --git a/instrumentation/all/lib/opentelemetry/instrumentation/all.rb b/instrumentation/all/lib/opentelemetry/instrumentation/all.rb index b53195678..9cc6a9e43 100644 --- a/instrumentation/all/lib/opentelemetry/instrumentation/all.rb +++ b/instrumentation/all/lib/opentelemetry/instrumentation/all.rb @@ -4,8 +4,6 @@ # # SPDX-License-Identifier: Apache-2.0 -require 'opentelemetry-instrumentation-gruf' -require 'opentelemetry-instrumentation-trilogy' require 'opentelemetry-instrumentation-active_support' require 'opentelemetry-instrumentation-action_pack' require 'opentelemetry-instrumentation-active_job' @@ -27,7 +25,9 @@ require 'opentelemetry-instrumentation-faraday' require 'opentelemetry-instrumentation-grape' require 'opentelemetry-instrumentation-graphql' +require 'opentelemetry-instrumentation-gruf' require 'opentelemetry-instrumentation-http_client' +require 'opentelemetry-instrumentation-logger' require 'opentelemetry-instrumentation-mongo' require 'opentelemetry-instrumentation-mysql2' require 'opentelemetry-instrumentation-net_http' @@ -44,6 +44,7 @@ require 'opentelemetry-instrumentation-ruby_kafka' require 'opentelemetry-instrumentation-sidekiq' require 'opentelemetry-instrumentation-sinatra' +require 'opentelemetry-instrumentation-trilogy' # OpenTelemetry is an open source observability framework, providing a # general-purpose API, SDK, and related tools required for the instrumentation diff --git a/instrumentation/all/opentelemetry-instrumentation-all.gemspec b/instrumentation/all/opentelemetry-instrumentation-all.gemspec index 54ee07265..05b81314c 100644 --- a/instrumentation/all/opentelemetry-instrumentation-all.gemspec +++ b/instrumentation/all/opentelemetry-instrumentation-all.gemspec @@ -43,6 +43,7 @@ Gem::Specification.new do |spec| spec.add_dependency 'opentelemetry-instrumentation-http_client', '~> 0.22.1' spec.add_dependency 'opentelemetry-instrumentation-koala', '~> 0.20.1' spec.add_dependency 'opentelemetry-instrumentation-lmdb', '~> 0.22.1' + spec.add_dependency 'opentelemetry-instrumentation-logger', '~> 0.0.0' spec.add_dependency 'opentelemetry-instrumentation-mongo', '~> 0.22.1' spec.add_dependency 'opentelemetry-instrumentation-mysql2', '~> 0.28.0' spec.add_dependency 'opentelemetry-instrumentation-net_http', '~> 0.22.1' diff --git a/instrumentation/logger/.rubocop.yml b/instrumentation/logger/.rubocop.yml new file mode 100644 index 000000000..1248a2f82 --- /dev/null +++ b/instrumentation/logger/.rubocop.yml @@ -0,0 +1 @@ +inherit_from: ../../.rubocop.yml diff --git a/instrumentation/logger/.yardopts b/instrumentation/logger/.yardopts new file mode 100644 index 000000000..0d5d21488 --- /dev/null +++ b/instrumentation/logger/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Logger Instrumentation +--markup=markdown +--main=README.md +./lib/opentelemetry/instrumentation/**/*.rb +./lib/opentelemetry/instrumentation.rb +- +README.md +CHANGELOG.md diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals new file mode 100644 index 000000000..80e00d6df --- /dev/null +++ b/instrumentation/logger/Appraisals @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +# # Copyright The OpenTelemetry Authors +# # +# # SPDX-License-Identifier: Apache-2.0 + +# # TOOD: Re-enable before release, along with active_support_logger tests +# # Appraisals wont work with gems installed by a branch, so we can't +# # set this up until there's a release of the otel logs gems +# # Only test Rails versions that are still in support + +# appraise 'rails-7.0' do +# gem 'rails', '~> 7.0.0' +# end + +# appraise 'rails-7.1' do +# gem 'rails', '~> 7.1.0' +# end + +# appraise 'rails-7.2' do +# gem 'rails', '~> 7.2.0' +# end diff --git a/instrumentation/logger/CHANGELOG.md b/instrumentation/logger/CHANGELOG.md new file mode 100644 index 000000000..c62749f18 --- /dev/null +++ b/instrumentation/logger/CHANGELOG.md @@ -0,0 +1 @@ +# Release History: opentelemetry-instrumentation-logger diff --git a/instrumentation/logger/Gemfile b/instrumentation/logger/Gemfile new file mode 100644 index 000000000..82e256731 --- /dev/null +++ b/instrumentation/logger/Gemfile @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +source 'https://rubygems.org' + +### TODO: Ignore the below comment during development, fix before release ### +# DO NOT ADD DEPENDENCIES HERE! +# Please declare a minimum development dependency in the gemspec, +# then target specific versions in the Appraisals file. + +gemspec + +group :test do + gem 'opentelemetry-instrumentation-base', path: '../base' + gem 'opentelemetry-api', git: 'https://github.com/kaylareopelle/opentelemetry-ruby', branch: 'log-record-processor3', glob: 'api/*.gemspec' + gem 'opentelemetry-logs-api', git: 'https://github.com/kaylareopelle/opentelemetry-ruby', branch: 'log-record-processor3', glob: 'logs_api/*.gemspec' + gem 'opentelemetry-logs-sdk', git: 'https://github.com/kaylareopelle/opentelemetry-ruby', branch: 'log-record-processor3', glob: 'logs_sdk/*.gemspec' + gem 'opentelemetry-sdk', git: 'https://github.com/kaylareopelle/opentelemetry-ruby', branch: 'log-record-processor3', glob: 'sdk/*.gemspec' +end + +# Temporary for testing, Appraisal does not work with gems installed from git source +gem 'rails', '~> 7.1.0' diff --git a/instrumentation/logger/LICENSE b/instrumentation/logger/LICENSE new file mode 100644 index 000000000..1ef7dad2c --- /dev/null +++ b/instrumentation/logger/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 The OpenTelemetry Authors + + 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/instrumentation/logger/README.md b/instrumentation/logger/README.md new file mode 100644 index 000000000..819a5b962 --- /dev/null +++ b/instrumentation/logger/README.md @@ -0,0 +1,64 @@ +# OpenTelemetry Logger Instrumentation + +The Logger instrumentation is a community-maintained bridge for the Ruby [logger][logger-home] standard library. + +## How do I get started? + +Install the gem using: + +```shell +gem install opentelemetry-instrumentation-logger +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-logger` in your `Gemfile`. + +## Usage + +To use the instrumentation, call `use` with the name of the instrumentation: + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::Logger' +end +``` + +Alternatively, you can also call `use_all` to install all the available instrumentation. + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use_all +end +``` + +## Examples + +Example usage can be seen in the `./example/logger.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/logger/example/logger.rb) + +## Development + +The test suite leverages [appraisal][appraisal] to verify the integration across multiple Rails versions. To run the tests with appraisal: + +```shell +cd instrumentation/logger +bundle exec appraisal install +bundle exec appraisal rake test +``` + +## How can I get involved? + +The `opentelemetry-instrumentation-logger` gem source is [on github][repo-github], along with related gems including `opentelemetry-logs-api` and `opentelemetry-logs-sdk`. + +The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig]. + +## License + +The `opentelemetry-instrumentation-logger` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. + +[appraisal]: https://github.com/thoughtbot/appraisal +[bundler-home]: https://bundler.io +[logger-home]: https://github.com/ruby/logger +[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby +[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE +[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig +[community-meetings]: https://github.com/open-telemetry/community#community-meetings +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/logger/Rakefile b/instrumentation/logger/Rakefile new file mode 100644 index 000000000..1a64ba842 --- /dev/null +++ b/instrumentation/logger/Rakefile @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/gem_tasks' +require 'rake/testtask' +require 'yard' +require 'rubocop/rake_task' + +RuboCop::RakeTask.new + +Rake::TestTask.new :test do |t| + t.libs << 'test' + t.libs << 'lib' + t.test_files = FileList['test/**/*_test.rb'] +end + +YARD::Rake::YardocTask.new do |t| + t.stats_options = ['--list-undoc'] +end + +if RUBY_ENGINE == 'truffleruby' + task default: %i[test] +else + task default: %i[test rubocop yard] +end diff --git a/instrumentation/logger/example/logger.rb b/instrumentation/logger/example/logger.rb new file mode 100644 index 000000000..59369653c --- /dev/null +++ b/instrumentation/logger/example/logger.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true +# TODO: Test me once the logs API/SDK gems have been released +# Since the gems aren't released, this is broken atm +require 'bundler/inline' + +gemfile(true) do + source 'https://rubygems.org' + + gem 'logger' + gem 'opentelemetry-sdk' + gem 'opentelemetry-logs-api' + gem 'opentelemetry-logs-sdk' + gem 'opentelemetry-instrumentation-logger', path: '../' +end + +require 'opentelemetry-logs-sdk' +require 'opentelemetry-instrumentation-logger' +require 'logger' + +# Don't attempt to export traces, Logger instrumentation only emits logs. +ENV['OTEL_TRACES_EXPORTER'] ||= 'none' + +OpenTelemetry::SDK.configure do |c| + c.use OpenTelemetry::Instrumentation::Logger +end + +at_exit do + OpenTelemetry.logger_provider.shutdown +end + +logger = Logger.new +logger.debug('emerald ash borer') diff --git a/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb b/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb new file mode 100644 index 000000000..c034f140f --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require_relative 'opentelemetry/instrumentation' diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation.rb new file mode 100644 index 000000000..001b363af --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +# OpenTelemetry is an open source observability framework, providing a +# general-purpose API, SDK, and related tools required for the instrumentation +# of cloud-native software, frameworks, and libraries. +# +# The OpenTelemetry module provides global accessors for telemetry objects. +# See the documentation for the `opentelemetry-api` gem for details. +module OpenTelemetry + module Instrumentation + end +end + +require_relative 'instrumentation/logger' diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb new file mode 100644 index 000000000..cdfcfb47c --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'opentelemetry' +require 'opentelemetry-instrumentation-base' + +module OpenTelemetry + module Instrumentation + # Contains the OpenTelemetry instrumentation for the Logger gem + module Logger + NAME = 'opentelemetry-instrumentation-logger' + end + end +end + +require_relative 'logger/instrumentation' +require_relative 'logger/version' diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb new file mode 100644 index 000000000..44fc83d8c --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + # The `OpenTelemetry::Instrumentation::Logger::Instrumentation` class contains logic to detect and install the + # Ruby Logger library instrumentation. + # + # Installation and configuration of this instrumentation is done within the + # {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK#configure-instance_method OpenTelemetry::SDK#configure} + # block, calling {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use use()} + # or {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use_all use_all()}. + # + class Instrumentation < OpenTelemetry::Instrumentation::Base + install do |_config| + require_dependencies + patch + end + + present do + defined?(::Logger) && defined?(::OpenTelemetry::SDK::Logs) + end + + private + + def patch + ::Logger.prepend(Patches::Logger) + active_support_broadcast_logger_patch + active_support_patch + end + + def require_dependencies + require_relative 'patches/logger' + end + + def active_support_patch + return unless defined?(::ActiveSupport::Logger) && !defined?(::ActiveSupport::BroadcastLogger) + + require_relative 'patches/active_support_logger' + ::ActiveSupport::Logger.singleton_class.prepend(Patches::ActiveSupportLogger) + end + + def active_support_broadcast_logger_patch + return unless defined?(::ActiveSupport::BroadcastLogger) + + require_relative 'patches/active_support_broadcast_logger' + ::ActiveSupport::BroadcastLogger.prepend(Patches::ActiveSupportBroadcastLogger) + end + end + end + end +end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger.rb new file mode 100644 index 000000000..c5623ebca --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger.rb @@ -0,0 +1,55 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + module Patches + # Patches for the ActiveSupport::BroadcastLogger class included in Rails 7.1+ + module ActiveSupportBroadcastLogger + def add(*args) + emit_one_broadcast(*args) { super } + end + + def debug(*args) + emit_one_broadcast(*args) { super } + end + + def info(*args) + emit_one_broadcast(*args) { super } + end + + def warn(*args) + emit_one_broadcast(*args) { super } + end + + def error(*args) + emit_one_broadcast(*args) { super } + end + + def fatal(*args) + emit_one_broadcast(*args) { super } + end + + def unknown(*args) + emit_one_broadcast(*args) { super } + end + + private + + # Emit logs from only one of the loggers in the broadcast. + # Set @skip_instrumenting to `true` to the rest of the loggers before emitting the logs. + # Set @skip_instrumenting to `false` after the log is emitted. + def emit_one_broadcast(*args) + broadcasts[1..-1].each { |broadcasted_logger| broadcasted_logger.instance_variable_set(:@skip_instrumenting, true) } + yield + broadcasts.each { |broadcasted_logger| broadcasted_logger.instance_variable_set(:@skip_instrumenting, false) } + end + end + end + end + end +end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb new file mode 100644 index 000000000..7d8bcff1f --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + module Patches + # Patches for the ActiveSupport::Logger class included in Rails + module ActiveSupportLogger + # The ActiveSupport::Logger.broadcast method emits identical logs to + # multiple destinations. This instance variable will prevent the broadcasted + # destinations from generating OpenTelemetry log record objects. + # Available in Rails 7.0 and below + def broadcast(logger) + logger.instance_variable_set(:@skip_instrumenting, true) + super + end + end + end + end + end +end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb new file mode 100644 index 000000000..e6c17ea89 --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -0,0 +1,58 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + module Patches + # Instrumention for methods from Ruby's Logger class + module Logger + attr_writer :skip_instrumenting + + def format_message(severity, datetime, progname, msg) + formatted_message = super(severity, datetime, progname, msg) + return formatted_message if skip_instrumenting? + + OpenTelemetry.logger_provider.logger( + name: OpenTelemetry::Instrumentation::Logger::NAME, + version: OpenTelemetry::Instrumentation::Logger::VERSION + ).on_emit( + severity_text: severity, + severity_number: severity_number(severity), + timestamp: datetime, + body: msg, # New Relic uses formatted_message here. This also helps us with not recording progname, because it is included in the formatted message by default. Which seems more appropriate? + context: OpenTelemetry::Context.current + ) + formatted_message + end + + private + + def skip_instrumenting? + @skip_instrumenting || false + end + + def severity_number(severity) + case severity.downcase + when 'debug' + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_DEBUG + when 'info' + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_INFO + when 'warn' + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_WARN + when 'error' + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_ERROR + when 'fatal' + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_FATAL + else + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_UNSPECIFIED + end + end + end + end + end + end +end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb new file mode 100644 index 000000000..316fc1d14 --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + # TODO: Update me when ready to release + VERSION = '0.0.0' + end + end +end diff --git a/instrumentation/logger/log/development.log b/instrumentation/logger/log/development.log new file mode 100644 index 000000000..e69de29bb diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec new file mode 100644 index 000000000..56de61359 --- /dev/null +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -0,0 +1,50 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +lib = File.expand_path('lib', __dir__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'opentelemetry/instrumentation/logger/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-instrumentation-logger' + spec.version = OpenTelemetry::Instrumentation::Logger::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'Logger instrumentation for the OpenTelemetry framework' + spec.description = 'Logger instrumentation for the OpenTelemetry framework' + spec.homepage = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib' + spec.license = 'Apache-2.0' + + spec.files = Dir.glob('lib/**/*.rb') + + Dir.glob('*.md') + + ['LICENSE', '.yardopts'] + spec.require_paths = ['lib'] + spec.required_ruby_version = '>= 3.0' + + spec.add_dependency 'opentelemetry-api', '~> 1.2' + spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.22' + + spec.add_development_dependency 'appraisal', '~> 2.2.0' + spec.add_development_dependency 'bundler', '~> 2.4' + spec.add_development_dependency 'minitest', '~> 5.0' + spec.add_development_dependency 'opentelemetry-sdk', '~> 1.0' + spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3' + spec.add_development_dependency 'rake', '~> 13.0' + spec.add_development_dependency 'rubocop', '~> 1.62.1' + spec.add_development_dependency 'rubocop-performance', '~> 1.20.2' + spec.add_development_dependency 'simplecov' + spec.add_development_dependency 'webmock', '~> 3.7.6' + spec.add_development_dependency 'yard', '~> 0.9' + spec.add_development_dependency 'yard-doctest', '~> 0.1.6' + + if spec.respond_to?(:metadata) + spec.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}/file/CHANGELOG.md" + spec.metadata['source_code_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/logger' + spec.metadata['bug_tracker_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues' + spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}" + end +end diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/instrumentation_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/instrumentation_test.rb new file mode 100644 index 000000000..36da47604 --- /dev/null +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/instrumentation_test.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../lib/opentelemetry/instrumentation/logger' + +describe OpenTelemetry::Instrumentation::Logger do + let(:instrumentation) { OpenTelemetry::Instrumentation::Logger::Instrumentation.instance } + + it 'has #name' do + _(instrumentation.name).must_equal 'OpenTelemetry::Instrumentation::Logger' + end + + it 'has #version' do + _(instrumentation.version).wont_be_nil + _(instrumentation.version).wont_be_empty + end + + describe '#install' do + it 'accepts argument' do + _(instrumentation.install({})).must_equal(true) + instrumentation.instance_variable_set(:@installed, false) + end + end +end diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger_test.rb new file mode 100644 index 000000000..25e9c2738 --- /dev/null +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger_test.rb @@ -0,0 +1,88 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../../lib/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger' + +describe OpenTelemetry::Instrumentation::Logger::Patches::ActiveSupportBroadcastLogger do + let(:instrumentation) { OpenTelemetry::Instrumentation::Logger::Instrumentation.instance } + let(:logger) { Logger.new(LOG_STREAM) } + let(:logger2) { Logger.new(BROADCASTED_STREAM) } + let(:broadcast) { ActiveSupport::BroadcastLogger.new(logger, logger2) } + + before do + skip unless defined?(::ActiveSupport::BroadcastLogger) + EXPORTER.reset + instrumentation.install + end + + after { instrumentation.instance_variable_set(:@installed, false) } + + describe '#add' do + it 'emits the log to the broadcasted loggers' do + body = "Ground control to Major Tom" + broadcast.add(Logger::DEBUG, body) + + assert_includes(LOG_STREAM.string, body) + assert_includes(BROADCASTED_STREAM.string, body) + end + + it 'emits only one OpenTelemetry log record' do + body = "Wake up, you sleepyhead" + broadcast.add(Logger::DEBUG, body) + log_records = EXPORTER.emitted_log_records + + assert_equal 1, log_records.size + assert_equal 'DEBUG', log_records.first.severity_text + assert_equal body, log_records.first.body + end + end + + describe '#unknown' do + it 'emits the log to the broadcasted loggers' do + body = "I know when to go out" + broadcast.unknown(body) + + assert_includes(LOG_STREAM.string, body) + assert_includes(BROADCASTED_STREAM.string, body) + end + + it 'emits only one OpenTelemetry log record' do + body = "You've got your mother in a whirl" + broadcast.unknown(body) + + log_records = EXPORTER.emitted_log_records + + assert_equal 1, log_records.size + assert_equal 'ANY', log_records.first.severity_text + assert_equal body, log_records.first.body + end + end + + %w[debug info warn error fatal].each do |severity| + describe "##{severity}" do + it 'emits the log to the broadcasted loggers' do + body = "Still don't know what I was waiting for...#{rand(7)}" + broadcast.send(severity.to_sym, body) + + assert_includes(LOG_STREAM.string, body) + assert_includes(BROADCASTED_STREAM.string, body) + end + + it 'emits only one OpenTelemetry log record' do + body = "They pulled in just behind the bridge...#{rand(7)}" + broadcast.send(severity.to_sym, body) + + log_records = EXPORTER.emitted_log_records + + assert_equal 1, log_records.size + assert_equal severity.upcase, log_records.first.severity_text + assert_equal body, log_records.first.body + end + end + end +end diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_logger_test.rb new file mode 100644 index 000000000..9bd96ff3e --- /dev/null +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_logger_test.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../../lib/opentelemetry/instrumentation/logger/patches/active_support_logger' + +describe OpenTelemetry::Instrumentation::Logger::Patches::ActiveSupportLogger do + let(:instrumentation) { OpenTelemetry::Instrumentation::Logger::Instrumentation.instance } + let(:main_logger) { ActiveSupport::Logger.new(LOG_STREAM) } + let(:broadcasted_logger) { ActiveSupport::Logger.new(BROADCASTED_STREAM) } + + before do + skip unless defined?(::ActiveSupport::Logger) && !defined?(::ActiveSupport::BroadcastLogger) + EXPORTER.reset + Rails.logger = main_logger.extend(ActiveSupport::Logger.broadcast(broadcasted_logger)) + instrumentation.install + end + + after { instrumentation.instance_variable_set(:@installed, false) } + + describe '#broadcast' do + it 'emits the log to the Rails.logger' do + msg = "spruce #{rand(6)}" + Rails.logger.debug(msg) + + assert_match(/#{msg}/, LOG_STREAM.string) + end + + it 'emits the broadcasted log' do + msg = "willow #{rand(6)}" + Rails.logger.debug(msg) + + assert_match(/#{msg}/, BROADCASTED_STREAM.string) + end + + it 'records the log record' do + msg = "hemlock #{rand(6)}" + Rails.logger.debug(msg) + log_record = EXPORTER.emitted_log_records.first + + assert_match(/#{msg}/, log_record.body) + end + + it 'does not add @skip_instrumenting to the initial logger' do + refute Rails.logger.instance_variable_defined?(:@skip_instrumenting) + end + + it 'adds @skip_instrumenting to broadcasted loggers' do + assert broadcasted_logger.instance_variable_defined?(:@skip_instrumenting) + end + end +end diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb new file mode 100644 index 000000000..f0c5b9460 --- /dev/null +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../../lib/opentelemetry/instrumentation/logger/patches/logger' + +describe OpenTelemetry::Instrumentation::Logger::Patches::Logger do + let(:instrumentation) { OpenTelemetry::Instrumentation::Logger::Instrumentation.instance } + let(:exporter) { EXPORTER } + let(:log_record) { exporter.emitted_log_records.first } + let(:log_stream) { StringIO.new } + let(:ruby_logger) { Logger.new(log_stream) } + let(:msg) { 'message' } + let(:config) { {} } + + before do + exporter.reset + instrumentation.install(config) + end + + after { instrumentation.instance_variable_set(:@installed, false) } + + describe '#format_message' do + it 'logs the formatted message to the correct source' do + ruby_logger.debug(msg) + assert_match(/DEBUG -- : #{msg}/, log_stream.string) + end + + it 'sets the OTel logger instrumentation name and version (default case)' do + ruby_logger.debug(msg) + assert_equal(OpenTelemetry::Instrumentation::Logger::NAME, log_record.instrumentation_scope.name) + assert_equal(OpenTelemetry::Instrumentation::Logger::VERSION, log_record.instrumentation_scope.version) + end + + it 'sets log record attributes based on the Ruby log' do + timestamp = Time.now + Time.stub(:now, timestamp) do + ruby_logger.debug(msg) + assert_equal(msg, log_record.body) + assert_equal('DEBUG', log_record.severity_text) + assert_equal(5, log_record.severity_number) + assert_equal(timestamp, log_record.timestamp) + end + end + + it 'does not emit when @skip_instrumenting is true' do + ruby_logger.instance_variable_set(:@skip_instrumenting, true) + ruby_logger.debug(msg) + assert_nil(log_record) + end + + it 'turns the severity into a number' do + ruby_logger.debug(msg) + assert_equal(5, log_record.severity_number) + end + + it 'safely handles unknown severity number translations' do + ruby_logger.send(:format_message, 'CUSTOM_SEVERITY', Time.now, nil, msg) + assert_equal(0, log_record.severity_number) + end + end +end diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb new file mode 100644 index 000000000..547f0209f --- /dev/null +++ b/instrumentation/logger/test/test_helper.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'simplecov' +SimpleCov.start do + enable_coverage :branch + add_filter '/test/' +end + +SimpleCov.minimum_coverage 85 + +require 'minitest/autorun' +require 'webmock/minitest' +require 'opentelemetry/sdk/logs' +require 'test_helpers/app_config' + +EXPORTER = OpenTelemetry::SDK::Logs::Export::InMemoryLogRecordExporter.new +log_record_processor = OpenTelemetry::SDK::Logs::Export::SimpleLogRecordProcessor.new(EXPORTER) +LOG_STREAM = StringIO.new +BROADCASTED_STREAM = StringIO.new + +OpenTelemetry::SDK.configure do |c| + c.error_handler = ->(exception:, message:) { raise(exception || message) } + c.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym) + c.add_log_record_processor log_record_processor +end + +# Create a globally available Rails app, this should be used in test unless +# specifically testing behaviour with different initialization configs. +DEFAULT_RAILS_APP = AppConfig.initialize_app +Rails.application = DEFAULT_RAILS_APP diff --git a/instrumentation/logger/test/test_helpers/app_config.rb b/instrumentation/logger/test/test_helpers/app_config.rb new file mode 100644 index 000000000..710c6de61 --- /dev/null +++ b/instrumentation/logger/test/test_helpers/app_config.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +class Application < Rails::Application; end +require 'action_controller/railtie' + +module AppConfig + extend self + + def initialize_app(use_exceptions_app: false, remove_rack_tracer_middleware: false) + app = Application.new + app.config.secret_key_base = 'secret_key_base' + + # Ensure we don't see this Rails warning when testing + app.config.eager_load = false + app.config.enable_reloading = false + + # Prevent tests from creating log/*.log + level = ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym + app.config.logger = ActiveSupport::Logger.new(LOG_STREAM, level: level) + app.config.log_level = level + app.config.filter_parameters = [:param_to_be_filtered] + app.config.load_defaults([Rails::VERSION::MAJOR, Rails::VERSION::MINOR].compact.join('.')) + + app.initialize! + + app + end +end