Merge branch 'main' into instrumentation-actionmailer-process

mrsimo · web-flow · commit 341fb84e9014 · 2024-10-03T11:22:58.000+02:00
diff --git a/.github/actions/test_gem/action.yml b/.github/actions/test_gem/action.yml
@@ -66,7 +66,7 @@ runs:
     # ...but not for appraisals, sadly.
     - name: Install Ruby ${{ inputs.ruby }} with dependencies
       if: "${{ steps.setup.outputs.appraisals == 'false' }}"
-      uses: ruby/setup-ruby@v1.191.0
+      uses: ruby/setup-ruby@v1.194.0
       with:
         ruby-version: "${{ inputs.ruby }}"
         working-directory: "${{ steps.setup.outputs.gem_dir }}"
@@ -77,7 +77,7 @@ runs:
     # If we're using appraisals, do it all manually.
     - name: Install Ruby ${{ inputs.ruby }} without dependencies
       if: "${{ steps.setup.outputs.appraisals == 'true' }}"
-      uses: ruby/setup-ruby@v1.191.0
+      uses: ruby/setup-ruby@v1.194.0
       with:
         ruby-version: "${{ inputs.ruby }}"
         bundler:  "latest"
diff --git a/.github/workflows/installation-tests.yml b/.github/workflows/installation-tests.yml
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@v4
         # ATTENTION: Dependabot does not know how to update shared actions file.
         # If you see it update setup-ruby here also update it as part of actions/test_gem/action.yml
-      - uses: ruby/setup-ruby@v1.191.0
+      - uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ matrix.ruby-version }}
       - name: "Install Latest Gem Versions on ${{ matrix.ruby-version }}"
diff --git a/.github/workflows/release-hook-on-closed.yml b/.github/workflows/release-hook-on-closed.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.191.0
+        uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-hook-on-push.yml b/.github/workflows/release-hook-on-push.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.191.0
+        uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-perform.yml b/.github/workflows/release-perform.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.191.0
+        uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-please.yaml b/.github/workflows/release-please.yaml
@@ -50,7 +50,7 @@ jobs:
           chmod 0600 $HOME/.gem/credentials
           printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
 
-      - uses: ruby/setup-ruby@v1.191.0
+      - uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: "3.0"
           bundler: latest
diff --git a/.github/workflows/release-request-weekly.yml b/.github/workflows/release-request-weekly.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.191.0
+        uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-request.yml b/.github/workflows/release-request.yml
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.191.0
+        uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-retry.yml b/.github/workflows/release-retry.yml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.191.0
+        uses: ruby/setup-ruby@v1.194.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -80,6 +80,12 @@ For example, to test `opentelemetry-instrumentation-action_pack` you would:
  2. Install the bundle with `bundle install`
  3. Run the tests with `bundle exec rake`
 
