feat: Add ActiveStorage instrumentation (#1313)

* feat: Add ActiveStorage instrumentation

* fix: markdown lint error in README.md

* fix: rubocop error in opentelemetry-instrumentation-all.gemspec

* feat: remove support for Rails 6.1

* docs: add default value on `:disallowed_notification_payload_keys`

* feat: match rubocop and opentelemetry-instrumentation-base version with other packages

* test: add explicit require to `logger`

* test: remove unnecessary conditions

* chore: add imagemagick package to Dockerfile

* feat: change active_storage instrumentation version to 0.1.0 and remove active_storage from all

* chore: update instrumentation/active_storage CODEOWNERS

---------

Co-authored-by: Kayla Reopelle <[email protected]>

Author: ymtdzzz

.github/actions/test_gem/action.yml

@@ -62,6 +62,14 @@ runs:
           fi
         fi
 
+    # Install ImageMagick for active_storage testing.
+    # Unfortunately, as of ubuntu-24.04, ImageMagick is no longer pre-installed in Github Actions.
+    # See https://github.com/actions/runner-images/issues/10772
+    - name: Install ImageMagick for active_storage testing
+      if: "${{ inputs.gem == 'opentelemetry-instrumentation-active_storage' }}"
+      shell: bash
+      run: sudo apt update && sudo apt install -y imagemagick
+
     # Install ruby and bundle dependencies and cache!
     # ...but not for appraisals, sadly.
     - name: Install Ruby ${{ inputs.ruby }} with dependencies

.github/workflows/ci-instrumentation.yml

@@ -27,6 +27,7 @@ jobs:
           - active_job
           - active_model_serializers
           - active_record
+          - active_storage
           - active_support
           - all
           - aws_sdk
@@ -86,6 +87,7 @@ jobs:
           [[ "${{ matrix.gem }}" == "action_view"              ]] && echo "skip=true" >> $GITHUB_OUTPUT
           [[ "${{ matrix.gem }}" == "active_model_serializers" ]] && echo "skip=true" >> $GITHUB_OUTPUT
           [[ "${{ matrix.gem }}" == "active_record"            ]] && echo "skip=true" >> $GITHUB_OUTPUT
+          [[ "${{ matrix.gem }}" == "active_storage"           ]] && echo "skip=true" >> $GITHUB_OUTPUT
           [[ "${{ matrix.gem }}" == "active_support"           ]] && echo "skip=true" >> $GITHUB_OUTPUT
           [[ "${{ matrix.gem }}" == "aws_sdk"                  ]] && echo "skip=true" >> $GITHUB_OUTPUT
           [[ "${{ matrix.gem }}" == "aws_lambda"               ]] && echo "skip=true" >> $GITHUB_OUTPUT

.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-active_storage
+    directory: instrumentation/active_storage
+    version_constant: [OpenTelemetry, Instrumentation, ActiveStorage, VERSION]
+
   - name: opentelemetry-helpers-sql
     directory: helpers/sql
     version_constant: [OpenTelemetry, Helpers, Sql, VERSION]

CODEOWNERS

@@ -16,6 +16,8 @@
 
 resources/container/ @scbjans @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi
 
+instrumentation/active_storage/ @ymtdzzz @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi
+
 instrumentation/aws_sdk/ @jterapin @alextwoods @NathanielRN @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi
 
 instrumentation/grape/ @muripic @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi

Dockerfile

@@ -38,6 +38,7 @@ ARG PACKAGES="\
     postgresql-dev \
     tzdata \
     util-linux \
+    imagemagick \
     "
 # Install packages
 RUN apk update && \

instrumentation/active_storage/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: ../../.rubocop.yml

instrumentation/active_storage/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Active Storage Instrumentation
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/instrumentation/**/*.rb
+./lib/opentelemetry/instrumentation.rb
+-
+README.md
+CHANGELOG.md

instrumentation/active_storage/Appraisals

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+%w[7.0.0 7.1.0].each do |version|
+  appraise "activestorage-#{version}" do
+    gem 'sqlite3', '~> 1.4'
+    gem 'image_processing', '~> 1.2'
+    gem 'rails', "~> #{version}"
+  end
+end
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1.0')
+  %w[7.2.0].each do |version|
+    appraise "activestorage-#{version}" do
+      gem 'sqlite3', '~> 1.4'
+      gem 'image_processing', '~> 1.2'
+      gem 'rails', "~> #{version}"
+    end
+  end
+
+  appraise 'activestorage-latest' do
+    gem 'sqlite3', '>= 2.1'
+    gem 'image_processing', '~> 1.2'
+    gem 'rails'
+  end
+end

instrumentation/active_storage/CHANGELOG.md

@@ -0,0 +1 @@
+# Release History: opentelemetry-instrumentation-active_storage

instrumentation/active_storage/Gemfile

@@ -0,0 +1,14 @@
+# 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 'opentelemetry-instrumentation-active_support', path: '../active_support'
+end