From ec2c1924617aba1fe84e2b165e3f197207031e8e Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 19 Sep 2023 08:37:52 -0700 Subject: [PATCH 01/47] WIP initial commit logger instrumentation --- .../workflows/ci-instrumentation-canary.yml | 1 + .github/workflows/ci-instrumentation.yml | 1 + .toys/.data/releases.yml | 4 + .../lib/opentelemetry/instrumentation/all.rb | 1 + .../opentelemetry-instrumentation-all.gemspec | 1 + instrumentation/logger/.rubocop.yml | 1 + instrumentation/logger/.yardopts | 9 + instrumentation/logger/Appraisals | 16 ++ instrumentation/logger/CHANGELOG.md | 1 + instrumentation/logger/Gemfile | 17 ++ instrumentation/logger/LICENSE | 201 ++++++++++++++++++ instrumentation/logger/README.md | 52 +++++ instrumentation/logger/Rakefile | 28 +++ .../opentelemetry-instrumentation-logger.rb | 7 + .../lib/opentelemetry/instrumentation.rb | 19 ++ .../opentelemetry/instrumentation/logger.rb | 19 ++ .../instrumentation/logger/instrumentation.rb | 35 +++ .../instrumentation/logger/patches/logger.rb | 42 ++++ .../instrumentation/logger/version.rb | 13 ++ ...entelemetry-instrumentation-logger.gemspec | 49 +++++ .../logger/instrumentation_test.rb | 29 +++ instrumentation/logger/test/test_helper.rb | 21 ++ 22 files changed, 567 insertions(+) create mode 100644 instrumentation/logger/.rubocop.yml create mode 100644 instrumentation/logger/.yardopts create mode 100644 instrumentation/logger/Appraisals create mode 100644 instrumentation/logger/CHANGELOG.md create mode 100644 instrumentation/logger/Gemfile create mode 100644 instrumentation/logger/LICENSE create mode 100644 instrumentation/logger/README.md create mode 100644 instrumentation/logger/Rakefile create mode 100644 instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation.rb create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb create mode 100644 instrumentation/logger/opentelemetry-instrumentation-logger.gemspec create mode 100644 instrumentation/logger/test/opentelemetry/instrumentation/logger/instrumentation_test.rb create mode 100644 instrumentation/logger/test/test_helper.rb diff --git a/.github/workflows/ci-instrumentation-canary.yml b/.github/workflows/ci-instrumentation-canary.yml index e257bb255..66398b464 100644 --- a/.github/workflows/ci-instrumentation-canary.yml +++ b/.github/workflows/ci-instrumentation-canary.yml @@ -31,6 +31,7 @@ jobs: - http_client - koala - lmdb + - logger - net_http - rack - rails diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml index 0a37533ac..3505b5814 100644 --- a/.github/workflows/ci-instrumentation.yml +++ b/.github/workflows/ci-instrumentation.yml @@ -35,6 +35,7 @@ jobs: - http_client - koala - lmdb + - logger - net_http - rack - rails diff --git a/.toys/.data/releases.yml b/.toys/.data/releases.yml index bf9864f63..4ff0f87c0 100644 --- a/.toys/.data/releases.yml +++ b/.toys/.data/releases.yml @@ -29,6 +29,10 @@ 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-logger + directory: instrumentation/logger + version_constant: [OpenTelemetry, Instrumentation, Logger, VERSION] + - name: opentelemetry-instrumentation-grape directory: instrumentation/grape version_constant: [OpenTelemetry, Instrumentation, Grape, VERSION] diff --git a/instrumentation/all/lib/opentelemetry/instrumentation/all.rb b/instrumentation/all/lib/opentelemetry/instrumentation/all.rb index 54209ec31..bcff976ae 100644 --- a/instrumentation/all/lib/opentelemetry/instrumentation/all.rb +++ b/instrumentation/all/lib/opentelemetry/instrumentation/all.rb @@ -4,6 +4,7 @@ # # SPDX-License-Identifier: Apache-2.0 +require 'opentelemetry-instrumentation-logger' require 'opentelemetry-instrumentation-trilogy' require 'opentelemetry-instrumentation-active_support' require 'opentelemetry-instrumentation-action_pack' diff --git a/instrumentation/all/opentelemetry-instrumentation-all.gemspec b/instrumentation/all/opentelemetry-instrumentation-all.gemspec index 0376672a6..e3b9cd955 100644 --- a/instrumentation/all/opentelemetry-instrumentation-all.gemspec +++ b/instrumentation/all/opentelemetry-instrumentation-all.gemspec @@ -26,6 +26,7 @@ Gem::Specification.new do |spec| spec.require_paths = ['lib'] spec.required_ruby_version = '>= 3.0' + spec.add_dependency 'opentelemetry-instrumentation-logger', '~> 0.0.0' spec.add_dependency 'opentelemetry-instrumentation-active_model_serializers', '~> 0.20.1' spec.add_dependency 'opentelemetry-instrumentation-aws_sdk', '~> 0.4.1' spec.add_dependency 'opentelemetry-instrumentation-bunny', '~> 0.20.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..0ee990962 --- /dev/null +++ b/instrumentation/logger/Appraisals @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +## TODO: Include the supported version to be tested here. +## Example: +# appraise 'rack-2.1' do +# gem 'rack', '~> 2.1.2' +# end + +# appraise 'rack-2.0' do +# gem 'rack', '2.0.8' +# 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..a952c5002 --- /dev/null +++ b/instrumentation/logger/Gemfile @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +source 'https://rubygems.org' + +# 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' +end 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..ef15b2cfd --- /dev/null +++ b/instrumentation/logger/README.md @@ -0,0 +1,52 @@ +# OpenTelemetry Logger Instrumentation + +Todo: Add a description. + +## How do I get started? + +Install the gem using: + +``` +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/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/logger/example/trace_demonstration.rb) + +## How can I get involved? + +The `opentelemetry-instrumentation-logger` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-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. + +[bundler-home]: https://bundler.io +[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/lib/opentelemetry-instrumentation-logger.rb b/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb new file mode 100644 index 000000000..baceb3cb7 --- /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..56bc743f7 --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation.rb @@ -0,0 +1,19 @@ +# 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 + # Instrumentation should be able to handle the case when the library is not installed on a user's system. + 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..9ef4a5edb --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb @@ -0,0 +1,19 @@ +# 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 + 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..6e108fc04 --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + # The Instrumentation class contains logic to detect and install the Logger instrumentation + class Instrumentation < OpenTelemetry::Instrumentation::Base + install do |_config| + require_dependencies + patch + end + + present do + defined?(Logger) + end + + # option :name, default: 'default', validate: :validation + + private + + def patch + ::Logger.prepend(Patches::Logger) + end + + def require_dependencies + require_relative 'patches/logger' + 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..09c8df0d3 --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -0,0 +1,42 @@ +# 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 + # TODO: Make sure OTel logs aren't instrumented + # TODO: How to pass attributes? + + def format_message(severity, datetime, progname, msg) + formatted_message = super(severity, datetime, progname, msg) + + return formatted_message if instance_variable_get(:@skip_instrumenting) == true + + # TODO: Is there another way I can find the logger that's more + # similar to how the tracers are found/set? + OpenTelemetry.logger_provider.logger( + severity_text: severity, + severity_number: ::Logger::Severity.const_get(severity), + timestamp: datetime, + body: formatted_message + ) + end + + private + + def instrumentation_config; end + + def logger + Logger::Instrumentation.instance.logger + 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..8e0b8e97b --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Logger + VERSION = '0.0.0' + end + end +end diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec new file mode 100644 index 000000000..12d352d92 --- /dev/null +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -0,0 +1,49 @@ +# 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.2' + spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.22.1' + + 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.48.1' + spec.add_development_dependency 'simplecov', '~> 0.17.1' + 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/test_helper.rb b/instrumentation/logger/test/test_helper.rb new file mode 100644 index 000000000..aa05118d1 --- /dev/null +++ b/instrumentation/logger/test/test_helper.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'minitest/autorun' +require 'webmock/minitest' + +# global opentelemetry-sdk setup: +EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new +span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER) + +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_span_processor span_processor +end From f4add6249fc7eacbc2b792ee4a734b5a20aafd4c Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 09:58:19 -0700 Subject: [PATCH 02/47] Rubocop require_relative --- .../logger/lib/opentelemetry/instrumentation/logger.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb index 9ef4a5edb..b23717e34 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb @@ -15,5 +15,5 @@ module Logger end end -require_relative './logger/instrumentation' -require_relative './logger/version' +require_relative 'logger/instrumentation' +require_relative 'logger/version' From 456d25bcc855d1bc731879f6df809e9b8d8752cb Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 09:58:45 -0700 Subject: [PATCH 03/47] Add :: to find Ruby logger instead of OTel logger --- .../lib/opentelemetry/instrumentation/logger/instrumentation.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index 6e108fc04..ac23c3e9c 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -15,7 +15,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base end present do - defined?(Logger) + defined?(::Logger) end # option :name, default: 'default', validate: :validation From e39763a91ee2dd68b2a637156098b313a652637d Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 09:59:08 -0700 Subject: [PATCH 04/47] Remove commented out option LOC --- .../lib/opentelemetry/instrumentation/logger/instrumentation.rb | 2 -- 1 file changed, 2 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index ac23c3e9c..984c810ab 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -18,8 +18,6 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base defined?(::Logger) end - # option :name, default: 'default', validate: :validation - private def patch From 976f32945cd7d4f79b6461cfaac20c055c75b30f Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 10:03:08 -0700 Subject: [PATCH 05/47] Add skip_instrumenting? method --- .../opentelemetry/instrumentation/logger/patches/logger.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 09c8df0d3..2c0f22142 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -15,6 +15,7 @@ module Logger def format_message(severity, datetime, progname, msg) formatted_message = super(severity, datetime, progname, msg) + return formatted_message if skip_instrumenting? return formatted_message if instance_variable_get(:@skip_instrumenting) == true @@ -32,8 +33,8 @@ def format_message(severity, datetime, progname, msg) def instrumentation_config; end - def logger - Logger::Instrumentation.instance.logger + def skip_instrumenting? + instance_variable_get(:@skip_instrumenting) end end end From ffd3fc54e3609ecb5afa449be42e93c466c973e3 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 10:03:30 -0700 Subject: [PATCH 06/47] Skip ActiveSupport::Logger#broadcast loggers --- .../instrumentation/logger/instrumentation.rb | 8 +++++++ .../logger/patches/active_support_logger.rb | 24 +++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index 984c810ab..f87eef44a 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -22,11 +22,19 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base def patch ::Logger.prepend(Patches::Logger) + active_support_patch end def require_dependencies require_relative 'patches/logger' end + + def active_support_patch + return unless defined?(::ActiveSupport::Logger) + + require_relative 'patches/active_support_logger' + ::ActiveSupport::Logger.singleton_class.prepend(Patches::ActiveSupportLogger) + 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..5efcdc866 --- /dev/null +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb @@ -0,0 +1,24 @@ +# 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. + def broadcast(logger) + logger.instance_variable_set(:@skip_instrumenting, true) + super + end + end + end + end + end +end From bf2f99858b083ad9e9679d7120ea95610a825d82 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 10:04:48 -0700 Subject: [PATCH 07/47] Add logger instrumentation library and version --- .../lib/opentelemetry/instrumentation/logger/patches/logger.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 2c0f22142..48ca7e833 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -22,6 +22,9 @@ def format_message(severity, datetime, progname, msg) # TODO: Is there another way I can find the logger that's more # similar to how the tracers are found/set? OpenTelemetry.logger_provider.logger( + 'opentelemetry-instrumentation-logger', + OpenTelemetry::Instrumentation::Logger::VERSION + ).emit( severity_text: severity, severity_number: ::Logger::Severity.const_get(severity), timestamp: datetime, From 2df26a62953c4e0ff583aa7ddb25173f5917f0dc Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 25 Sep 2023 10:05:40 -0700 Subject: [PATCH 08/47] Update severity_number logic, return orig value --- .../instrumentation/logger/patches/logger.rb | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 48ca7e833..78dd7c78d 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -12,24 +12,21 @@ module Patches module Logger # TODO: Make sure OTel logs aren't instrumented # TODO: How to pass attributes? - def format_message(severity, datetime, progname, msg) formatted_message = super(severity, datetime, progname, msg) return formatted_message if skip_instrumenting? - return formatted_message if instance_variable_get(:@skip_instrumenting) == true - - # TODO: Is there another way I can find the logger that's more - # similar to how the tracers are found/set? OpenTelemetry.logger_provider.logger( 'opentelemetry-instrumentation-logger', OpenTelemetry::Instrumentation::Logger::VERSION ).emit( severity_text: severity, - severity_number: ::Logger::Severity.const_get(severity), + severity_number: severity_number(severity), timestamp: datetime, body: formatted_message ) + + formatted_message end private @@ -39,6 +36,13 @@ def instrumentation_config; end def skip_instrumenting? instance_variable_get(:@skip_instrumenting) end + + def severity_number(severity) + ::Logger::Severity.const_get(severity) + rescue NameError => e + OpenTelemetry.handle_error(message: "Unable to coerce severity text #{severity} into severity_number. Setting severity_number to nil.", exception: e) + nil + end end end end From b0ab18f51c2b057c04637082f779b81ff4d411c6 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 3 Oct 2023 14:27:59 -0700 Subject: [PATCH 09/47] Make instrumentation name a constant --- .../logger/lib/opentelemetry/instrumentation/logger.rb | 1 + .../lib/opentelemetry/instrumentation/logger/patches/logger.rb | 2 +- .../logger/opentelemetry-instrumentation-logger.gemspec | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb index b23717e34..cdfcfb47c 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb @@ -11,6 +11,7 @@ module OpenTelemetry module Instrumentation # Contains the OpenTelemetry instrumentation for the Logger gem module Logger + NAME = 'opentelemetry-instrumentation-logger' 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 index 78dd7c78d..9e6a82229 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -17,7 +17,7 @@ def format_message(severity, datetime, progname, msg) return formatted_message if skip_instrumenting? OpenTelemetry.logger_provider.logger( - 'opentelemetry-instrumentation-logger', + OpenTelemetry::Instrumentation::Logger::NAME, OpenTelemetry::Instrumentation::Logger::VERSION ).emit( severity_text: severity, diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec index 12d352d92..8d6581334 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -6,10 +6,11 @@ lib = File.expand_path('lib', __dir__) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'opentelemetry/instrumentation/logger' require 'opentelemetry/instrumentation/logger/version' Gem::Specification.new do |spec| - spec.name = 'opentelemetry-instrumentation-logger' + spec.name = OpenTelemetry::Instrumentation::Logger::NAME spec.version = OpenTelemetry::Instrumentation::Logger::VERSION spec.authors = ['OpenTelemetry Authors'] spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] From 595ecc57b9a15d22565e511a8e04f3fa4108a099 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 3 Oct 2023 14:28:09 -0700 Subject: [PATCH 10/47] WIP test active support logger --- instrumentation/logger/Appraisals | 17 ++-- instrumentation/logger/Gemfile | 4 + .../instrumentation/logger/patches/logger.rb | 4 +- instrumentation/logger/log/development.log | 0 ...entelemetry-instrumentation-logger.gemspec | 2 +- .../patches/active_support_logger_test.rb | 37 +++++++ .../logger/patches/logger_test.rb | 66 +++++++++++++ instrumentation/logger/test/test_helper.rb | 23 ++++- .../logger/test/test_helpers/app_config.rb | 98 +++++++++++++++++++ 9 files changed, 236 insertions(+), 15 deletions(-) create mode 100644 instrumentation/logger/log/development.log create mode 100644 instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_logger_test.rb create mode 100644 instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb create mode 100644 instrumentation/logger/test/test_helpers/app_config.rb diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals index 0ee990962..03f29edc9 100644 --- a/instrumentation/logger/Appraisals +++ b/instrumentation/logger/Appraisals @@ -4,13 +4,14 @@ # # SPDX-License-Identifier: Apache-2.0 -## TODO: Include the supported version to be tested here. -## Example: -# appraise 'rack-2.1' do -# gem 'rack', '~> 2.1.2' -# end +appraise 'rails-6.0' do + gem 'rails', '~> 6.0.0' +end -# appraise 'rack-2.0' do -# gem 'rack', '2.0.8' -# end +appraise 'rails-6.1' do + gem 'rails', '~> 6.1.0' +end +appraise 'rails-7.0' do + gem 'rails', '~> 7.0.0' +end diff --git a/instrumentation/logger/Gemfile b/instrumentation/logger/Gemfile index a952c5002..af1ac79fe 100644 --- a/instrumentation/logger/Gemfile +++ b/instrumentation/logger/Gemfile @@ -14,4 +14,8 @@ gemspec group :test do gem 'opentelemetry-instrumentation-base', path: '../base' + gem 'opentelemetry-api', path: '/Users/kreopelle/dev/opentelemetry-ruby/api' + gem 'opentelemetry-logs-api', path: '/Users/kreopelle/dev/opentelemetry-ruby/logs_api' + gem 'opentelemetry-logs-sdk', path: '/Users/kreopelle/dev/opentelemetry-ruby/logs_sdk' + gem 'opentelemetry-sdk', path: '/Users/kreopelle/dev/opentelemetry-ruby/sdk' end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 9e6a82229..b1a46e45b 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -23,7 +23,7 @@ def format_message(severity, datetime, progname, msg) severity_text: severity, severity_number: severity_number(severity), timestamp: datetime, - body: formatted_message + 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? ) formatted_message @@ -40,7 +40,7 @@ def skip_instrumenting? def severity_number(severity) ::Logger::Severity.const_get(severity) rescue NameError => e - OpenTelemetry.handle_error(message: "Unable to coerce severity text #{severity} into severity_number. Setting severity_number to nil.", exception: e) + OpenTelemetry.logger.warn(message: "Unable to coerce severity text #{severity} into severity_number. Setting severity_number to nil.", exception: e) nil 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 index 8d6581334..44280e52c 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -36,7 +36,7 @@ Gem::Specification.new do |spec| spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3' spec.add_development_dependency 'rake', '~> 13.0' spec.add_development_dependency 'rubocop', '~> 1.48.1' - spec.add_development_dependency 'simplecov', '~> 0.17.1' + 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' 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..37f7f10db --- /dev/null +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_logger_test.rb @@ -0,0 +1,37 @@ +# 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(:exporter) { EXPORTER } + let(:log_record) { exporter.emitted_log_records.first } + let(:rails_logger) { Rails.logger } + let(:log_stream) { LOG_STREAM } + # let(:ruby_logger) { Logger.new(log_stream) } + let(:msg) { 'message' } + + before do + exporter.reset + instrumentation.install + end + + after { instrumentation.instance_variable_set(:@installed, false) } + + describe '#broadcast' do + it 'adds @skip_instrumenting to broadcasted loggers' do + rails_logger.debug(msg) + assert_match(/DEBUG -- : #{msg}/, log_stream.string) + end + + it 'does not add @skip_instrumenting to the initial logger' do + + 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..c03053d06 --- /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' } + + before do + exporter.reset + instrumentation.install + 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' 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(0, 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 + assert_equal(Logger::Severity::DEBUG, 0) + ruby_logger.debug(msg) + assert_equal(0, 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_nil(log_record.severity_number) + end + end +end diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb index aa05118d1..cc7badfb5 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -7,15 +7,30 @@ 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' -# global opentelemetry-sdk setup: -EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new -span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER) +EXPORTER = OpenTelemetry::SDK::Logs::Export::InMemoryLogRecordExporter.new +log_record_processor = OpenTelemetry::SDK::Logs::Export::SimpleLogRecordProcessor.new(EXPORTER) +LOG_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_span_processor span_processor + 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..97d5c39d1 --- /dev/null +++ b/instrumentation/logger/test/test_helpers/app_config.rb @@ -0,0 +1,98 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +class Application < Rails::Application; end +require 'action_controller/railtie' +# require_relative 'middlewares' +# require_relative 'controllers' +# require_relative 'routes' + +module AppConfig + extend self + + def initialize_app(use_exceptions_app: false, remove_rack_tracer_middleware: false) + new_app = Application.new + new_app.config.secret_key_base = 'secret_key_base' + + # Ensure we don't see this Rails warning when testing + new_app.config.eager_load = false + + # Prevent tests from creating log/*.log + level = ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym + new_app.config.logger = Logger.new(LOG_STREAM, level: level) + new_app.config.log_level = level + + new_app.config.filter_parameters = [:param_to_be_filtered] + + case Rails.version + when /^6\.0/ + apply_rails_6_0_configs(new_app) + when /^6\.1/ + apply_rails_6_1_configs(new_app) + when /^7\./ + apply_rails_7_configs(new_app) + end + + # remove_rack_middleware(new_app) if remove_rack_tracer_middleware + # add_exceptions_app(new_app) if use_exceptions_app + # add_middlewares(new_app) + + new_app.initialize! + + # draw_routes(new_app) + + new_app + end + + private + + # def remove_rack_middleware(application) + # application.middleware.delete( + # OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware + # ) + # end + + # def add_exceptions_app(application) + # application.config.exceptions_app = lambda do |env| + # ExceptionsController.action(:show).call(env) + # end + # end + + # def add_middlewares(application) + # application.middleware.insert_after( + # ActionDispatch::DebugExceptions, + # ExceptionRaisingMiddleware + # ) + + # application.middleware.insert_after( + # ActionDispatch::DebugExceptions, + # RedirectMiddleware + # ) + # end + + def apply_rails_6_0_configs(application) + # Required in Rails 6 + application.config.hosts << 'example.org' + # Creates a lot of deprecation warnings on subsequent app initializations if not explicitly set. + application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION + end + + def apply_rails_6_1_configs(application) + # Required in Rails 6 + application.config.hosts << 'example.org' + end + + def apply_rails_7_configs(application) + # Required in Rails 7 + application.config.hosts << 'example.org' + + # Unfreeze values which may have been frozen on previous initializations. + ActiveSupport::Dependencies.autoload_paths = + ActiveSupport::Dependencies.autoload_paths.dup + ActiveSupport::Dependencies.autoload_once_paths = + ActiveSupport::Dependencies.autoload_once_paths.dup + end +end From 58c82a710815b798db6015c3a1df14ccf07dee99 Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Fri, 29 Mar 2024 14:32:38 +0530 Subject: [PATCH 11/47] Map logger level to OTel level --- .../instrumentation/logger/patches/logger.rb | 19 ++++++++++++++----- .../logger/patches/logger_test.rb | 2 +- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index b1a46e45b..9dbb3bbe2 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -25,7 +25,6 @@ def format_message(severity, datetime, progname, msg) 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? ) - formatted_message end @@ -38,10 +37,20 @@ def skip_instrumenting? end def severity_number(severity) - ::Logger::Severity.const_get(severity) - rescue NameError => e - OpenTelemetry.logger.warn(message: "Unable to coerce severity text #{severity} into severity_number. Setting severity_number to nil.", exception: e) - nil + case severity.downcase + when 'debug' + Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_DEBUG + when 'info' + Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_INFO + when 'warn' + Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_WARN + when 'error' + Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_ERROR + when 'fatal' + Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_FATAL + else + Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_UNSPECIFIED + end 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 index c03053d06..42afe74bf 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -41,7 +41,7 @@ ruby_logger.debug(msg) assert_equal(msg, log_record.body) assert_equal('DEBUG', log_record.severity_text) - assert_equal(0, log_record.severity_number) + assert_equal(5, log_record.severity_number) assert_equal(timestamp, log_record.timestamp) end end From c587212b357e1d70c327e497614c6f31afa92000 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Fri, 29 Mar 2024 16:53:45 -0700 Subject: [PATCH 12/47] Install WIP logs dependencies from git, not local --- instrumentation/logger/Gemfile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/instrumentation/logger/Gemfile b/instrumentation/logger/Gemfile index af1ac79fe..fef6f8723 100644 --- a/instrumentation/logger/Gemfile +++ b/instrumentation/logger/Gemfile @@ -6,6 +6,7 @@ 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. @@ -14,8 +15,8 @@ gemspec group :test do gem 'opentelemetry-instrumentation-base', path: '../base' - gem 'opentelemetry-api', path: '/Users/kreopelle/dev/opentelemetry-ruby/api' - gem 'opentelemetry-logs-api', path: '/Users/kreopelle/dev/opentelemetry-ruby/logs_api' - gem 'opentelemetry-logs-sdk', path: '/Users/kreopelle/dev/opentelemetry-ruby/logs_sdk' - gem 'opentelemetry-sdk', path: '/Users/kreopelle/dev/opentelemetry-ruby/sdk' + 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 From a4e980d164ebd0f3f183a4af8b5cf27bea5698c1 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Fri, 29 Mar 2024 16:53:54 -0700 Subject: [PATCH 13/47] Update rubocop dependencies --- .../logger/opentelemetry-instrumentation-logger.gemspec | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec index 44280e52c..81684138c 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -35,7 +35,8 @@ Gem::Specification.new do |spec| 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.48.1' + 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' From 4604a96f4118c4c37b4132cec66169ca9fb3f519 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Fri, 29 Mar 2024 16:56:40 -0700 Subject: [PATCH 14/47] Disable active_support_logger tests Appraisal can't install gems from a git source. Since the appraisal is only necessary for active_support_logger, disable those tests while working on other features. --- instrumentation/logger/Appraisals | 27 +-- .../patches/active_support_logger_test.rb | 56 ++--- instrumentation/logger/test/test_helper.rb | 5 +- .../logger/test/test_helpers/app_config.rb | 196 +++++++++--------- 4 files changed, 143 insertions(+), 141 deletions(-) diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals index 03f29edc9..eeea916f0 100644 --- a/instrumentation/logger/Appraisals +++ b/instrumentation/logger/Appraisals @@ -1,17 +1,18 @@ -# frozen_string_literal: true +# # frozen_string_literal: true -# Copyright The OpenTelemetry Authors -# -# SPDX-License-Identifier: Apache-2.0 +# # Copyright The OpenTelemetry Authors +# # +# # SPDX-License-Identifier: Apache-2.0 -appraise 'rails-6.0' do - gem 'rails', '~> 6.0.0' -end +# # TOOD: Re-enable before release, along with active_support_logger tests +# appraise 'rails-6.0' do +# gem 'rails', '~> 6.0.0' +# end -appraise 'rails-6.1' do - gem 'rails', '~> 6.1.0' -end +# appraise 'rails-6.1' do +# gem 'rails', '~> 6.1.0' +# end -appraise 'rails-7.0' do - gem 'rails', '~> 7.0.0' -end +# appraise 'rails-7.0' do +# gem 'rails', '~> 7.0.0' +# 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 index 37f7f10db..16394cf80 100644 --- 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 @@ -1,37 +1,37 @@ -# frozen_string_literal: true +# # frozen_string_literal: true -# Copyright The OpenTelemetry Authors -# -# SPDX-License-Identifier: Apache-2.0 +# # Copyright The OpenTelemetry Authors +# # +# # SPDX-License-Identifier: Apache-2.0 -require 'test_helper' +# require 'test_helper' -require_relative '../../../../../lib/opentelemetry/instrumentation/logger/patches/active_support_logger' +# 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(:exporter) { EXPORTER } - let(:log_record) { exporter.emitted_log_records.first } - let(:rails_logger) { Rails.logger } - let(:log_stream) { LOG_STREAM } - # let(:ruby_logger) { Logger.new(log_stream) } - let(:msg) { 'message' } +# describe OpenTelemetry::Instrumentation::Logger::Patches::ActiveSupportLogger do +# let(:instrumentation) { OpenTelemetry::Instrumentation::Logger::Instrumentation.instance } +# let(:exporter) { EXPORTER } +# let(:log_record) { exporter.emitted_log_records.first } +# let(:rails_logger) { Rails.logger } +# let(:log_stream) { LOG_STREAM } +# # let(:ruby_logger) { Logger.new(log_stream) } +# let(:msg) { 'message' } - before do - exporter.reset - instrumentation.install - end +# before do +# exporter.reset +# instrumentation.install +# end - after { instrumentation.instance_variable_set(:@installed, false) } +# after { instrumentation.instance_variable_set(:@installed, false) } - describe '#broadcast' do - it 'adds @skip_instrumenting to broadcasted loggers' do - rails_logger.debug(msg) - assert_match(/DEBUG -- : #{msg}/, log_stream.string) - end +# describe '#broadcast' do +# it 'adds @skip_instrumenting to broadcasted loggers' do +# rails_logger.debug(msg) +# assert_match(/DEBUG -- : #{msg}/, log_stream.string) +# end - it 'does not add @skip_instrumenting to the initial logger' do +# it 'does not add @skip_instrumenting to the initial logger' do - end - end -end +# end +# end +# end diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb index cc7badfb5..b293cf054 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -30,7 +30,8 @@ c.add_log_record_processor log_record_processor end +# TODO: Re-enable Rails app and active_support_logger testing # 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 +# 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 index 97d5c39d1..914137614 100644 --- a/instrumentation/logger/test/test_helpers/app_config.rb +++ b/instrumentation/logger/test/test_helpers/app_config.rb @@ -1,98 +1,98 @@ -# frozen_string_literal: true - -# Copyright The OpenTelemetry Authors -# -# SPDX-License-Identifier: Apache-2.0 - -class Application < Rails::Application; end -require 'action_controller/railtie' -# require_relative 'middlewares' -# require_relative 'controllers' -# require_relative 'routes' - -module AppConfig - extend self - - def initialize_app(use_exceptions_app: false, remove_rack_tracer_middleware: false) - new_app = Application.new - new_app.config.secret_key_base = 'secret_key_base' - - # Ensure we don't see this Rails warning when testing - new_app.config.eager_load = false - - # Prevent tests from creating log/*.log - level = ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym - new_app.config.logger = Logger.new(LOG_STREAM, level: level) - new_app.config.log_level = level - - new_app.config.filter_parameters = [:param_to_be_filtered] - - case Rails.version - when /^6\.0/ - apply_rails_6_0_configs(new_app) - when /^6\.1/ - apply_rails_6_1_configs(new_app) - when /^7\./ - apply_rails_7_configs(new_app) - end - - # remove_rack_middleware(new_app) if remove_rack_tracer_middleware - # add_exceptions_app(new_app) if use_exceptions_app - # add_middlewares(new_app) - - new_app.initialize! - - # draw_routes(new_app) - - new_app - end - - private - - # def remove_rack_middleware(application) - # application.middleware.delete( - # OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware - # ) - # end - - # def add_exceptions_app(application) - # application.config.exceptions_app = lambda do |env| - # ExceptionsController.action(:show).call(env) - # end - # end - - # def add_middlewares(application) - # application.middleware.insert_after( - # ActionDispatch::DebugExceptions, - # ExceptionRaisingMiddleware - # ) - - # application.middleware.insert_after( - # ActionDispatch::DebugExceptions, - # RedirectMiddleware - # ) - # end - - def apply_rails_6_0_configs(application) - # Required in Rails 6 - application.config.hosts << 'example.org' - # Creates a lot of deprecation warnings on subsequent app initializations if not explicitly set. - application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION - end - - def apply_rails_6_1_configs(application) - # Required in Rails 6 - application.config.hosts << 'example.org' - end - - def apply_rails_7_configs(application) - # Required in Rails 7 - application.config.hosts << 'example.org' - - # Unfreeze values which may have been frozen on previous initializations. - ActiveSupport::Dependencies.autoload_paths = - ActiveSupport::Dependencies.autoload_paths.dup - ActiveSupport::Dependencies.autoload_once_paths = - ActiveSupport::Dependencies.autoload_once_paths.dup - end -end +# # frozen_string_literal: true + +# # Copyright The OpenTelemetry Authors +# # +# # SPDX-License-Identifier: Apache-2.0 + +# class Application < Rails::Application; end +# require 'action_controller/railtie' +# # require_relative 'middlewares' +# # require_relative 'controllers' +# # require_relative 'routes' + +# module AppConfig +# extend self + +# def initialize_app(use_exceptions_app: false, remove_rack_tracer_middleware: false) +# new_app = Application.new +# new_app.config.secret_key_base = 'secret_key_base' + +# # Ensure we don't see this Rails warning when testing +# new_app.config.eager_load = false + +# # Prevent tests from creating log/*.log +# level = ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym +# new_app.config.logger = Logger.new(LOG_STREAM, level: level) +# new_app.config.log_level = level + +# new_app.config.filter_parameters = [:param_to_be_filtered] + +# case Rails.version +# when /^6\.0/ +# apply_rails_6_0_configs(new_app) +# when /^6\.1/ +# apply_rails_6_1_configs(new_app) +# when /^7\./ +# apply_rails_7_configs(new_app) +# end + +# # remove_rack_middleware(new_app) if remove_rack_tracer_middleware +# # add_exceptions_app(new_app) if use_exceptions_app +# # add_middlewares(new_app) + +# new_app.initialize! + +# # draw_routes(new_app) + +# new_app +# end + +# private + +# # def remove_rack_middleware(application) +# # application.middleware.delete( +# # OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware +# # ) +# # end + +# # def add_exceptions_app(application) +# # application.config.exceptions_app = lambda do |env| +# # ExceptionsController.action(:show).call(env) +# # end +# # end + +# # def add_middlewares(application) +# # application.middleware.insert_after( +# # ActionDispatch::DebugExceptions, +# # ExceptionRaisingMiddleware +# # ) + +# # application.middleware.insert_after( +# # ActionDispatch::DebugExceptions, +# # RedirectMiddleware +# # ) +# # end + +# def apply_rails_6_0_configs(application) +# # Required in Rails 6 +# application.config.hosts << 'example.org' +# # Creates a lot of deprecation warnings on subsequent app initializations if not explicitly set. +# application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION +# end + +# def apply_rails_6_1_configs(application) +# # Required in Rails 6 +# application.config.hosts << 'example.org' +# end + +# def apply_rails_7_configs(application) +# # Required in Rails 7 +# application.config.hosts << 'example.org' + +# # Unfreeze values which may have been frozen on previous initializations. +# ActiveSupport::Dependencies.autoload_paths = +# ActiveSupport::Dependencies.autoload_paths.dup +# ActiveSupport::Dependencies.autoload_once_paths = +# ActiveSupport::Dependencies.autoload_once_paths.dup +# end +# end From b8ae0d93b6c3d7068e84929f9f21fad841e852d0 Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Thu, 4 Apr 2024 21:52:01 +0530 Subject: [PATCH 15/47] maps otel log level --- .../instrumentation/logger/patches/logger.rb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 9dbb3bbe2..504583f63 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -17,8 +17,8 @@ def format_message(severity, datetime, progname, msg) return formatted_message if skip_instrumenting? OpenTelemetry.logger_provider.logger( - OpenTelemetry::Instrumentation::Logger::NAME, - OpenTelemetry::Instrumentation::Logger::VERSION + name: OpenTelemetry::Instrumentation::Logger::NAME, + version: OpenTelemetry::Instrumentation::Logger::VERSION ).emit( severity_text: severity, severity_number: severity_number(severity), @@ -39,17 +39,17 @@ def skip_instrumenting? def severity_number(severity) case severity.downcase when 'debug' - Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_DEBUG + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_DEBUG when 'info' - Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_INFO + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_INFO when 'warn' - Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_WARN + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_WARN when 'error' - Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_ERROR + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_ERROR when 'fatal' - Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_FATAL + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_FATAL else - Opentelemetry::Proto::Logs::V1::SeverityNumber::SEVERITY_NUMBER_UNSPECIFIED + OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_UNSPECIFIED end end end From 97ea4c92089e86ed9fb781e7aac6f89a303b53df Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 15 Apr 2024 11:14:26 -0700 Subject: [PATCH 16/47] Use the updated method name to emit, `on_emit` --- .../lib/opentelemetry/instrumentation/logger/patches/logger.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 504583f63..129a64f10 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -19,7 +19,7 @@ def format_message(severity, datetime, progname, msg) OpenTelemetry.logger_provider.logger( name: OpenTelemetry::Instrumentation::Logger::NAME, version: OpenTelemetry::Instrumentation::Logger::VERSION - ).emit( + ).on_emit( severity_text: severity, severity_number: severity_number(severity), timestamp: datetime, @@ -30,6 +30,7 @@ def format_message(severity, datetime, progname, msg) private + # Placeholder for now def instrumentation_config; end def skip_instrumenting? From f7646f8a7d016ca6d96ca657345577a4bb735493 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 15 Apr 2024 11:14:47 -0700 Subject: [PATCH 17/47] Update tests referencing severity numbers --- .../instrumentation/logger/patches/logger_test.rb | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb index 42afe74bf..33c70b4f1 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -53,14 +53,13 @@ end it 'turns the severity into a number' do - assert_equal(Logger::Severity::DEBUG, 0) ruby_logger.debug(msg) - assert_equal(0, log_record.severity_number) + 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_nil(log_record.severity_number) + assert_equal(0, log_record.severity_number) end end end From 483343cee539a0be71497efce636847b3ed082d3 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 23 Apr 2024 11:13:06 -0700 Subject: [PATCH 18/47] Loosen dependency version restrictions --- .../logger/opentelemetry-instrumentation-logger.gemspec | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec index 81684138c..6fdae80e4 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -26,8 +26,8 @@ Gem::Specification.new do |spec| spec.require_paths = ['lib'] spec.required_ruby_version = '>= 3.0' - spec.add_dependency 'opentelemetry-api', '~> 1.2.2' - spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.22.1' + 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' From c35df18117e8afbe8831f1968c8f2b4694488723 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 23 Apr 2024 12:19:07 -0700 Subject: [PATCH 19/47] fix: Remove NAME constant from gemspec --- .../logger/lib/opentelemetry/instrumentation/logger.rb | 1 - .../logger/opentelemetry-instrumentation-logger.gemspec | 3 +-- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb index cdfcfb47c..b23717e34 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb @@ -11,7 +11,6 @@ module OpenTelemetry module Instrumentation # Contains the OpenTelemetry instrumentation for the Logger gem module Logger - NAME = 'opentelemetry-instrumentation-logger' end end end diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec index 6fdae80e4..56de61359 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -6,11 +6,10 @@ lib = File.expand_path('lib', __dir__) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) -require 'opentelemetry/instrumentation/logger' require 'opentelemetry/instrumentation/logger/version' Gem::Specification.new do |spec| - spec.name = OpenTelemetry::Instrumentation::Logger::NAME + spec.name = 'opentelemetry-instrumentation-logger' spec.version = OpenTelemetry::Instrumentation::Logger::VERSION spec.authors = ['OpenTelemetry Authors'] spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] From 686f2d9c5d7c59336105b3618f85defbd3481a69 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 23 Apr 2024 12:19:28 -0700 Subject: [PATCH 20/47] chore: Address Rubocop require_relative linter --- .../logger/lib/opentelemetry-instrumentation-logger.rb | 2 +- instrumentation/logger/lib/opentelemetry/instrumentation.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb b/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb index baceb3cb7..c034f140f 100644 --- a/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb +++ b/instrumentation/logger/lib/opentelemetry-instrumentation-logger.rb @@ -4,4 +4,4 @@ # # SPDX-License-Identifier: Apache-2.0 -require_relative './opentelemetry/instrumentation' +require_relative 'opentelemetry/instrumentation' diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation.rb index 56bc743f7..eb80ddd2b 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation.rb @@ -16,4 +16,4 @@ module Instrumentation end end -require_relative './instrumentation/logger' +require_relative 'instrumentation/logger' From 1bd3ead8d181869bb645a6fcf33097cbe2f2cdbc Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 23 Apr 2024 12:33:20 -0700 Subject: [PATCH 21/47] Rubocop --- instrumentation/all/opentelemetry-instrumentation-all.gemspec | 2 +- instrumentation/logger/Appraisals | 2 +- .../logger/patches/active_support_logger_test.rb | 2 +- instrumentation/logger/test/test_helpers/app_config.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/instrumentation/all/opentelemetry-instrumentation-all.gemspec b/instrumentation/all/opentelemetry-instrumentation-all.gemspec index e3edba698..96d7381c3 100644 --- a/instrumentation/all/opentelemetry-instrumentation-all.gemspec +++ b/instrumentation/all/opentelemetry-instrumentation-all.gemspec @@ -26,7 +26,6 @@ Gem::Specification.new do |spec| spec.require_paths = ['lib'] spec.required_ruby_version = '>= 3.0' - spec.add_dependency 'opentelemetry-instrumentation-logger', '~> 0.0.0' spec.add_dependency 'opentelemetry-instrumentation-active_model_serializers', '~> 0.20.1' spec.add_dependency 'opentelemetry-instrumentation-aws_sdk', '~> 0.5.0' spec.add_dependency 'opentelemetry-instrumentation-bunny', '~> 0.21.0' @@ -43,6 +42,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.27.0' spec.add_dependency 'opentelemetry-instrumentation-net_http', '~> 0.22.1' diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals index eeea916f0..41ef24559 100644 --- a/instrumentation/logger/Appraisals +++ b/instrumentation/logger/Appraisals @@ -1,4 +1,4 @@ -# # frozen_string_literal: true +# frozen_string_literal: true # # Copyright The OpenTelemetry Authors # # 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 index 16394cf80..b3e3d561f 100644 --- 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 @@ -1,4 +1,4 @@ -# # frozen_string_literal: true +# frozen_string_literal: true # # Copyright The OpenTelemetry Authors # # diff --git a/instrumentation/logger/test/test_helpers/app_config.rb b/instrumentation/logger/test/test_helpers/app_config.rb index 914137614..7db946da9 100644 --- a/instrumentation/logger/test/test_helpers/app_config.rb +++ b/instrumentation/logger/test/test_helpers/app_config.rb @@ -1,4 +1,4 @@ -# # frozen_string_literal: true +# frozen_string_literal: true # # Copyright The OpenTelemetry Authors # # From 8b06c93ce00bd8209831f7c28d2aae0515aab59c Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 24 Apr 2024 08:41:48 -0700 Subject: [PATCH 22/47] fix: Bring back the NAME constant It's used in the instrumentation when on_emit is called --- .../logger/lib/opentelemetry/instrumentation/logger.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb index b23717e34..cdfcfb47c 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger.rb @@ -11,6 +11,7 @@ module OpenTelemetry module Instrumentation # Contains the OpenTelemetry instrumentation for the Logger gem module Logger + NAME = 'opentelemetry-instrumentation-logger' end end end From 66d3b3f8b39ebdf44e4e62c833ec8f353284579b Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 13 May 2024 17:03:56 -0700 Subject: [PATCH 23/47] chore: Correct version number, add TODOs in README --- instrumentation/logger/README.md | 6 ++++-- .../lib/opentelemetry/instrumentation/logger/version.rb | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/instrumentation/logger/README.md b/instrumentation/logger/README.md index ef15b2cfd..a89fc74f2 100644 --- a/instrumentation/logger/README.md +++ b/instrumentation/logger/README.md @@ -1,6 +1,6 @@ # OpenTelemetry Logger Instrumentation -Todo: Add a description. +TODO: Update description. This README is incomplete. ## How do I get started? @@ -30,9 +30,11 @@ OpenTelemetry::SDK.configure do |c| end ``` +TODO: Add documentation for config options. + ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/logger/example/trace_demonstration.rb) +TODO: Create example ## How can I get involved? diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb index 8e0b8e97b..4157e9b04 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb @@ -7,7 +7,7 @@ module OpenTelemetry module Instrumentation module Logger - VERSION = '0.0.0' + VERSION = '0.1.0' end end end From 4c6d6f19cf6d0fdc8444f816165b5aa0e4f313ff Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 13 May 2024 18:11:41 -0700 Subject: [PATCH 24/47] fix: Revert version for now --- .../logger/lib/opentelemetry/instrumentation/logger/version.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb index 4157e9b04..8e0b8e97b 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb @@ -7,7 +7,7 @@ module OpenTelemetry module Instrumentation module Logger - VERSION = '0.1.0' + VERSION = '0.0.0' end end end From 05277264451f7d107cf6c8f3a9d66d0acb13cef8 Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Tue, 7 May 2024 12:26:26 +0530 Subject: [PATCH 25/47] change --- .../instrumentation/logger/patches/logger.rb | 26 ++++++++++++++----- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 129a64f10..634312e57 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -16,25 +16,37 @@ 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 + logger_provider.logger( + name: @config[:name], + version: @config[: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? + 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 + option :name, default: OpenTelemetry::Instrumentation::Logger::NAME, validate: :string + option :version, default: OpenTelemetry::Instrumentation::Logger::VERSION, validate: :string + private - # Placeholder for now - def instrumentation_config; end + def logger_provider + @logger_provider ||= OpenTelemetry.logger_provider + end def skip_instrumenting? - instance_variable_get(:@skip_instrumenting) + @skip_instrumenting || false # Set to a default value + end + + def instrumentation_config + { + name: @config[:name] || OpenTelemetry::Instrumentation::Logger::DEFAULT_NAME, + version: @config[:version] || OpenTelemetry::Instrumentation::Logger::DEFAULT_VERSION + } end def severity_number(severity) From 7dfba216013489784e45b05b49eb4f3d525b7d11 Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Thu, 9 May 2024 09:06:56 +0530 Subject: [PATCH 26/47] move options --- .../instrumentation/logger/instrumentation.rb | 3 +++ .../instrumentation/logger/patches/logger.rb | 5 +---- .../instrumentation/logger/patches/logger_test.rb | 11 ++++++++++- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index f87eef44a..b89c6033a 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -18,6 +18,9 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base defined?(::Logger) end + option :name, default: OpenTelemetry::Instrumentation::Logger::NAME, validate: :string + option :version, default: OpenTelemetry::Instrumentation::Logger::VERSION, validate: :string + private def patch diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 634312e57..d96353796 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -29,9 +29,6 @@ def format_message(severity, datetime, progname, msg) formatted_message end - option :name, default: OpenTelemetry::Instrumentation::Logger::NAME, validate: :string - option :version, default: OpenTelemetry::Instrumentation::Logger::VERSION, validate: :string - private def logger_provider @@ -39,7 +36,7 @@ def logger_provider end def skip_instrumenting? - @skip_instrumenting || false # Set to a default value + @skip_instrumenting || false end def instrumentation_config diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb index 33c70b4f1..96bc91cf4 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -29,12 +29,21 @@ assert_match(/DEBUG -- : #{msg}/, log_stream.string) end - it 'sets the OTel logger instrumentation name and version' do + 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 the OTel logger instrumentation name and version (user defined)' do + ruby_logger.debug(msg) + skip 'TODO: write tests for configuration options' + end + + it 'accepts custom logger provider ' do + skip 'TODO: write tests for configuration options' + end + it 'sets log record attributes based on the Ruby log' do timestamp = Time.now Time.stub(:now, timestamp) do From 03868bcb310119c94f50122fe8cd1915d49e3984 Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Mon, 13 May 2024 12:32:51 +0530 Subject: [PATCH 27/47] accomodated changes --- .../instrumentation/logger/patches/logger.rb | 19 ++++++++++--------- instrumentation/logger/test/test_helper.rb | 2 +- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index d96353796..dbce6ed85 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -17,8 +17,8 @@ def format_message(severity, datetime, progname, msg) return formatted_message if skip_instrumenting? logger_provider.logger( - name: @config[:name], - version: @config[:version] + name: Instrumentation.instance.config[:name], + version: Instrumentation.instance.config[:version] ).on_emit( severity_text: severity, severity_number: severity_number(severity), @@ -29,6 +29,14 @@ def format_message(severity, datetime, progname, msg) formatted_message end + def logger_provider=(value) + @logger_provider = value + end + + def skip_instrumenting=(value) + @skip_instrumenting = value + end + private def logger_provider @@ -39,13 +47,6 @@ def skip_instrumenting? @skip_instrumenting || false end - def instrumentation_config - { - name: @config[:name] || OpenTelemetry::Instrumentation::Logger::DEFAULT_NAME, - version: @config[:version] || OpenTelemetry::Instrumentation::Logger::DEFAULT_VERSION - } - end - def severity_number(severity) case severity.downcase when 'debug' diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb index b293cf054..e3205a131 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -9,7 +9,7 @@ require 'simplecov' SimpleCov.start do - enable_coverage :branch + # enable_coverage :branch add_filter '/test/' end From c96243bc9bbc2c9941ec165c44feb779f3d42c6b Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Tue, 14 May 2024 09:02:22 +0530 Subject: [PATCH 28/47] removed configuring logger_provider --- .../instrumentation/logger/patches/logger.rb | 16 +++------------- instrumentation/logger/test/test_helper.rb | 2 +- 2 files changed, 4 insertions(+), 14 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index dbce6ed85..143fb013c 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -10,13 +10,15 @@ module Logger module Patches # Instrumention for methods from Ruby's Logger class module Logger + attr_writer :skip_instrumenting + # TODO: Make sure OTel logs aren't instrumented # TODO: How to pass attributes? def format_message(severity, datetime, progname, msg) formatted_message = super(severity, datetime, progname, msg) return formatted_message if skip_instrumenting? - logger_provider.logger( + OpenTelemetry.logger_provider.logger( name: Instrumentation.instance.config[:name], version: Instrumentation.instance.config[:version] ).on_emit( @@ -29,20 +31,8 @@ def format_message(severity, datetime, progname, msg) formatted_message end - def logger_provider=(value) - @logger_provider = value - end - - def skip_instrumenting=(value) - @skip_instrumenting = value - end - private - def logger_provider - @logger_provider ||= OpenTelemetry.logger_provider - end - def skip_instrumenting? @skip_instrumenting || false end diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb index e3205a131..b293cf054 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -9,7 +9,7 @@ require 'simplecov' SimpleCov.start do - # enable_coverage :branch + enable_coverage :branch add_filter '/test/' end From 2c9a3e3cf59cbd854591efd00e3ff2936c958c4a Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Tue, 14 May 2024 09:10:19 +0530 Subject: [PATCH 29/47] removed corresponding test --- .../opentelemetry/instrumentation/logger/patches/logger.rb | 2 +- .../instrumentation/logger/patches/logger_test.rb | 4 ---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 143fb013c..0d399c84b 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -26,7 +26,7 @@ def format_message(severity, datetime, progname, msg) 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 + context: OpenTelemetry::Context.current ) formatted_message 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 index 96bc91cf4..a5ced9d99 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -40,10 +40,6 @@ skip 'TODO: write tests for configuration options' end - it 'accepts custom logger provider ' do - skip 'TODO: write tests for configuration options' - end - it 'sets log record attributes based on the Ruby log' do timestamp = Time.now Time.stub(:now, timestamp) do From 236bf1fd1089d2eda9a7fbff2b959f2c364f2744 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Thu, 9 May 2024 19:27:02 -0700 Subject: [PATCH 30/47] chore: Add tests for name and version config --- .../logger/patches/logger_test.rb | 44 +++++++++++++++++-- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb index a5ced9d99..a4872429b 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -15,10 +15,11 @@ let(:log_stream) { StringIO.new } let(:ruby_logger) { Logger.new(log_stream) } let(:msg) { 'message' } + let(:config) { {} } before do exporter.reset - instrumentation.install + instrumentation.install(config) end after { instrumentation.instance_variable_set(:@installed, false) } @@ -35,9 +36,44 @@ assert_equal(OpenTelemetry::Instrumentation::Logger::VERSION, log_record.instrumentation_scope.version) end - it 'sets the OTel logger instrumentation name and version (user defined)' do - ruby_logger.debug(msg) - skip 'TODO: write tests for configuration options' + describe 'configuration options' do + describe 'when a user configures name' do + let(:config) { { name: 'custom_logger' } } + + it 'updates the logger name' do + ruby_logger.debug(msg) + assert_equal('custom_logger', log_record.instrumentation_scope.name) + end + + it 'uses the default version' do + ruby_logger.debug(msg) + assert_equal(OpenTelemetry::Instrumentation::Logger::VERSION, log_record.instrumentation_scope.version) + end + end + + describe 'when a user configures version' do + let(:config) { { version: '5000' } } + + it 'updates the logger version' do + ruby_logger.debug(msg) + assert_equal('5000', log_record.instrumentation_scope.version) + end + + it 'uses the default name' do + ruby_logger.debug(msg) + assert_equal(OpenTelemetry::Instrumentation::Logger::NAME, log_record.instrumentation_scope.name) + end + end + + describe 'when a user configures both name and version' do + let(:config) { { name: 'custom_logger', version: '5000'} } + + it 'updates both values' do + ruby_logger.debug(msg) + assert_equal('custom_logger', log_record.instrumentation_scope.name) + assert_equal('5000', log_record.instrumentation_scope.version) + end + end end it 'sets log record attributes based on the Ruby log' do From b0b301f93c6f58aff6ecdc087d46e6043e2629a9 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 15 May 2024 17:04:54 -0700 Subject: [PATCH 31/47] chore: Rubocop --- .../opentelemetry/instrumentation/logger/patches/logger_test.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb index a4872429b..9d4438aec 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -66,7 +66,7 @@ end describe 'when a user configures both name and version' do - let(:config) { { name: 'custom_logger', version: '5000'} } + let(:config) { { name: 'custom_logger', version: '5000' } } it 'updates both values' do ruby_logger.debug(msg) From e6799ff70ef857b6c9fdf65dda6678462a687f3e Mon Sep 17 00:00:00 2001 From: khushijain21 Date: Fri, 17 May 2024 12:54:55 +0530 Subject: [PATCH 32/47] add check for logs sdk --- .../lib/opentelemetry/instrumentation/logger/instrumentation.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index b89c6033a..a2516d410 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -15,7 +15,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base end present do - defined?(::Logger) + defined?(::Logger) && defined?(::OpenTelemetry::SDK::Logs) end option :name, default: OpenTelemetry::Instrumentation::Logger::NAME, validate: :string From 18a45d1c3122a95ec1836821ff765a39afc8ff01 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Fri, 12 Jul 2024 09:56:27 -0700 Subject: [PATCH 33/47] test: Reinstate active support logger tests --- instrumentation/logger/Appraisals | 2 + instrumentation/logger/Gemfile | 3 + .../logger/patches/active_support_logger.rb | 1 + .../patches/active_support_logger_test.rb | 72 +++++--- instrumentation/logger/test/test_helper.rb | 6 +- .../logger/test/test_helpers/app_config.rb | 158 +++++++----------- 6 files changed, 116 insertions(+), 126 deletions(-) diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals index 41ef24559..fa165e3e1 100644 --- a/instrumentation/logger/Appraisals +++ b/instrumentation/logger/Appraisals @@ -5,6 +5,8 @@ # # 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 # appraise 'rails-6.0' do # gem 'rails', '~> 6.0.0' # end diff --git a/instrumentation/logger/Gemfile b/instrumentation/logger/Gemfile index fef6f8723..c292f236c 100644 --- a/instrumentation/logger/Gemfile +++ b/instrumentation/logger/Gemfile @@ -20,3 +20,6 @@ group :test do 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.0.0' 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 index 5efcdc866..7d8bcff1f 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb @@ -13,6 +13,7 @@ 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 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 index b3e3d561f..e67588569 100644 --- 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 @@ -1,37 +1,55 @@ # frozen_string_literal: true -# # Copyright The OpenTelemetry Authors -# # -# # SPDX-License-Identifier: Apache-2.0 +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 -# require 'test_helper' +require 'test_helper' -# require_relative '../../../../../lib/opentelemetry/instrumentation/logger/patches/active_support_logger' +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(:exporter) { EXPORTER } -# let(:log_record) { exporter.emitted_log_records.first } -# let(:rails_logger) { Rails.logger } -# let(:log_stream) { LOG_STREAM } -# # let(:ruby_logger) { Logger.new(log_stream) } -# let(:msg) { 'message' } +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 -# exporter.reset -# instrumentation.install -# end + before do + EXPORTER.reset + Rails.logger = main_logger.extend(ActiveSupport::Logger.broadcast(broadcasted_logger)) + instrumentation.install + end -# after { instrumentation.instance_variable_set(:@installed, false) } + after { instrumentation.instance_variable_set(:@installed, false) } -# describe '#broadcast' do -# it 'adds @skip_instrumenting to broadcasted loggers' do -# rails_logger.debug(msg) -# assert_match(/DEBUG -- : #{msg}/, log_stream.string) -# end + describe '#broadcast' do + it 'emits the log to the Rails.logger' do + msg = "spruce #{rand(6)}" + Rails.logger.debug(msg) -# it 'does not add @skip_instrumenting to the initial logger' do + assert_match(/#{msg}/, LOG_STREAM.string) + end -# end -# end -# 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/test_helper.rb b/instrumentation/logger/test/test_helper.rb index b293cf054..547f0209f 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -23,6 +23,7 @@ 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) } @@ -30,8 +31,7 @@ c.add_log_record_processor log_record_processor end -# TODO: Re-enable Rails app and active_support_logger testing # 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 +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 index 7db946da9..4e050324f 100644 --- a/instrumentation/logger/test/test_helpers/app_config.rb +++ b/instrumentation/logger/test/test_helpers/app_config.rb @@ -1,98 +1,64 @@ # frozen_string_literal: true -# # Copyright The OpenTelemetry Authors -# # -# # SPDX-License-Identifier: Apache-2.0 - -# class Application < Rails::Application; end -# require 'action_controller/railtie' -# # require_relative 'middlewares' -# # require_relative 'controllers' -# # require_relative 'routes' - -# module AppConfig -# extend self - -# def initialize_app(use_exceptions_app: false, remove_rack_tracer_middleware: false) -# new_app = Application.new -# new_app.config.secret_key_base = 'secret_key_base' - -# # Ensure we don't see this Rails warning when testing -# new_app.config.eager_load = false - -# # Prevent tests from creating log/*.log -# level = ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym -# new_app.config.logger = Logger.new(LOG_STREAM, level: level) -# new_app.config.log_level = level - -# new_app.config.filter_parameters = [:param_to_be_filtered] - -# case Rails.version -# when /^6\.0/ -# apply_rails_6_0_configs(new_app) -# when /^6\.1/ -# apply_rails_6_1_configs(new_app) -# when /^7\./ -# apply_rails_7_configs(new_app) -# end - -# # remove_rack_middleware(new_app) if remove_rack_tracer_middleware -# # add_exceptions_app(new_app) if use_exceptions_app -# # add_middlewares(new_app) - -# new_app.initialize! - -# # draw_routes(new_app) - -# new_app -# end - -# private - -# # def remove_rack_middleware(application) -# # application.middleware.delete( -# # OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware -# # ) -# # end - -# # def add_exceptions_app(application) -# # application.config.exceptions_app = lambda do |env| -# # ExceptionsController.action(:show).call(env) -# # end -# # end - -# # def add_middlewares(application) -# # application.middleware.insert_after( -# # ActionDispatch::DebugExceptions, -# # ExceptionRaisingMiddleware -# # ) - -# # application.middleware.insert_after( -# # ActionDispatch::DebugExceptions, -# # RedirectMiddleware -# # ) -# # end - -# def apply_rails_6_0_configs(application) -# # Required in Rails 6 -# application.config.hosts << 'example.org' -# # Creates a lot of deprecation warnings on subsequent app initializations if not explicitly set. -# application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION -# end - -# def apply_rails_6_1_configs(application) -# # Required in Rails 6 -# application.config.hosts << 'example.org' -# end - -# def apply_rails_7_configs(application) -# # Required in Rails 7 -# application.config.hosts << 'example.org' - -# # Unfreeze values which may have been frozen on previous initializations. -# ActiveSupport::Dependencies.autoload_paths = -# ActiveSupport::Dependencies.autoload_paths.dup -# ActiveSupport::Dependencies.autoload_once_paths = -# ActiveSupport::Dependencies.autoload_once_paths.dup -# end -# end +# 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 + + # 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] + + case Rails.version + when /^6\.0/ + apply_rails_6_0_configs(app) + when /^6\.1/ + apply_rails_6_1_configs(app) + when /^7\./ + apply_rails_7_configs(app) + end + + app.initialize! + + app + end + + private + + def apply_rails_6_0_configs(application) + # Required in Rails 6 + application.config.hosts << 'example.org' + # Creates a lot of deprecation warnings on subsequent app initializations if not explicitly set. + application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION + end + + def apply_rails_6_1_configs(application) + # Required in Rails 6 + application.config.hosts << 'example.org' + end + + def apply_rails_7_configs(application) + # Required in Rails 7 + application.config.hosts << 'example.org' + + # Unfreeze values which may have been frozen on previous initializations. + ActiveSupport::Dependencies.autoload_paths = + ActiveSupport::Dependencies.autoload_paths.dup + ActiveSupport::Dependencies.autoload_once_paths = + ActiveSupport::Dependencies.autoload_once_paths.dup + end +end From d00bc1da07fe5302d592773a4e769568c4cd985e Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 16 Sep 2024 17:15:48 -0700 Subject: [PATCH 34/47] style: Add language to code fence --- instrumentation/logger/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logger/README.md b/instrumentation/logger/README.md index a89fc74f2..8540d0f18 100644 --- a/instrumentation/logger/README.md +++ b/instrumentation/logger/README.md @@ -6,7 +6,7 @@ TODO: Update description. This README is incomplete. Install the gem using: -``` +```shell gem install opentelemetry-instrumentation-logger ``` From d129337eadd1534c373dbbfee907447ad8979684 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> Date: Tue, 17 Sep 2024 12:07:50 -0700 Subject: [PATCH 35/47] Update instrumentation/logger/lib/opentelemetry/instrumentation.rb --- instrumentation/logger/lib/opentelemetry/instrumentation.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation.rb index eb80ddd2b..001b363af 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation.rb @@ -11,7 +11,6 @@ # The OpenTelemetry module provides global accessors for telemetry objects. # See the documentation for the `opentelemetry-api` gem for details. module OpenTelemetry - # Instrumentation should be able to handle the case when the library is not installed on a user's system. module Instrumentation end end From 97b42deff5eafba3d97093c0f8ab51e5ede20c15 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 15:15:40 -0700 Subject: [PATCH 36/47] docs: add some config info --- .../instrumentation/logger/instrumentation.rb | 33 ++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index a2516d410..b0c3f531d 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -7,7 +7,38 @@ module OpenTelemetry module Instrumentation module Logger - # The Instrumentation class contains logic to detect and install the Logger instrumentation + # 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()}. + # + # ## Configuration keys and options + # + # ### `:name` + # + # Sets the name of the OpenTelemetry Logger InstrumentationScope. + # + # - The name of this gem, `'opentelemetry-instrumentation-logger'` is the default. + # + # ### `:version` + # + # Sets the version of the OpenTelemetry Logger InstrumentationScope. + # + # - This gem's current version is the default. + # + # + # @example An explicit default configuration + # OpenTelemetry::SDK.configure do |c| + # c.use_all({ + # 'OpenTelemetry::Instrumentation::Sidekiq' => { + # name: 'opentelemetry-instrumentation-logger', + # version: '0.1.0' + # }, + # }) + # end class Instrumentation < OpenTelemetry::Instrumentation::Base install do |_config| require_dependencies From 6276944df4495d92717182f927c6b51444a1d84c Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 15:17:35 -0700 Subject: [PATCH 37/47] feat: Remove config options --- .../instrumentation/logger/instrumentation.rb | 27 ------------------- .../instrumentation/logger/patches/logger.rb | 6 ++--- 2 files changed, 2 insertions(+), 31 deletions(-) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index b0c3f531d..70ed5479d 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -15,30 +15,6 @@ module Logger # 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()}. # - # ## Configuration keys and options - # - # ### `:name` - # - # Sets the name of the OpenTelemetry Logger InstrumentationScope. - # - # - The name of this gem, `'opentelemetry-instrumentation-logger'` is the default. - # - # ### `:version` - # - # Sets the version of the OpenTelemetry Logger InstrumentationScope. - # - # - This gem's current version is the default. - # - # - # @example An explicit default configuration - # OpenTelemetry::SDK.configure do |c| - # c.use_all({ - # 'OpenTelemetry::Instrumentation::Sidekiq' => { - # name: 'opentelemetry-instrumentation-logger', - # version: '0.1.0' - # }, - # }) - # end class Instrumentation < OpenTelemetry::Instrumentation::Base install do |_config| require_dependencies @@ -49,9 +25,6 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base defined?(::Logger) && defined?(::OpenTelemetry::SDK::Logs) end - option :name, default: OpenTelemetry::Instrumentation::Logger::NAME, validate: :string - option :version, default: OpenTelemetry::Instrumentation::Logger::VERSION, validate: :string - private def patch diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 0d399c84b..e6c17ea89 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -12,15 +12,13 @@ module Patches module Logger attr_writer :skip_instrumenting - # TODO: Make sure OTel logs aren't instrumented - # TODO: How to pass attributes? 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: Instrumentation.instance.config[:name], - version: Instrumentation.instance.config[:version] + name: OpenTelemetry::Instrumentation::Logger::NAME, + version: OpenTelemetry::Instrumentation::Logger::VERSION ).on_emit( severity_text: severity, severity_number: severity_number(severity), From ef88293afa4bc36cdc966115447644472fa0dad4 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 15:18:15 -0700 Subject: [PATCH 38/47] chore: Add TODO for version number update --- .../logger/lib/opentelemetry/instrumentation/logger/version.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb index 8e0b8e97b..316fc1d14 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb @@ -7,6 +7,7 @@ module OpenTelemetry module Instrumentation module Logger + # TODO: Update me when ready to release VERSION = '0.0.0' end end From 00c8687913b7fe0f246fc4cdd5a8ad36ddba39b0 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 15:27:46 -0700 Subject: [PATCH 39/47] feat: Update example and readme --- instrumentation/logger/README.md | 20 +++++++++++---- instrumentation/logger/example/logger.rb | 32 ++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 5 deletions(-) create mode 100644 instrumentation/logger/example/logger.rb diff --git a/instrumentation/logger/README.md b/instrumentation/logger/README.md index 8540d0f18..819a5b962 100644 --- a/instrumentation/logger/README.md +++ b/instrumentation/logger/README.md @@ -1,6 +1,6 @@ # OpenTelemetry Logger Instrumentation -TODO: Update description. This README is incomplete. +The Logger instrumentation is a community-maintained bridge for the Ruby [logger][logger-home] standard library. ## How do I get started? @@ -30,15 +30,23 @@ OpenTelemetry::SDK.configure do |c| end ``` -TODO: Add documentation for config options. - ## Examples -TODO: Create example +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-api` and `opentelemetry-sdk`. +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]. @@ -46,7 +54,9 @@ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special int 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 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') From 7f8dce1448a715d227e8815c0bb919b50fb62de5 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 16:55:28 -0700 Subject: [PATCH 40/47] test: remove appraisals for eol'd rails versions --- instrumentation/logger/Appraisals | 14 ++++---- .../logger/test/test_helpers/app_config.rb | 36 ++----------------- 2 files changed, 10 insertions(+), 40 deletions(-) diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals index fa165e3e1..80e00d6df 100644 --- a/instrumentation/logger/Appraisals +++ b/instrumentation/logger/Appraisals @@ -7,14 +7,16 @@ # # 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 -# appraise 'rails-6.0' do -# gem 'rails', '~> 6.0.0' +# # Only test Rails versions that are still in support + +# appraise 'rails-7.0' do +# gem 'rails', '~> 7.0.0' # end -# appraise 'rails-6.1' do -# gem 'rails', '~> 6.1.0' +# appraise 'rails-7.1' do +# gem 'rails', '~> 7.1.0' # end -# appraise 'rails-7.0' do -# gem 'rails', '~> 7.0.0' +# appraise 'rails-7.2' do +# gem 'rails', '~> 7.2.0' # end diff --git a/instrumentation/logger/test/test_helpers/app_config.rb b/instrumentation/logger/test/test_helpers/app_config.rb index 4e050324f..710c6de61 100644 --- a/instrumentation/logger/test/test_helpers/app_config.rb +++ b/instrumentation/logger/test/test_helpers/app_config.rb @@ -16,49 +16,17 @@ def initialize_app(use_exceptions_app: false, remove_rack_tracer_middleware: fal # 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] - - case Rails.version - when /^6\.0/ - apply_rails_6_0_configs(app) - when /^6\.1/ - apply_rails_6_1_configs(app) - when /^7\./ - apply_rails_7_configs(app) - end + app.config.load_defaults([Rails::VERSION::MAJOR, Rails::VERSION::MINOR].compact.join('.')) app.initialize! app end - - private - - def apply_rails_6_0_configs(application) - # Required in Rails 6 - application.config.hosts << 'example.org' - # Creates a lot of deprecation warnings on subsequent app initializations if not explicitly set. - application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION - end - - def apply_rails_6_1_configs(application) - # Required in Rails 6 - application.config.hosts << 'example.org' - end - - def apply_rails_7_configs(application) - # Required in Rails 7 - application.config.hosts << 'example.org' - - # Unfreeze values which may have been frozen on previous initializations. - ActiveSupport::Dependencies.autoload_paths = - ActiveSupport::Dependencies.autoload_paths.dup - ActiveSupport::Dependencies.autoload_once_paths = - ActiveSupport::Dependencies.autoload_once_paths.dup - end end From e5cc573541172b59bcfac9e73c46e6882e559afc Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 16:58:50 -0700 Subject: [PATCH 41/47] feat: Support ActiveSupport::BroadcastLogger Rails 7.1+ uses ActiveSupport::BroadcastLogger. This needs to protect against emitting duplicate logs in a different way than ActiveSupport::Logger.broadcast. Emits the log record for the first logger in the broadcast, skip the others. Reset everything at the end of the method call. --- instrumentation/logger/Gemfile | 2 +- .../instrumentation/logger/instrumentation.rb | 10 ++- .../active_support_broadcast_logger.rb | 55 ++++++++++++ .../active_support_broadcast_logger_test.rb | 88 +++++++++++++++++++ .../patches/active_support_logger_test.rb | 1 + 5 files changed, 154 insertions(+), 2 deletions(-) create mode 100644 instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger.rb create mode 100644 instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/active_support_broadcast_logger_test.rb diff --git a/instrumentation/logger/Gemfile b/instrumentation/logger/Gemfile index c292f236c..82e256731 100644 --- a/instrumentation/logger/Gemfile +++ b/instrumentation/logger/Gemfile @@ -22,4 +22,4 @@ group :test do end # Temporary for testing, Appraisal does not work with gems installed from git source -gem 'rails', '~> 7.0.0' +gem 'rails', '~> 7.1.0' diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb index 70ed5479d..44fc83d8c 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/instrumentation.rb @@ -29,6 +29,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base def patch ::Logger.prepend(Patches::Logger) + active_support_broadcast_logger_patch active_support_patch end @@ -37,11 +38,18 @@ def require_dependencies end def active_support_patch - return unless defined?(::ActiveSupport::Logger) + 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 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/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 index e67588569..9bd96ff3e 100644 --- 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 @@ -14,6 +14,7 @@ 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 From ea3351e80ff47cdef16749643b4a0d149b29e824 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Tue, 17 Sep 2024 16:59:10 -0700 Subject: [PATCH 42/47] test: Remove config option tests --- .../logger/patches/logger_test.rb | 40 ------------------- 1 file changed, 40 deletions(-) diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb index 9d4438aec..f0c5b9460 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -36,46 +36,6 @@ assert_equal(OpenTelemetry::Instrumentation::Logger::VERSION, log_record.instrumentation_scope.version) end - describe 'configuration options' do - describe 'when a user configures name' do - let(:config) { { name: 'custom_logger' } } - - it 'updates the logger name' do - ruby_logger.debug(msg) - assert_equal('custom_logger', log_record.instrumentation_scope.name) - end - - it 'uses the default version' do - ruby_logger.debug(msg) - assert_equal(OpenTelemetry::Instrumentation::Logger::VERSION, log_record.instrumentation_scope.version) - end - end - - describe 'when a user configures version' do - let(:config) { { version: '5000' } } - - it 'updates the logger version' do - ruby_logger.debug(msg) - assert_equal('5000', log_record.instrumentation_scope.version) - end - - it 'uses the default name' do - ruby_logger.debug(msg) - assert_equal(OpenTelemetry::Instrumentation::Logger::NAME, log_record.instrumentation_scope.name) - end - end - - describe 'when a user configures both name and version' do - let(:config) { { name: 'custom_logger', version: '5000' } } - - it 'updates both values' do - ruby_logger.debug(msg) - assert_equal('custom_logger', log_record.instrumentation_scope.name) - assert_equal('5000', log_record.instrumentation_scope.version) - end - end - end - it 'sets log record attributes based on the Ruby log' do timestamp = Time.now Time.stub(:now, timestamp) do From c9f47c6f8bbc654eca73219f787ad7febe06ac69 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 4 Dec 2024 16:57:53 -0800 Subject: [PATCH 43/47] chore: Prepare bridge for review * Add references to released logs gems * Test Rails 7.0 - 8.0 * Rubocop * Set gem version --- instrumentation/logger/Appraisals | 33 ++++++++----------- instrumentation/logger/Gemfile | 8 ----- instrumentation/logger/README.md | 3 +- instrumentation/logger/example/logger.rb | 10 +++--- .../lib/opentelemetry/instrumentation.rb | 1 + .../instrumentation/logger/patches/logger.rb | 4 +-- .../instrumentation/logger/version.rb | 3 +- instrumentation/logger/log/development.log | 0 ...entelemetry-instrumentation-logger.gemspec | 11 +++---- .../active_support_broadcast_logger_test.rb | 8 ++--- .../patches/active_support_logger_test.rb | 2 +- .../logger/patches/logger_test.rb | 4 ++- instrumentation/logger/test/test_helper.rb | 2 -- 13 files changed, 37 insertions(+), 52 deletions(-) delete mode 100644 instrumentation/logger/log/development.log diff --git a/instrumentation/logger/Appraisals b/instrumentation/logger/Appraisals index 80e00d6df..52806e8ad 100644 --- a/instrumentation/logger/Appraisals +++ b/instrumentation/logger/Appraisals @@ -1,22 +1,15 @@ # 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 +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +%w[7.0.0 7.1.0].each do |version| + appraise "rails-#{version}" do + gem 'rails', "~> #{version}" + end +end + +appraise 'rails-latest' do + gem 'rails' +end diff --git a/instrumentation/logger/Gemfile b/instrumentation/logger/Gemfile index 82e256731..a952c5002 100644 --- a/instrumentation/logger/Gemfile +++ b/instrumentation/logger/Gemfile @@ -6,7 +6,6 @@ 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. @@ -15,11 +14,4 @@ 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/README.md b/instrumentation/logger/README.md index 819a5b962..73231dd51 100644 --- a/instrumentation/logger/README.md +++ b/instrumentation/logger/README.md @@ -22,7 +22,7 @@ OpenTelemetry::SDK.configure do |c| end ``` -Alternatively, you can also call `use_all` to install all the available instrumentation. +Alternatively, you can call `use_all` to install all the available instrumentation. ```ruby OpenTelemetry::SDK.configure do |c| @@ -40,6 +40,7 @@ The test suite leverages [appraisal][appraisal] to verify the integration across ```shell cd instrumentation/logger +bundle exec appraisal generate bundle exec appraisal install bundle exec appraisal rake test ``` diff --git a/instrumentation/logger/example/logger.rb b/instrumentation/logger/example/logger.rb index 59369653c..6a8901e93 100644 --- a/instrumentation/logger/example/logger.rb +++ b/instrumentation/logger/example/logger.rb @@ -1,6 +1,5 @@ # 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 @@ -8,25 +7,26 @@ gem 'logger' gem 'opentelemetry-sdk' - gem 'opentelemetry-logs-api' gem 'opentelemetry-logs-sdk' gem 'opentelemetry-instrumentation-logger', path: '../' end +require 'opentelemetry/sdk' 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' +ENV['OTEL_LOGS_EXPORTER'] ||= 'console' OpenTelemetry::SDK.configure do |c| - c.use OpenTelemetry::Instrumentation::Logger + c.use 'OpenTelemetry::Instrumentation::Logger' end at_exit do OpenTelemetry.logger_provider.shutdown end -logger = Logger.new +logger = Logger.new(STDOUT) logger.debug('emerald ash borer') diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation.rb b/instrumentation/logger/lib/opentelemetry/instrumentation.rb index 001b363af..99cd544da 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation.rb @@ -11,6 +11,7 @@ # The OpenTelemetry module provides global accessors for telemetry objects. # See the documentation for the `opentelemetry-api` gem for details. module OpenTelemetry + # The Instrumentation module is a namespace for all OpenTelemetry Instrumentation libraries module Instrumentation end end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index e6c17ea89..5194b8b4d 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -13,7 +13,7 @@ module Logger attr_writer :skip_instrumenting def format_message(severity, datetime, progname, msg) - formatted_message = super(severity, datetime, progname, msg) + formatted_message = super return formatted_message if skip_instrumenting? OpenTelemetry.logger_provider.logger( @@ -23,7 +23,7 @@ def format_message(severity, datetime, progname, msg) 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? + body: msg, context: OpenTelemetry::Context.current ) formatted_message diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb index 316fc1d14..4157e9b04 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/version.rb @@ -7,8 +7,7 @@ module OpenTelemetry module Instrumentation module Logger - # TODO: Update me when ready to release - VERSION = '0.0.0' + VERSION = '0.1.0' end end end diff --git a/instrumentation/logger/log/development.log b/instrumentation/logger/log/development.log deleted file mode 100644 index e69de29bb..000000000 diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec index 56de61359..82088daa2 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -25,19 +25,18 @@ Gem::Specification.new do |spec| 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_dependency 'opentelemetry-logs-api', '~> 0.1' - spec.add_development_dependency 'appraisal', '~> 2.2.0' + spec.add_development_dependency 'appraisal', '~> 2.5.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-logs-sdk', '~> 0.1' 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 'rubocop', '~> 1.69.1' + spec.add_development_dependency 'rubocop-performance', '~> 1.23.0' 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' 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 index 25e9c2738..449b4e563 100644 --- 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 @@ -15,7 +15,7 @@ let(:broadcast) { ActiveSupport::BroadcastLogger.new(logger, logger2) } before do - skip unless defined?(::ActiveSupport::BroadcastLogger) + skip unless defined?(ActiveSupport::BroadcastLogger) EXPORTER.reset instrumentation.install end @@ -24,7 +24,7 @@ describe '#add' do it 'emits the log to the broadcasted loggers' do - body = "Ground control to Major Tom" + body = 'Ground control to Major Tom' broadcast.add(Logger::DEBUG, body) assert_includes(LOG_STREAM.string, body) @@ -32,7 +32,7 @@ end it 'emits only one OpenTelemetry log record' do - body = "Wake up, you sleepyhead" + body = 'Wake up, you sleepyhead' broadcast.add(Logger::DEBUG, body) log_records = EXPORTER.emitted_log_records @@ -44,7 +44,7 @@ describe '#unknown' do it 'emits the log to the broadcasted loggers' do - body = "I know when to go out" + body = 'I know when to go out' broadcast.unknown(body) assert_includes(LOG_STREAM.string, body) 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 index 9bd96ff3e..6cd58ecce 100644 --- 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 @@ -14,7 +14,7 @@ let(:broadcasted_logger) { ActiveSupport::Logger.new(BROADCASTED_STREAM) } before do - skip unless defined?(::ActiveSupport::Logger) && !defined?(::ActiveSupport::BroadcastLogger) + skip unless defined?(ActiveSupport::Logger) && !defined?(ActiveSupport::BroadcastLogger) EXPORTER.reset Rails.logger = main_logger.extend(ActiveSupport::Logger.broadcast(broadcasted_logger)) instrumentation.install diff --git a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb index f0c5b9460..112e1ce62 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -38,12 +38,14 @@ it 'sets log record attributes based on the Ruby log' do timestamp = Time.now + nano_timestamp = OpenTelemetry::SDK::Logs::LogRecord.new.send(:to_integer_nanoseconds, timestamp) + 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) + assert_equal(nano_timestamp, log_record.timestamp) end end diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb index 547f0209f..423c8b522 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -16,8 +16,6 @@ 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 From 40f4b9a14dbe9564627d3e4c19ec72c7ef2c8579 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 4 Dec 2024 17:01:22 -0800 Subject: [PATCH 44/47] chore: Rename skip_instrumenting to skip_otel_emit --- .../logger/patches/active_support_broadcast_logger.rb | 8 ++++---- .../logger/patches/active_support_logger.rb | 2 +- .../instrumentation/logger/patches/logger.rb | 8 ++++---- .../logger/patches/active_support_logger_test.rb | 8 ++++---- .../instrumentation/logger/patches/logger_test.rb | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) 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 index c5623ebca..8d310832e 100644 --- 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 @@ -41,12 +41,12 @@ def unknown(*args) 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. + # Set @skip_otel_emit to `true` to the rest of the loggers before emitting the logs. + # Set @skip_otel_emit 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) } + broadcasts[1..-1].each { |broadcasted_logger| broadcasted_logger.instance_variable_set(:@skip_otel_emit, true) } yield - broadcasts.each { |broadcasted_logger| broadcasted_logger.instance_variable_set(:@skip_instrumenting, false) } + broadcasts.each { |broadcasted_logger| broadcasted_logger.instance_variable_set(:@skip_otel_emit, false) } 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 index 7d8bcff1f..6d67072bb 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/active_support_logger.rb @@ -15,7 +15,7 @@ module ActiveSupportLogger # destinations from generating OpenTelemetry log record objects. # Available in Rails 7.0 and below def broadcast(logger) - logger.instance_variable_set(:@skip_instrumenting, true) + logger.instance_variable_set(:@skip_otel_emit, true) super end end diff --git a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb index 5194b8b4d..63827882c 100644 --- a/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb +++ b/instrumentation/logger/lib/opentelemetry/instrumentation/logger/patches/logger.rb @@ -10,11 +10,11 @@ module Logger module Patches # Instrumention for methods from Ruby's Logger class module Logger - attr_writer :skip_instrumenting + attr_writer :skip_otel_emit def format_message(severity, datetime, progname, msg) formatted_message = super - return formatted_message if skip_instrumenting? + return formatted_message if skip_otel_emit? OpenTelemetry.logger_provider.logger( name: OpenTelemetry::Instrumentation::Logger::NAME, @@ -31,8 +31,8 @@ def format_message(severity, datetime, progname, msg) private - def skip_instrumenting? - @skip_instrumenting || false + def skip_otel_emit? + @skip_otel_emit || false end def severity_number(severity) 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 index 6cd58ecce..8241596dc 100644 --- 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 @@ -45,12 +45,12 @@ 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) + it 'does not add @skip_otel_emit to the initial logger' do + refute Rails.logger.instance_variable_defined?(:@skip_otel_emit) end - it 'adds @skip_instrumenting to broadcasted loggers' do - assert broadcasted_logger.instance_variable_defined?(:@skip_instrumenting) + it 'adds @skip_otel_emit to broadcasted loggers' do + assert broadcasted_logger.instance_variable_defined?(:@skip_otel_emit) 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 index 112e1ce62..7c9162160 100644 --- a/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb +++ b/instrumentation/logger/test/opentelemetry/instrumentation/logger/patches/logger_test.rb @@ -49,8 +49,8 @@ end end - it 'does not emit when @skip_instrumenting is true' do - ruby_logger.instance_variable_set(:@skip_instrumenting, true) + it 'does not emit when @skip_otel_emit is true' do + ruby_logger.instance_variable_set(:@skip_otel_emit, true) ruby_logger.debug(msg) assert_nil(log_record) end From b0cace23725585d2b2a0d17f1f9c3f083ebf4add Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 4 Dec 2024 17:30:45 -0800 Subject: [PATCH 45/47] chore: Bump instrumentation-logger version in all --- instrumentation/all/opentelemetry-instrumentation-all.gemspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/all/opentelemetry-instrumentation-all.gemspec b/instrumentation/all/opentelemetry-instrumentation-all.gemspec index 92f855ba9..dc1a88e40 100644 --- a/instrumentation/all/opentelemetry-instrumentation-all.gemspec +++ b/instrumentation/all/opentelemetry-instrumentation-all.gemspec @@ -43,7 +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-logger', '~> 0.1.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' From eda40db184d182faf29a4b7891df116ffc1b6d57 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Thu, 5 Dec 2024 16:32:46 -0800 Subject: [PATCH 46/47] chore: Remove simplecov --- .../logger/opentelemetry-instrumentation-logger.gemspec | 1 - instrumentation/logger/test/test_helper.rb | 8 -------- 2 files changed, 9 deletions(-) diff --git a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec index 82088daa2..2e35b241f 100644 --- a/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec +++ b/instrumentation/logger/opentelemetry-instrumentation-logger.gemspec @@ -36,7 +36,6 @@ Gem::Specification.new do |spec| spec.add_development_dependency 'rake', '~> 13.0' spec.add_development_dependency 'rubocop', '~> 1.69.1' spec.add_development_dependency 'rubocop-performance', '~> 1.23.0' - spec.add_development_dependency 'simplecov' spec.add_development_dependency 'yard', '~> 0.9' spec.add_development_dependency 'yard-doctest', '~> 0.1.6' diff --git a/instrumentation/logger/test/test_helper.rb b/instrumentation/logger/test/test_helper.rb index 423c8b522..1857900f6 100644 --- a/instrumentation/logger/test/test_helper.rb +++ b/instrumentation/logger/test/test_helper.rb @@ -7,14 +7,6 @@ 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 'test_helpers/app_config' From d7ea817ec029f8282c8eddf373d21c944b29db65 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Thu, 5 Dec 2024 16:33:29 -0800 Subject: [PATCH 47/47] test: Update ActiveSupportLogger tests Test the outcome rather than the presence of variables --- .../logger/patches/active_support_logger_test.rb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) 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 index 8241596dc..8b9a1d4f0 100644 --- 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 @@ -23,21 +23,21 @@ after { instrumentation.instance_variable_set(:@installed, false) } describe '#broadcast' do - it 'emits the log to the Rails.logger' do + it 'streams 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 + it 'streams 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 + it 'emits the log record' do msg = "hemlock #{rand(6)}" Rails.logger.debug(msg) log_record = EXPORTER.emitted_log_records.first @@ -45,12 +45,12 @@ assert_match(/#{msg}/, log_record.body) end - it 'does not add @skip_otel_emit to the initial logger' do - refute Rails.logger.instance_variable_defined?(:@skip_otel_emit) - end + it 'emits the log record only once' do + msg = "juniper #{rand(6)}" + Rails.logger.debug(msg) - it 'adds @skip_otel_emit to broadcasted loggers' do - assert broadcasted_logger.instance_variable_defined?(:@skip_otel_emit) + assert_equal 1, EXPORTER.emitted_log_records.size + assert_match(/#{msg}/, log_record.body) end end end