activerecord-honeycomb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5513e1bf298b293e26b56aeaeb4d01d1f30f1f886523af3d7207c94c3649b191
-  data.tar.gz: 44d8d740273a31a1c0474f5225ee6879a43afa903fbfdf7854e6a6c5372eb1e8
+  metadata.gz: e2bc4eab86d0578bcb7c93ef32c30c4b49b68a8b5140611253d9cc45572a1f66
+  data.tar.gz: 8c597b10ed77363ea930a794ccbf9f7bb91f93b1782e42671bcf115b7983b7b2
 SHA512:
-  metadata.gz: d4c0dc2140357e734883e1da31c64d13917b1d8e8cb45f7438b524ebfd6fd7918874e2324b7b8296c0222e02a21465981f3c0114acada918f3c62daae1e1b9e0
-  data.tar.gz: 8f0bfed8173a460fe3fe505191aeb7b1236b55a26e127b7b911675e94d19493347f65bf2381f1964ad9a0312b3882a082eec191555199057176050ac5fc41ce4
+  metadata.gz: 5320563ca868a56c0245042e13e4a0cd5eb0321e35f60cf06ab711571d6ac1ac49683f33ce2fb0675ff4de4f750d652dc5e783200f7ea492858b0a2f8bd85acd
+  data.tar.gz: d65ea71e23b8a0cc71d1e4579687dac3393ec11a7d3ec38213d0876ed0e94ae417adc527a68fc1dd8ed696f7cc4e3a52ee1ddf44ccb0c1fe80861da6b7b7d06f

data/README.md

@@ -0,0 +1,30 @@
+# Honeycomb Tracing for ActiveRecord
+
+[![Build Status](https://travis-ci.org/honeycombio/activerecord-honeycomb.svg?branch=master)](https://travis-ci.org/honeycombio/activerecord-honeycomb)
+[![Gem Version](https://badge.fury.io/rb/activerecord-honeycomb.svg)](https://badge.fury.io/rb/activerecord-honeycomb)
+
+This package makes it easy to instrument your ActiveRecord queries in your ruby application to send useful events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
+- [Usage and Examples](https://docs.honeycomb.io/getting-data-in/beelines/ruby-beeline/)
+
+Sign up for a [Honeycomb
+trial](https://ui.honeycomb.io/signup) to obtain an API key before starting.
+
+## Compatible with
+
+Requires Ruby version 2.2 or later
+
+ActiveRecord 4 or later
+
+## Get in touch
+
+Please reach out to [support@honeycomb.io](mailto:support@honeycomb.io) or ping
+us with the chat bubble on [our website](https://www.honeycomb.io) for any
+assistance. We also welcome [bug reports](https://github.com/honeycombio/activerecord-honeycomb/issues).
+
+## Contributions
+
+Features, bug fixes and other changes to `activerecord-honeycomb` are gladly accepted. Please
+open issues or a pull request with your change. Remember to add your name to the
+CONTRIBUTORS file!
+
+All contributions will be released under the Apache License 2.0.

data/lib/active_record/connection_adapters/honeycomb_adapter.rb

@@ -69,7 +69,7 @@ module ActiveRecord
 
       def execute(sql, name = nil, *args)
         sending_honeycomb_event(sql, name, []) do |event|
-          adding_span_metadata_if_available(event) do
+          with_tracing_if_available(event) do
             super
           end
         end
@@ -77,7 +77,7 @@ module ActiveRecord
 
       def exec_query(sql, name = 'SQL', binds = [], *args)
         sending_honeycomb_event(sql, name, binds) do |event|
-          adding_span_metadata_if_available(event) do
+          with_tracing_if_available(event) do
             super
           end
         end
@@ -85,7 +85,7 @@ module ActiveRecord
 
       def exec_insert(sql, name, binds, *args)
         sending_honeycomb_event(sql, name, binds) do |event|
-          adding_span_metadata_if_available(event) do
+          with_tracing_if_available(event) do
             super
           end
         end
@@ -93,7 +93,7 @@ module ActiveRecord
 
       def exec_delete(sql, name, binds = [], *args)
         sending_honeycomb_event(sql, name, binds) do |event|
-          adding_span_metadata_if_available(event) do
+          with_tracing_if_available(event) do
             super
           end
         end
@@ -101,7 +101,7 @@ module ActiveRecord
 
       def exec_update(sql, name, binds = [], *args)
         sending_honeycomb_event(sql, name, binds) do |event|
-          adding_span_metadata_if_available(event) do
+          with_tracing_if_available(event) do
             super
           end
         end
@@ -159,17 +159,32 @@ module ActiveRecord
         sql.sub(/\s+.*/, '').upcase
       end
 
-      def adding_span_metadata_if_available(event)
-        return yield unless event && defined?(::Honeycomb.trace_id)
+      def with_tracing_if_available(event)
+        # return if we are not using the ruby beeline
+        return yield unless event && defined?(::Honeycomb)
 
-        trace_id = ::Honeycomb.trace_id
+        # beeline version <= 0.5.0
+        if ::Honeycomb.respond_to? :trace_id
+          trace_id = ::Honeycomb.trace_id
+          event.add_field 'trace.trace_id', trace_id if trace_id
+          span_id = SecureRandom.uuid
+          event.add_field 'trace.span_id', span_id
 
-        event.add_field 'trace.trace_id', trace_id if trace_id
-        span_id = SecureRandom.uuid
-        event.add_field 'trace.span_id', span_id
-
-        ::Honeycomb.with_span_id(span_id) do |parent_span_id|
-          event.add_field 'trace.parent_id', parent_span_id
+          ::Honeycomb.with_span_id(span_id) do |parent_span_id|
+            event.add_field 'trace.parent_id', parent_span_id
+            yield
+          end
+        # beeline version > 0.5.0
+        elsif ::Honeycomb.respond_to? :span_for_existing_event
+          ::Honeycomb.span_for_existing_event(
+            event,
+            name: nil, # leave blank since we set it above
+            type: 'db',
+          ) do
+            yield
+          end
+        # fallback if we don't detect any known beeline tracing methods
+        else
           yield
         end
       end

data/lib/active_record/honeycomb/version.rb

@@ -1,6 +1,6 @@
 module ActiveRecord
   module Honeycomb
     GEM_NAME = 'activerecord-honeycomb'
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-honeycomb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Stokes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -143,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/active_record/connection_adapters/honeycomb_adapter.rb
 - lib/active_record/honeycomb.rb
 - lib/active_record/honeycomb/version.rb