+Note: Some test suites make use of [Appraisal](https://github.com/thoughtbot/appraisal), a library for testing against different versions of dependencies. To run tests in suites that use Appraisal:
+
+ 1. Change directory to the instrumentation you'd like to test, ex: `instrumentation/action_pack`
+ 2. Install the bundle with `bundle exec appraisal install`
+ 3. Run the tests with `bundle exec appraisal rake test`
+
 ### Docker setup
 
 We use Docker Compose to configure and build services used in development and
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -217,7 +217,7 @@ services:
     image: memcached:alpine
     command: memcached -m 64
     ports:
-     - "11211:11211"
+      - "11211:11211"
 
   zookeeper:
     image: confluentinc/cp-zookeeper:latest
@@ -248,8 +248,8 @@ services:
       - "16686:16686"
 
   otelcol:
-    image: otel/opentelemetry-collector:0.54.0
-    command: [ "--config=/etc/otelcol-config.yml" ]
+    image: otel/opentelemetry-collector:0.109.0
+    command: ["--config=/etc/otelcol-config.yml"]
     volumes:
       - ./otelcol-config.yml:/etc/otelcol-config.yml
     ports:
diff --git a/instrumentation/que/lib/opentelemetry/instrumentation/que/patches/que_job.rb b/instrumentation/que/lib/opentelemetry/instrumentation/que/patches/que_job.rb
@@ -19,6 +19,10 @@ class << base
           # Module to prepend to Que singleton class
           module ClassMethods
             def enqueue(*args, job_options: {}, **arg_opts)
+              # In Que version 2.1.0 `bulk_enqueue` was introduced.
+              # In that case, the span is created inside the `bulk_enqueue` method.
+              return super(*args, **arg_opts) if gem_version >= Gem::Version.new('2.1.0') && Thread.current[:que_jobs_to_bulk_insert]
+
               tracer = Que::Instrumentation.instance.tracer
               otel_config = Que::Instrumentation.instance.config
 
@@ -43,19 +47,8 @@ def enqueue(*args, job_options: {}, **arg_opts)
                   OpenTelemetry.propagation.inject(tags, setter: TagSetter)
                 end
 
-                # In Que version 2.1.0 `bulk_enqueue` was introduced and in order
-                # for it to work, we must pass `job_options` to `bulk_enqueue` instead of enqueue.
-                if gem_version >= Gem::Version.new('2.1.0') && Thread.current[:que_jobs_to_bulk_insert]
-                  Thread.current[:que_jobs_to_bulk_insert][:job_options] = Thread.current[:que_jobs_to_bulk_insert][:job_options]&.merge(tags: tags) do |_, a, b|
-                    a.is_a?(Array) && b.is_a?(Array) ? a.concat(b) : b
-                  end
-
-                  job = super(*args, **arg_opts)
-                  job_attrs = Thread.current[:que_jobs_to_bulk_insert][:jobs_attrs].last
-                else
-                  job = super(*args, job_options: job_options.merge(tags: tags), **arg_opts)
-                  job_attrs = job.que_attrs
-                end
+                job = super(*args, job_options: job_options.merge(tags: tags), **arg_opts)
+                job_attrs = job.que_attrs
 
                 span.name = "#{job_attrs[:job_class]} publish"
                 span.add_attributes(QueJob.job_attributes(job_attrs))
@@ -67,6 +60,32 @@ def enqueue(*args, job_options: {}, **arg_opts)
             def gem_version
               @gem_version ||= Gem.loaded_specs['que'].version
             end
+
+            if Gem.loaded_specs['que'].version >= Gem::Version.new('2.1.0')
+              def bulk_enqueue(**_kwargs, &block)
+                tracer = Que::Instrumentation.instance.tracer
+                otel_config = Que::Instrumentation.instance.config
+
+                tracer.in_span('publish', kind: :producer) do |span|
+                  super do
+                    yield
+
+                    job_attrs = Thread.current[:que_jobs_to_bulk_insert][:jobs_attrs]
+
+                    unless job_attrs.empty?
+                      span.name = "#{job_attrs.first[:job_class]} publish"
+                      span.add_attributes(QueJob.job_attributes(job_attrs.first))
+                    end
+
+                    if otel_config[:propagation_style] != :none
+                      job_options = Thread.current[:que_jobs_to_bulk_insert][:job_options]
+                      job_options[:tags] ||= []
+                      OpenTelemetry.propagation.inject(job_options[:tags], setter: TagSetter)
+                    end
+                  end
+                end
+              end
+            end
           end
 
           def self.job_attributes(job_attrs)
diff --git a/instrumentation/que/test/opentelemetry/instrumentation/que_test.rb b/instrumentation/que/test/opentelemetry/instrumentation/que_test.rb
@@ -304,6 +304,74 @@ def self.run(first, second); end
         end
       end
 
+      describe 'enqueueing multiple jobs' do
+        it 'creates a span' do
+          Que.bulk_enqueue do
+            10.times { TestJobAsync.enqueue }
+          end
+
+          _(finished_spans.size).must_equal(1)
+
+          span = finished_spans.last
+          _(span.kind).must_equal(:producer)
+        end
+
+        it 'names the created span' do
+          Que.bulk_enqueue do
+            10.times { TestJobAsync.enqueue }
+          end
+
+          span = finished_spans.last
+          _(span.name).must_equal('TestJobAsync publish')
+        end
+
+        it 'links spans together' do
+          bulk_jobs = Que.bulk_enqueue do
+            10.times { TestJobAsync.enqueue }
+          end
+
+          bulk_jobs.each { |job| Que.run_job_middleware(job) { job.tap(&:_run) } }
+
+          _(finished_spans.size).must_equal(11)
+
+          publish_span = finished_spans.first
+
+          process_spans = finished_spans.drop(1)
+
+          process_spans.each do |process_span|
+            _(publish_span.trace_id).wont_equal(process_span.trace_id)
+
+            _(process_span.total_recorded_links).must_equal(1)
+            _(process_span.links[0].span_context.trace_id).must_equal(publish_span.trace_id)
+            _(process_span.links[0].span_context.span_id).must_equal(publish_span.span_id)
+          end
+        end
+
+        it 'records attributes' do
+          Que.bulk_enqueue do
+            10.times { TestJobAsync.enqueue }
+          end
+
+          attributes = finished_spans.last.attributes
+          _(attributes['messaging.system']).must_equal('que')
+          _(attributes['messaging.destination']).must_equal('default')
+          _(attributes['messaging.destination_kind']).must_equal('queue')
+          _(attributes['messaging.operation']).must_equal('publish')
+          _(attributes['messaging.que.job_class']).must_equal('TestJobAsync')
+          _(attributes['messaging.que.priority']).must_equal(100)
+          _(attributes.key?('messaging.message_id')).must_equal(false)
+        end
+      end
+
+      describe 'enqueueing zero jobs' do
+        it 'creates a span' do
+          Que.bulk_enqueue do
+          end
+
+          _(finished_spans.size).must_equal(1)
+        end
+      end
+
       describe 'processing a job' do
         before do
           bulk_job = Que.bulk_enqueue do
@@ -363,10 +431,10 @@ def self.run(first, second); end
 
           _(finished_spans.size).must_equal(2)
 
-          span1 = finished_spans.first
+          span1 = finished_spans.last
           _(span1.kind).must_equal(:producer)
 
-          span2 = finished_spans.last
+          span2 = finished_spans.first
           _(span2.kind).must_equal(:consumer)
         end
 
@@ -375,10 +443,10 @@ def self.run(first, second); end
             TestJobSync.enqueue
           end
 
-          span1 = finished_spans.first
+          span1 = finished_spans.last
           _(span1.name).must_equal('TestJobSync publish')
 
-          span2 = finished_spans.last
+          span2 = finished_spans.first
           _(span2.name).must_equal('TestJobSync process')
         end
 
@@ -387,7 +455,7 @@ def self.run(first, second); end
             TestJobSync.enqueue
           end
 
-          attributes = finished_spans.last.attributes
+          attributes = finished_spans.first.attributes
           _(attributes['messaging.system']).must_equal('que')
           _(attributes['messaging.destination']).must_equal('default')
           _(attributes['messaging.destination_kind']).must_equal('queue')
diff --git a/otelcol-config.yml b/otelcol-config.yml
@@ -2,13 +2,15 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
+        endpoint: 0.0.0.0:4318
 exporters:
-  jaeger:
-    endpoint: "jaeger:14250"
+  otlp:
+    endpoint: "jaeger:4317"
     tls:
       insecure: true
-  logging:
+  debug:
 
 processors:
   batch:
@@ -18,4 +20,4 @@ service:
     traces:
       receivers: [otlp]
       processors: [batch]
-      exporters: [logging, jaeger]
+      exporters: [debug, otlp]
diff --git a/propagator/vitess/README.md b/propagator/vitess/README.md
@@ -40,7 +40,7 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-vitess
 Configure your application to use this propagator with the Trilogy client instrumentation by setting the following [environment variable][envars]:
 
 ```console
-OTEL_RUBY_INSTRUMENTATION_TRILOGY_PROPAGATOR=vitess
+OTEL_RUBY_INSTRUMENTATION_TRILOGY_CONFIG_OPTS=propagator=vitess
 ```
 
 ## How can I get involved?
