highlight_io 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adbe799337d2c59b751869b529af2a39efe40c2512bc345b133ffbd3e05eb51
-  data.tar.gz: 24c098762842080dbc45261fe96deb42e1da7da592839eda378a99f22866718c
+  metadata.gz: 92d68b8ab3821bca22f10aac336705ea4bb272f9a62572334715dbab501c5940
+  data.tar.gz: 9175f4a419f534ff297eb9ad907385a0dcf1b4e2366b738ceb438d947cef4876
 SHA512:
-  metadata.gz: 1d2796d575ba7938606af965ba98f72a4dc41d9672d01517e26550fb86e7333233bae97ec6ed769a429b2badd5b7c69fc25c9338205130b6f6185e2342ce451d
-  data.tar.gz: 12502c3c4dce422ca34bb76201dbdb2b3f5de1642e3e1eecaa3f4a546c73eb88091e955e018dab06c44f3ee4e2cd0a2607d50b853a0348f7c0c1c211f10ecd4c
+  metadata.gz: 2c5032942516a6269fab88a89104cceba40b3279603a362142f12cd4340d080b5d484d3314f12076eb2e10c1e7fd8b9d24f7a6a21936665c827c0957139d5a2a
+  data.tar.gz: b89a5c22d6a8a9709c13831e535c38b68d3b10fdc48ca0577809978a57b65eccc374964632e7d0c3e8cf4feafe4f4c9676a6811b6d9ffdf2bedd5e2883023298

data/.rubocop.yml

@@ -10,6 +10,9 @@ Style/Documentation:
 Metrics/MethodLength:
     Enabled: false
 
+Metrics/CyclomaticComplexity:
+    Max: 8
+
 Naming/MethodParameterName:
     Enabled: false
 

data/CHANGELOG.md

@@ -19,3 +19,9 @@
 ## 0.2.2
 
 - Fix duplicate errors recorded on traces.
+
+## 0.4.0
+
+- Add `H.init` alias
+- Auto instrument Rails requests and eliminate need for `around_action`
+- Fix warning about incompatibility with `ActiveSupport::LoggerSilence`

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    highlight_io (0.3.0)
-      grpc (~> 1.52)
+    highlight_io (0.4.0)
+      grpc (~> 1.65)
       opentelemetry-exporter-otlp (~> 0.28.1)
       opentelemetry-instrumentation-all (~> 0.62.1)
       opentelemetry-sdk (~> 1.5.0)
@@ -48,17 +48,17 @@ GEM
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-base (~> 0.22.1)
       opentelemetry-instrumentation-rack (~> 0.21)
-    opentelemetry-instrumentation-action_view (0.7.1)
+    opentelemetry-instrumentation-action_view (0.7.2)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-active_support (~> 0.1)
       opentelemetry-instrumentation-base (~> 0.22.1)
-    opentelemetry-instrumentation-active_job (0.7.4)
+    opentelemetry-instrumentation-active_job (0.7.7)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-base (~> 0.22.1)
     opentelemetry-instrumentation-active_model_serializers (0.20.2)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-base (~> 0.22.1)
-    opentelemetry-instrumentation-active_record (0.7.2)
+    opentelemetry-instrumentation-active_record (0.7.4)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-base (~> 0.22.1)
     opentelemetry-instrumentation-active_support (0.6.0)
@@ -105,7 +105,7 @@ GEM
     opentelemetry-instrumentation-aws_sdk (0.5.4)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-base (~> 0.22.1)
-    opentelemetry-instrumentation-base (0.22.5)
+    opentelemetry-instrumentation-base (0.22.6)
       opentelemetry-api (~> 1.0)
       opentelemetry-common (~> 0.21)
       opentelemetry-registry (~> 0.1)
@@ -176,7 +176,7 @@ GEM
     opentelemetry-instrumentation-rack (0.24.6)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-base (~> 0.22.1)
-    opentelemetry-instrumentation-rails (0.31.1)
+    opentelemetry-instrumentation-rails (0.31.2)
       opentelemetry-api (~> 1.0)
       opentelemetry-instrumentation-action_mailer (~> 0.1.0)
       opentelemetry-instrumentation-action_pack (~> 0.9.0)
@@ -254,6 +254,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/highlight.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'grpc', '~> 1.52'
+  spec.add_runtime_dependency 'grpc', '~> 1.65'
   spec.add_runtime_dependency 'opentelemetry-exporter-otlp', '~> 0.28.1'
   spec.add_runtime_dependency 'opentelemetry-instrumentation-all', '~> 0.62.1'
   spec.add_runtime_dependency 'opentelemetry-sdk', '~> 1.5.0'

data/lib/highlight/version.rb

@@ -1,3 +1,3 @@
 module Highlight
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/highlight.rb

@@ -18,6 +18,10 @@ module Highlight
     end
   end
 
+  def self.init(project_id, environment: '', otlp_endpoint: OTLP_HTTP, &block)
+    H.new(project_id, environment: environment, otlp_endpoint: otlp_endpoint, &block)
+  end
+
   def self.start_span(name, attrs = {}, &block)
     if block_given?
       H.instance.start_span(name, attrs, &block)
@@ -26,6 +30,18 @@ module Highlight
     end
   end
 
+  def self.log(level, message, attrs = {})
+    H.instance.record_log(nil, nil, level, message, attrs)
+  end
+
+  def self.exception(error, attrs = {})
+    H.instance.record_exception(error, attrs)
+  end
+
+  def self.traceparent_meta
+    Helpers.traceparent_meta
+  end
+
   class H
     HIGHLIGHT_REQUEST_HEADER = 'X-Highlight-Request'.freeze
     OTLP_HTTP = 'https://otel.highlight.io:4318'.freeze
@@ -130,6 +146,7 @@ module Highlight
         function.delete_prefix!('in `')
         function.delete_suffix!('"')
       end
+
       @tracer.in_span('highlight.log', attributes: {
         HIGHLIGHT_SESSION_ATTRIBUTE => session_id,
         HIGHLIGHT_TRACE_ATTRIBUTE => request_id
@@ -182,6 +199,8 @@ module Highlight
   end
 
   class Logger < ::Logger
+    include ActiveSupport::LoggerSilence if defined?(::ActiveSupport::LoggerSilence)
+
     def initialize(*args)
       super
       @local_level = nil
@@ -210,12 +229,18 @@ module Highlight
       def self.included(base)
         base.extend(ClassMethods)
         base.helper_method(:highlight_headers)
+        base.around_action(:with_highlight_context)
       end
 
       def with_highlight_context(&block)
         set_highlight_headers
-        H.instance.trace(highlight_headers.session_id, highlight_headers.request_id,
-                         name: "#{request.method.upcase} #{request.path}", &block)
+
+        H.instance.trace(
+          highlight_headers.session_id,
+          highlight_headers.request_id,
+          name: "#{request.method.upcase} #{request.path}",
+          &block
+        )
       end
 
       private
@@ -255,4 +280,31 @@ module Highlight
       end
     end
   end
+
+  module Helpers
+    if defined?(ActionView)
+      include ActionView::Helpers
+      extend ActionView::Helpers::TagHelper
+    end
+
+    def self.traceparent_meta
+      current_trace = OpenTelemetry::Trace.current_span
+      trace_id = current_trace&.context&.trace_id
+      span_id = current_trace&.context&.span_id
+      hex_trace_id = trace_id&.unpack1('H*') || '00000000000000000000000000000000'
+      hex_span_id = span_id&.unpack1('H*') || '0000000000000000'
+
+      tag(:meta, name: 'traceparent', content: "00-#{hex_trace_id}-#{hex_span_id}-01")
+    end
+  end
+
+  if defined?(::Rails::Railtie)
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do
+        ActiveSupport.on_load(:action_controller) do
+          include ::Highlight::Integrations::Rails
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highlight_io
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Highlight
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.52'
+        version: '1.65'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.52'
+        version: '1.65'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement