bc-lightstep-ruby 1.1.8 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cb5dab38cc9f046ed427e5ecccad6cb61349a87af82bdf5b7531e7b48058765
-  data.tar.gz: f55e6662e3cfec30437ff8b7357598f1fb24278340fb2e0c51ab2cb3ec573f47
+  metadata.gz: c2b20374a58de581ce773fa99fb7638be8b1bcc850838a982267c84c9e382a35
+  data.tar.gz: 4c142c796b5be6d4613e22241a20358caf0f9d21d7d80600e1a8909e2011fb55
 SHA512:
-  metadata.gz: b1b59b7f0cfc79daaf4bb35f76970d2d1b7fe9eec5a96f86c043fd3dab03b597747b3f06a992172b5763ac5d9fa958a6026dece3f9d68f817aa3739feb44f574
-  data.tar.gz: a8d02320ac6d91ff706b0b5778ee3a35d8d39958f77007745e36d5b528d5c5b0a8fd5e7bcc85785c97456bae0b94b75dae21e9601da49c5248e5ee5137c93206
+  metadata.gz: 9ebdd12a9a51e45ec80cd21c44b94b8798c3bb5b6fd14c968da7daf80bb2e91f50979e71ac9e5cacb750047b92027804328144f0e274998d066c18b266cf59ff
+  data.tar.gz: 2cb510ec6d18e4046b73c1aec3abbc73b4675b06cd791591c0b3be1c899258a9c41518ffba92af72f7858ed1de19f9a7e499ebaef799f11a664bdeb3730424a4

data/CHANGELOG.md

@@ -2,6 +2,13 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.2.0
+
+- Bump lightstep gem to 0.13
+- Add LIGHTSTEP_MAX_BUFFERED_SPANS config ENV + setting for maximum number of spans to buffer
+- Add LIGHTSTEP_MAX_LOG_RECORDS config ENV + setting for maximum number of log records that can be on a span
+- Add LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS config ENV + setting for max reporting flush interval to collector
+
 h3. 1.1.8
 
 - Handle issue that occurs if lightstep is disabled but the start_span method is still called

data/README.md

@@ -40,13 +40,16 @@ bc-lightstep-ruby can be automatically configured from these ENV vars, if you'd
 
 | Name | Description |
 | ---- | ----------- |
-| LIGHTSTEP_ENABLED | Flag to determine whether to broadcast spans. Defaults to 1 (enabled) and 0 will disable.|
-| LIGHTSTEP_COMPONENT_NAME | The component name to use |
-| LIGHTSTEP_ACCESS_TOKEN | The access token to use to connect to the collector |
-| LIGHTSTEP_HOST | Host of the collector. Defaults to `lightstep-collector.linkerd` |
-| LIGHTSTEP_PORT | Port of the collector. Defaults to `4140` |
-| LIGHTSTEP_SSL_VERIFY_PEER | If using 443 as the port, toggle SSL verification. Defaults to true. |
-| LIGHTSTEP_VERBOSITY | The verbosity level of lightstep logs. Defaults to 1. |
+| LIGHTSTEP_ENABLED | Flag to determine whether to broadcast spans. Defaults to (1) enabled, 0 will disable.| 1 |
+| LIGHTSTEP_COMPONENT_NAME | The component name to use | '' | 
+| LIGHTSTEP_ACCESS_TOKEN | The access token to use to connect to the collector | '' | 
+| LIGHTSTEP_HOST | Host of the collector. | `lightstep-collector.linkerd` |
+| LIGHTSTEP_PORT | Port of the collector. | `4140` |
+| LIGHTSTEP_SSL_VERIFY_PEER | If using 443 as the port, toggle SSL verification. | true |
+| LIGHTSTEP_MAX_BUFFERED_SPANS | The maximum number of spans to buffer before dropping. | `1_000` |
+| LIGHTSTEP_MAX_LOG_RECORDS | Maximum number of log records on a span to accept. | `1_000` |
+| LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS | The maximum number of seconds to wait before flushing the report to the collector. | 3.0 |
+| LIGHTSTEP_VERBOSITY | The verbosity level of lightstep logs. | 1 |
 
 Most systems will only need to customize the component name.
 

data/bc-lightstep-ruby.gemspec

@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
 
-  spec.add_runtime_dependency 'lightstep', '~> 0.11.2'
+  spec.add_runtime_dependency 'lightstep', '~> 0.13.0'
   spec.add_runtime_dependency 'faraday', '~> 0.8'
 end

data/lib/bigcommerce/lightstep.rb

@@ -41,53 +41,9 @@ module Bigcommerce
         component_name: component_name,
         transport: transport_factory.build
       )
+      ::LightStep.instance.max_span_records = ::Bigcommerce::Lightstep.max_buffered_spans
+      ::LightStep.instance.max_log_records = ::Bigcommerce::Lightstep.max_log_records
+      ::LightStep.instance.report_period_seconds = ::Bigcommerce::Lightstep.max_reporting_interval_seconds
     end
   end
 end
-
-# :nocov:
-module LightStep
-  ##
-  # Monkey patch of the LightStep library to make it not swallow reporting errors
-  #
-  class Reporter
-    def flush
-      reset_on_fork
-
-      return if @span_records.empty?
-
-      now = ::LightStep.micros(Time.now)
-
-      span_records = @span_records.slice!(0, @span_records.length)
-      dropped_spans = 0
-      @dropped_spans.update do |old|
-        dropped_spans = old
-        0
-      end
-
-      report_request = {
-        runtime: @runtime,
-        oldest_micros: @report_start_time,
-        youngest_micros: now,
-        span_records: span_records,
-        internal_metrics: {
-          counts: [
-            { name: 'spans.dropped', int64_value: dropped_spans }
-          ]
-        }
-      }
-
-      @report_start_time = now
-
-      begin
-        @transport.report(report_request)
-      rescue StandardError => e
-        Bigcommerce::Lightstep.logger.error "Failed to send request to collector: #{e.message}"
-        # an error occurs, add the previous dropped_spans and count of spans
-        # that would have been recorded
-        @dropped_spans.increment(dropped_spans + span_records.length)
-      end
-    end
-  end
-end
-# :nocov:

data/lib/bigcommerce/lightstep/configuration.rb

@@ -35,6 +35,9 @@ module Bigcommerce
         verbosity: 1,
         http1_error_code: 500,
         http1_error_code_minimum: 500,
+        max_buffered_spans: 1_000,
+        max_log_records: 1_000,
+        max_reporting_interval_seconds: 3.0,
         enabled: true
       }.freeze
 
@@ -91,6 +94,11 @@ module Bigcommerce
         self.host = ENV.fetch('LIGHTSTEP_HOST', 'lightstep-collector.linkerd')
         self.port = ENV.fetch('LIGHTSTEP_PORT', 4140).to_i
         self.ssl_verify_peer = ENV.fetch('LIGHTSTEP_SSL_VERIFY_PEER', true)
+
+        self.max_buffered_spans = ENV.fetch('LIGHTSTEP_MAX_BUFFERED_SPANS', 1_000).to_i
+        self.max_log_records = ENV.fetch('LIGHTSTEP_MAX_LOG_RECORDS', 1_000).to_i
+        self.max_reporting_interval_seconds = ENV.fetch('LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS', 3.0).to_f
+
         self.verbosity = ENV.fetch('LIGHTSTEP_VERBOSITY', 1).to_i
         self.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
         self.enabled = ENV.fetch('LIGHTSTEP_ENABLED', 1).to_i > 0

data/lib/bigcommerce/lightstep/middleware/faraday.rb

@@ -75,8 +75,8 @@ module Bigcommerce
         #
         def inject_ot_tags!(request_env, span)
           request_env[:request_headers].merge!(
-            OT_TAG_TRACE_ID => span.span_context.trace_id.to_s,
-            OT_TAG_SPAN_ID  => span.span_context.id.to_s,
+            OT_TAG_TRACE_ID => span.context.trace_id.to_s,
+            OT_TAG_SPAN_ID  => span.context.id.to_s,
             OT_TAG_SAMPLED  => 'true'
           )
         end

data/lib/bigcommerce/lightstep/version.rb

@@ -15,6 +15,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '1.1.8'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.2.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement