gitlab-labkit 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d4710034737a40d4a0947d4a59eec42c82ebe95d8e1e77b0f8b6a20afd48d0
-  data.tar.gz: 6870c998273ae0bf10572172304f50335f1597e33970454524b42a7557bb551e
+  metadata.gz: 657224369b84dd7d1a8d64ee8096c5dfbcaaa7651772f91f3eea2b0efe9eb1f1
+  data.tar.gz: e37e97a6327e03e935efe210dc5ba04aa57adf52d0c78458bbf50e9fb6c44bd9
 SHA512:
-  metadata.gz: accd3967431bc14bef4fb1ef747b10ed056da881cdde861fa4d361e0c91bd5f309ef4fa46ff097a8806e17fee431757b1fac2d858d3f3f239c66abe76adb2a45
-  data.tar.gz: f7568c0b0ced1de4d217a66951249900497e8c25babd40c567a54cba0163a4945bc67e1dc41662996a69ab4c77348b54aa1df843d52ebf6ea6d5d72d0499ce51
+  metadata.gz: 24f41c7c55ab3530bc62217e6b514c9d2d0ae63528569e12c8693094e3b6da0a8e9fc9679a17c5b281b4ab272b28752522f4d630c4d1e4a5c65cdbdf97c2c6ad
+  data.tar.gz: e2ab5c80c3bbc207e58a816a2f64d524043fc05c0bc4b8baca1124fb42a169bfe03dc89d0023dc383b654ef97a9df14d7d4f14dc045012d3e6ae0e8db7d9feeb

data/README.md

@@ -10,6 +10,10 @@ LabKit-Ruby and LabKit are intended to provide similar functionality, but use th
 
 API Documentation is available at [the Rubydoc site](https://www.rubydoc.info/gems/gitlab-labkit/).
 
+## Changelog
+
+The changelog is available via [**tagged release notes**](https://gitlab.com/gitlab-org/labkit-ruby/tags)
+
 ## Functionality
 
 LabKit-Ruby provides functionality in three areas:

data/gitlab-labkit.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |spec|
   spec.email = ["andrew@gitlab.com"]
 
   spec.summary = "Instrumentation for GitLab"
-  spec.homepage = "http://about.gitlab.com"
+  spec.homepage = "https://gitlab.com/gitlab-org/labkit-ruby"
+  spec.metadata = { "source_code_uri" => "https://gitlab.com/gitlab-org/labkit-ruby" }
   spec.license = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|tools)/}) }

data/lib/labkit/tracing/rails.rb

@@ -6,6 +6,7 @@ module Labkit
     module Rails
       autoload :ActionViewSubscriber, "labkit/tracing/rails/action_view_subscriber"
       autoload :ActiveRecordSubscriber, "labkit/tracing/rails/active_record_subscriber"
+      autoload :ActiveSupportSubscriber, "labkit/tracing/rails/active_support_subscriber"
       autoload :RailsCommon, "labkit/tracing/rails/rails_common"
     end
   end

data/lib/labkit/tracing/rails/active_support_subscriber.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Tracing
+    module Rails
+      # ActiveSupport bridges action active support notifications to
+      # the distributed tracing subsystem
+      class ActiveSupportSubscriber
+        include RailsCommon
+
+        COMPONENT_TAG = "ActiveSupport"
+
+        CACHE_READ_TOPIC = "cache_read.active_support"
+        CACHE_GENERATE_TOPIC = "cache_generate.active_support"
+        CACHE_FETCH_HIT_TOPIC = "cache_fetch_hit.active_support"
+        CACHE_WRITE_TOPIC = "cache_write.active_support"
+        CACHE_DELETE_TOPIC = "cache_delete.active_support"
+
+        # Instruments Rails ActiveSupport events for opentracing.
+        # Returns a lambda, which, when called will unsubscribe from the notifications
+        def self.instrument
+          subscriber = new
+
+          subscriptions = [
+            ActiveSupport::Notifications.subscribe(CACHE_READ_TOPIC) do |_, start, finish, _, payload|
+              subscriber.notify_cache_read(start, finish, payload)
+            end,
+            ActiveSupport::Notifications.subscribe(CACHE_GENERATE_TOPIC) do |_, start, finish, _, payload|
+              subscriber.notify_cache_generate(start, finish, payload)
+            end,
+            ActiveSupport::Notifications.subscribe(CACHE_FETCH_HIT_TOPIC) do |_, start, finish, _, payload|
+              subscriber.notify_cache_fetch_hit(start, finish, payload)
+            end,
+            ActiveSupport::Notifications.subscribe(CACHE_WRITE_TOPIC) do |_, start, finish, _, payload|
+              subscriber.notify_cache_write(start, finish, payload)
+            end,
+            ActiveSupport::Notifications.subscribe(CACHE_DELETE_TOPIC) do |_, start, finish, _, payload|
+              subscriber.notify_cache_delete(start, finish, payload)
+            end,
+          ]
+
+          create_unsubscriber subscriptions
+        end
+
+        # For more information on the payloads: https://guides.rubyonrails.org/active_support_instrumentation.html#active-support
+        def notify_cache_read(start, finish, payload)
+          generate_span_for_notification("cache_read", start, finish, payload, tags_for_cache_read(payload))
+        end
+
+        def notify_cache_generate(start, finish, payload)
+          generate_span_for_notification("cache_generate", start, finish, payload, tags_for_key(payload))
+        end
+
+        def notify_cache_fetch_hit(start, finish, payload)
+          generate_span_for_notification("cache_fetch_hit", start, finish, payload, tags_for_key(payload))
+        end
+
+        def notify_cache_write(start, finish, payload)
+          generate_span_for_notification("cache_write", start, finish, payload, tags_for_key(payload))
+        end
+
+        def notify_cache_delete(start, finish, payload)
+          generate_span_for_notification("cache_delete", start, finish, payload, tags_for_key(payload))
+        end
+
+        private
+
+        def tags_for_cache_read(payload)
+          {
+            "component" => COMPONENT_TAG,
+            "cache.key" => payload[:key],
+            "cache.hit" => payload[:hit],
+            "cache.super_operation" => payload[:super_operation],
+          }
+        end
+
+        def tags_for_key(payload)
+          {
+            "component" => COMPONENT_TAG,
+            "cache.key" => payload[:key],
+          }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -226,16 +226,18 @@ files:
 - lib/labkit/tracing/rails.rb
 - lib/labkit/tracing/rails/action_view_subscriber.rb
 - lib/labkit/tracing/rails/active_record_subscriber.rb
+- lib/labkit/tracing/rails/active_support_subscriber.rb
 - lib/labkit/tracing/rails/rails_common.rb
 - lib/labkit/tracing/sidekiq.rb
 - lib/labkit/tracing/sidekiq/client_middleware.rb
 - lib/labkit/tracing/sidekiq/server_middleware.rb
 - lib/labkit/tracing/sidekiq/sidekiq_common.rb
 - lib/labkit/tracing/tracing_utils.rb
-homepage: http://about.gitlab.com
+homepage: https://gitlab.com/gitlab-org/labkit-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://gitlab.com/gitlab-org/labkit-ruby
 post_install_message: 
 rdoc_options: []
 require_paths: