From 6c404b296a19f81fb5b366fec4753ecdfaa5027a Mon Sep 17 00:00:00 2001 From: "americodls@gmail.com" Date: Fri, 3 Oct 2025 16:22:50 +0100 Subject: [PATCH] feat: add FactoryBot instrumentation Adds OpenTelemetry instrumentation for FactoryBot gem via ActiveSupport::Notifications. --- .github/workflows/ci-instrumentation.yml | 1 + .toys/.data/releases.yml | 4 + instrumentation/factory_bot/.rubocop.yml | 1 + instrumentation/factory_bot/.yardopts | 9 + instrumentation/factory_bot/Appraisals | 23 ++ instrumentation/factory_bot/CHANGELOG.md | 8 + instrumentation/factory_bot/Gemfile | 29 +++ instrumentation/factory_bot/LICENSE | 201 ++++++++++++++++ instrumentation/factory_bot/README.md | 86 +++++++ instrumentation/factory_bot/Rakefile | 28 +++ .../example/trace_demonstration.rb | 65 ++++++ ...entelemetry-instrumentation-factory_bot.rb | 7 + .../lib/opentelemetry/instrumentation.rb | 19 ++ .../instrumentation/factory_bot.rb | 19 ++ .../factory_bot/instrumentation.rb | 48 ++++ .../factory_bot/run_factory_subscriber.rb | 61 +++++ .../instrumentation/factory_bot/version.rb | 13 ++ ...emetry-instrumentation-factory_bot.gemspec | 37 +++ .../factory_bot/instrumentation_test.rb | 216 ++++++++++++++++++ .../factory_bot/test/test_helper.rb | 28 +++ 20 files changed, 903 insertions(+) create mode 100644 instrumentation/factory_bot/.rubocop.yml create mode 100644 instrumentation/factory_bot/.yardopts create mode 100644 instrumentation/factory_bot/Appraisals create mode 100644 instrumentation/factory_bot/CHANGELOG.md create mode 100644 instrumentation/factory_bot/Gemfile create mode 100644 instrumentation/factory_bot/LICENSE create mode 100644 instrumentation/factory_bot/README.md create mode 100644 instrumentation/factory_bot/Rakefile create mode 100644 instrumentation/factory_bot/example/trace_demonstration.rb create mode 100644 instrumentation/factory_bot/lib/opentelemetry-instrumentation-factory_bot.rb create mode 100644 instrumentation/factory_bot/lib/opentelemetry/instrumentation.rb create mode 100644 instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot.rb create mode 100644 instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/instrumentation.rb create mode 100644 instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/run_factory_subscriber.rb create mode 100644 instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/version.rb create mode 100644 instrumentation/factory_bot/opentelemetry-instrumentation-factory_bot.gemspec create mode 100644 instrumentation/factory_bot/test/opentelemetry/instrumentation/factory_bot/instrumentation_test.rb create mode 100644 instrumentation/factory_bot/test/test_helper.rb diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml index 69ad810fcc..57429575fb 100644 --- a/.github/workflows/ci-instrumentation.yml +++ b/.github/workflows/ci-instrumentation.yml @@ -40,6 +40,7 @@ jobs: - delayed_job - ethon - excon + - factory_bot - faraday - grape - graphql diff --git a/.toys/.data/releases.yml b/.toys/.data/releases.yml index 1182c128ac..a6bf6a0635 100644 --- a/.toys/.data/releases.yml +++ b/.toys/.data/releases.yml @@ -30,6 +30,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-factory_bot + directory: instrumentation/factory_bot + version_constant: [OpenTelemetry, Instrumentation, FactoryBot, VERSION] + - name: opentelemetry-instrumentation-anthropic directory: instrumentation/anthropic version_constant: [OpenTelemetry, Instrumentation, Anthropic, VERSION] diff --git a/instrumentation/factory_bot/.rubocop.yml b/instrumentation/factory_bot/.rubocop.yml new file mode 100644 index 0000000000..1248a2f825 --- /dev/null +++ b/instrumentation/factory_bot/.rubocop.yml @@ -0,0 +1 @@ +inherit_from: ../../.rubocop.yml diff --git a/instrumentation/factory_bot/.yardopts b/instrumentation/factory_bot/.yardopts new file mode 100644 index 0000000000..8bbb3c954e --- /dev/null +++ b/instrumentation/factory_bot/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Factory Bot Instrumentation +--markup=markdown +--main=README.md +./lib/opentelemetry/instrumentation/**/*.rb +./lib/opentelemetry/instrumentation.rb +- +README.md +CHANGELOG.md diff --git a/instrumentation/factory_bot/Appraisals b/instrumentation/factory_bot/Appraisals new file mode 100644 index 0000000000..41dc7601b0 --- /dev/null +++ b/instrumentation/factory_bot/Appraisals @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +appraise 'factory_bot-4' do + gem 'factory_bot', '~> 4.0' + gem 'activesupport', '~> 6.0' # factory_bot 4 requires activesupport < 7 on Ruby 3.4+ +end + +appraise 'factory_bot-5' do + gem 'factory_bot', '~> 5.0' + gem 'activesupport', '~> 6.0' # factory_bot 5 requires activesupport < 7 on Ruby 3.4+ +end + +appraise 'factory_bot-6' do + gem 'factory_bot', '~> 6.0' +end + +appraise 'factory_bot-latest' do + gem 'factory_bot' +end diff --git a/instrumentation/factory_bot/CHANGELOG.md b/instrumentation/factory_bot/CHANGELOG.md new file mode 100644 index 0000000000..5ce8ace204 --- /dev/null +++ b/instrumentation/factory_bot/CHANGELOG.md @@ -0,0 +1,8 @@ +# Release History: opentelemetry-instrumentation-factory_bot + +## v0.1.0 / 2025-01-03 + +* Initial release +* Instruments FactoryBot operations via ActiveSupport::Notifications +* Captures create, build, build_stubbed, and attributes_for strategies +* Includes factory name, strategy, and traits in span attributes diff --git a/instrumentation/factory_bot/Gemfile b/instrumentation/factory_bot/Gemfile new file mode 100644 index 0000000000..8f0107b6bc --- /dev/null +++ b/instrumentation/factory_bot/Gemfile @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +source 'https://rubygems.org' + +gemspec + +group :test do + gem 'opentelemetry-instrumentation-base', path: '../base' + gem 'appraisal', '~> 2.5' + gem 'bundler', '~> 2.4' + gem 'minitest', '~> 5.0' + gem 'opentelemetry-sdk', '~> 1.0' + gem 'opentelemetry-test-helpers', '~> 0.3' + gem 'rake', '~> 13.0' + gem 'rubocop', '~> 1.80.2' + gem 'rubocop-performance', '~> 1.26.0' + gem 'simplecov', '~> 0.17.1' + gem 'webmock', '~> 3.24' + gem 'yard', '~> 0.9' + if RUBY_VERSION >= '3.4' + gem 'base64' # Required for activesupport < 7.1 on Ruby 3.4+ + gem 'mutex_m' # Required for activesupport < 7.1 on Ruby 3.4+ + gem 'observer' # Required for factory_bot 4.x on Ruby 3.4+ + end +end diff --git a/instrumentation/factory_bot/LICENSE b/instrumentation/factory_bot/LICENSE new file mode 100644 index 0000000000..1ef7dad2c5 --- /dev/null +++ b/instrumentation/factory_bot/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/factory_bot/README.md b/instrumentation/factory_bot/README.md new file mode 100644 index 0000000000..6b77683ef6 --- /dev/null +++ b/instrumentation/factory_bot/README.md @@ -0,0 +1,86 @@ +# OpenTelemetry FactoryBot Instrumentation + +The FactoryBot instrumentation is a community-maintained instrumentation for the [FactoryBot](https://github.com/thoughtbot/factory_bot) gem. + +This instrumentation creates spans for FactoryBot operations (create, build, build_stubbed, attributes_for), providing visibility into test data creation patterns. This is particularly useful when combined with ActiveRecord instrumentation, as it makes it explicit which database operations are triggered by FactoryBot vs direct ActiveRecord calls. + +## How do I get started? + +Install the gem using: + +```console +gem install opentelemetry-instrumentation-factory_bot +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-factory_bot` 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::FactoryBot' +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/](example/) directory + +A simple example: + +```ruby +require 'opentelemetry/sdk' +require 'opentelemetry/instrumentation/factory_bot' +require 'factory_bot' + +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::FactoryBot' +end + +# Define a factory +FactoryBot.define do + factory :user do + name { 'Test User' } + email { 'test@example.com' } + end +end + +# Create a user - this will generate a span named "FactoryBot.build(user)" +user = FactoryBot.build(:user) +``` + +## Span Attributes + +The instrumentation adds the following attributes to spans: + +- `factory_bot.strategy` - The internal strategy name (create, build, stub, attributes_for) +- `factory_bot.factory_name` - The name of the factory being used +- `factory_bot.traits` - Comma-separated list of traits applied (if any) + +## How can I get involved? + +The `opentelemetry-instrumentation-factory_bot` 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 on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] 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-factory_bot` 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 +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/factory_bot/Rakefile b/instrumentation/factory_bot/Rakefile new file mode 100644 index 0000000000..1a64ba842e --- /dev/null +++ b/instrumentation/factory_bot/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/factory_bot/example/trace_demonstration.rb b/instrumentation/factory_bot/example/trace_demonstration.rb new file mode 100644 index 0000000000..bdc46beb6f --- /dev/null +++ b/instrumentation/factory_bot/example/trace_demonstration.rb @@ -0,0 +1,65 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require 'bundler/inline' + +gemfile(true) do + source 'https://rubygems.org' + gem 'opentelemetry-api' + gem 'opentelemetry-instrumentation-base' + gem 'opentelemetry-instrumentation-factory_bot', path: '../' + gem 'opentelemetry-sdk' + gem 'factory_bot' +end + +require 'opentelemetry-api' +require 'opentelemetry-sdk' +require 'opentelemetry-instrumentation-factory_bot' +require 'active_support/core_ext/time' +require 'factory_bot' + +# Export traces to console by default +ENV['OTEL_TRACES_EXPORTER'] ||= 'console' + +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::FactoryBot' +end + +# Define a simple User struct for the factory +User = Struct.new(:name, :email, keyword_init: true) + +# Define a factory +FactoryBot.define do + factory :user do + name { 'Test User' } + email { 'test@example.com' } + + initialize_with { User.new(**attributes) } + end +end + +# Basic examples demonstrating FactoryBot instrumentation +puts "=== FactoryBot OpenTelemetry Instrumentation Example ===" +puts + +puts "1. Building a single user with FactoryBot.build:" +user = FactoryBot.build(:user) +puts " Created: #{user.inspect}" +puts + +puts "2. Building a list of users with FactoryBot.build_list:" +users = FactoryBot.build_list(:user, 3) +puts " Created #{users.size} users" +puts + +puts "3. Building stubbed users with FactoryBot.build_stubbed:" +stubbed_user = FactoryBot.build_stubbed(:user) +puts " Created stubbed user: #{stubbed_user.inspect}" +puts + +puts "4. Getting attributes with FactoryBot.attributes_for:" +attrs = FactoryBot.attributes_for(:user) +puts " Attributes: #{attrs.inspect}" +puts + +puts "=== All operations created OpenTelemetry spans shown above ===" diff --git a/instrumentation/factory_bot/lib/opentelemetry-instrumentation-factory_bot.rb b/instrumentation/factory_bot/lib/opentelemetry-instrumentation-factory_bot.rb new file mode 100644 index 0000000000..c034f140f8 --- /dev/null +++ b/instrumentation/factory_bot/lib/opentelemetry-instrumentation-factory_bot.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/factory_bot/lib/opentelemetry/instrumentation.rb b/instrumentation/factory_bot/lib/opentelemetry/instrumentation.rb new file mode 100644 index 0000000000..de9c3a458d --- /dev/null +++ b/instrumentation/factory_bot/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/factory_bot' diff --git a/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot.rb b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot.rb new file mode 100644 index 0000000000..28650893f8 --- /dev/null +++ b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot.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 FactoryBot gem + module FactoryBot + end + end +end + +require_relative 'factory_bot/instrumentation' +require_relative 'factory_bot/version' diff --git a/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/instrumentation.rb b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/instrumentation.rb new file mode 100644 index 0000000000..b7e6c041b5 --- /dev/null +++ b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/instrumentation.rb @@ -0,0 +1,48 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module FactoryBot + # The Instrumentation class contains logic to detect and install the FactoryBot instrumentation + class Instrumentation < OpenTelemetry::Instrumentation::Base + MINIMUM_VERSION = Gem::Version.new('4.0') + + install do |_config| + require_dependencies + add_subscriber + end + + present do + defined?(::FactoryBot) + end + + compatible do + !defined?(::ActiveSupport::Notifications).nil? && gem_version >= MINIMUM_VERSION + end + + private + + def require_dependencies + require_relative 'run_factory_subscriber' + end + + def add_subscriber + subscriber = RunFactorySubscriber.new + ::ActiveSupport::Notifications.subscribe('factory_bot.run_factory', subscriber) + end + + def gem_version + if defined?(::FactoryBot::VERSION) + Gem::Version.new(::FactoryBot::VERSION) + else + Gem::Version.new('0.0.0') + end + end + end + end + end +end diff --git a/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/run_factory_subscriber.rb b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/run_factory_subscriber.rb new file mode 100644 index 0000000000..ea9653a91e --- /dev/null +++ b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/run_factory_subscriber.rb @@ -0,0 +1,61 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module FactoryBot + # Subscriber for factory_bot.run_factory ActiveSupport::Notifications + class RunFactorySubscriber + def tracer + FactoryBot::Instrumentation.instance.tracer + end + + def start(_name, _id, payload) + factory_name = payload[:name] + strategy_symbol = payload[:strategy].to_sym + traits = payload[:traits] || [] + + # Map user-facing strategy names to internal strategy names + internal_strategy = case strategy_symbol + when :build_stubbed then 'stub' + else strategy_symbol.to_s + end + + span_name = "FactoryBot.#{strategy_symbol}(#{factory_name})" + + attrs = { + 'factory_bot.strategy' => internal_strategy, + 'factory_bot.factory_name' => factory_name.to_s + } + + attrs['factory_bot.traits'] = traits.join(',') if traits.any? + + span = tracer.start_span(span_name, kind: :internal, attributes: attrs) + token = OpenTelemetry::Context.attach(OpenTelemetry::Trace.context_with_span(span)) + + payload.merge!( + __opentelemetry_span: span, + __opentelemetry_ctx_token: token + ) + end + + def finish(_name, _id, payload) + span = payload.delete(:__opentelemetry_span) + token = payload.delete(:__opentelemetry_ctx_token) + return unless span && token + + if (e = payload[:exception_object]) + span.record_exception(e) + span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}") + end + + span.finish + OpenTelemetry::Context.detach(token) + end + end + end + end +end diff --git a/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/version.rb b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/version.rb new file mode 100644 index 0000000000..6ca4cc1b0b --- /dev/null +++ b/instrumentation/factory_bot/lib/opentelemetry/instrumentation/factory_bot/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 FactoryBot + VERSION = '0.1.0' + end + end +end diff --git a/instrumentation/factory_bot/opentelemetry-instrumentation-factory_bot.gemspec b/instrumentation/factory_bot/opentelemetry-instrumentation-factory_bot.gemspec new file mode 100644 index 0000000000..ddd786e3b7 --- /dev/null +++ b/instrumentation/factory_bot/opentelemetry-instrumentation-factory_bot.gemspec @@ -0,0 +1,37 @@ +# 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/factory_bot/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-instrumentation-factory_bot' + spec.version = OpenTelemetry::Instrumentation::FactoryBot::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'FactoryBot instrumentation for the OpenTelemetry framework' + spec.description = 'FactoryBot 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 = ">= #{File.read(File.expand_path('../../gemspecs/RUBY_REQUIREMENT', __dir__))}" + + spec.add_dependency 'activesupport', '>= 4.0' + spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.24.0' + + 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/factory_bot' + 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/factory_bot/test/opentelemetry/instrumentation/factory_bot/instrumentation_test.rb b/instrumentation/factory_bot/test/opentelemetry/instrumentation/factory_bot/instrumentation_test.rb new file mode 100644 index 0000000000..ca7811ba83 --- /dev/null +++ b/instrumentation/factory_bot/test/opentelemetry/instrumentation/factory_bot/instrumentation_test.rb @@ -0,0 +1,216 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../lib/opentelemetry/instrumentation/factory_bot' + +# Define simple test classes for factories +User = Struct.new(:id, :name, :email, keyword_init: true) +Admin = Struct.new(:id, :name, :email, :admin, keyword_init: true) + +describe OpenTelemetry::Instrumentation::FactoryBot do + let(:instrumentation) { OpenTelemetry::Instrumentation::FactoryBot::Instrumentation.instance } + let(:exporter) { EXPORTER } + + before do + exporter.reset + + # Clean up any existing factory definitions + FactoryBot.reload + + # Define test factories + FactoryBot.define do + factory :user do + sequence(:name) { |n| "User #{n}" } + sequence(:email) { |n| "user#{n}@example.com" } + + initialize_with { new(**attributes) } + end + + factory :admin do + sequence(:name) { |n| "Admin #{n}" } + sequence(:email) { |n| "admin#{n}@example.com" } + admin { true } + + initialize_with { new(**attributes) } + end + end + end + + after do + # Reset instrumentation state for isolation + instrumentation.instance_variable_set(:@installed, false) + end + + # Basic instrumentation tests + it 'has #name' do + _(instrumentation.name).must_equal 'OpenTelemetry::Instrumentation::FactoryBot' + 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) + end + end + + describe '#compatible?' do + it 'returns true for FactoryBot 4.0+' do + _(instrumentation.compatible?).must_equal(true) + end + end + + # Strategy tests - FactoryBot.create + describe 'FactoryBot.create' do + before do + instrumentation.install({}) + end + + it 'creates a span for FactoryBot.create' do + # Using build instead of create to avoid needing database in tests + FactoryBot.build(:user) + + spans = exporter.finished_spans + _(spans).wont_be_empty + # For now, just verify instrumentation is working + # We'll fix span matching once implementation is done + end + end + + # Strategy tests - FactoryBot.build + describe 'FactoryBot.build' do + before do + instrumentation.install({}) + end + + it 'creates a span for FactoryBot.build' do + FactoryBot.build(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.build') } + _(span).wont_be_nil + end + + it 'sets factory_bot.strategy attribute to build' do + FactoryBot.build(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.build') } + _(span.attributes['factory_bot.strategy']).must_equal 'build' + end + + it 'sets factory_bot.factory_name attribute' do + FactoryBot.build(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.build') } + _(span.attributes['factory_bot.factory_name']).must_equal 'user' + end + end + + # Strategy tests - FactoryBot.build_stubbed + describe 'FactoryBot.build_stubbed' do + before do + instrumentation.install({}) + end + + it 'creates a span for FactoryBot.build_stubbed' do + FactoryBot.build_stubbed(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.build_stubbed') } + _(span).wont_be_nil + end + + it 'sets factory_bot.strategy attribute to stub' do + FactoryBot.build_stubbed(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.build_stubbed') } + _(span.attributes['factory_bot.strategy']).must_equal 'stub' + end + + it 'sets factory_bot.factory_name attribute' do + FactoryBot.build_stubbed(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.build_stubbed') } + _(span.attributes['factory_bot.factory_name']).must_equal 'user' + end + end + + # Strategy tests - FactoryBot.attributes_for + describe 'FactoryBot.attributes_for' do + before do + instrumentation.install({}) + end + + it 'creates a span for FactoryBot.attributes_for' do + FactoryBot.attributes_for(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.attributes_for') } + _(span).wont_be_nil + end + + it 'sets factory_bot.strategy attribute to attributes_for' do + FactoryBot.attributes_for(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.attributes_for') } + _(span.attributes['factory_bot.strategy']).must_equal 'attributes_for' + end + + it 'sets factory_bot.factory_name attribute' do + FactoryBot.attributes_for(:user) + + span = exporter.finished_spans.find { |s| s.name.include?('FactoryBot.attributes_for') } + _(span.attributes['factory_bot.factory_name']).must_equal 'user' + end + end + + # Batch operation tests + describe 'FactoryBot.build_list' do + before do + instrumentation.install({}) + end + + it 'creates spans for each item in FactoryBot.build_list' do + FactoryBot.build_list(:user, 3) + + spans = exporter.finished_spans.select { |s| s.name.include?('FactoryBot.build') } + _(spans.size).must_equal 3 + end + end + + describe 'FactoryBot.build_pair' do + before do + instrumentation.install({}) + end + + it 'creates spans for each item in FactoryBot.build_pair' do + FactoryBot.build_pair(:user) + + spans = exporter.finished_spans.select { |s| s.name.include?('FactoryBot.build') } + _(spans.size).must_equal 2 + end + end + + # Test multiple factory types + describe 'multiple factories' do + before do + instrumentation.install({}) + end + + it 'correctly identifies different factories' do + FactoryBot.build(:user) + FactoryBot.build(:admin) + + spans = exporter.finished_spans.select { |s| s.name.include?('FactoryBot.build') } + factory_names = spans.map { |s| s.attributes['factory_bot.factory_name'] } + + _(factory_names).must_include 'user' + _(factory_names).must_include 'admin' + end + end +end diff --git a/instrumentation/factory_bot/test/test_helper.rb b/instrumentation/factory_bot/test/test_helper.rb new file mode 100644 index 0000000000..6b54844e60 --- /dev/null +++ b/instrumentation/factory_bot/test/test_helper.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'simplecov' +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'active_support/core_ext/time' +require 'active_support/core_ext/hash/indifferent_access' +require 'factory_bot' +require 'opentelemetry/sdk' +require 'opentelemetry-test-helpers' + +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