highlight_io 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ac88fa49d586b18a7e1be34e4f2bbda4cdd574fcbeb83ffc97b75c0101d5b43
-  data.tar.gz: 59840de16d8b5d3839c18aac425b7ea47aa76942a3ff4e539e8e2af623f1797b
+  metadata.gz: c3efa0af1bc68bbe32f441a34004f6c8091c45ac39cdb29eab0c8e998ec81b83
+  data.tar.gz: c7a0b835e16dc117987dd5907aa296ce43b8d63712f78a0c10eeb187aff719ca
 SHA512:
-  metadata.gz: 834eeda394658f10de79c9102cb18415a0b2918030957a105cc6ba7505fe2e20d8ad63d28c4ca6ebe6dce7091207060343661c305a67844fc41c2cdc0e00446b
-  data.tar.gz: 5723050e4cc62d07d4c53dfb6a1d34fb3771c622833643a0cacc7a5a5f6987ae432de560f16bb000e81631a8c8fdbad296cd79972811162a60dd303b2b1ad5ed
+  metadata.gz: c252eedb2907918abb3baa9101ddde61a76ca73ccdc95a0c7fb9dfb58b6c097ca599f23b6ef2130b888456fb6227db7e38284efd1a5a91ef1a54edf14c0c0f1f
+  data.tar.gz: 756d3dd965066c45329269fcaf185bb2dc80f3df90bbc35f90175ba3ebee227811d29550c5f03507728446422ecd9c3b1d6c09814fef0eb618506ae6b1f22b04

data/.rubocop.yml

@@ -1,5 +1,21 @@
 AllCops:
     TargetRubyVersion: 3.0
+    EnabledByDefault: true
+
+Bundler/GemComment:
+    Enabled: false
+
+Bundler/GemVersion:
+    Enabled: false
+
+Lint/ConstantResolution:
+    Enabled: false
+
+Style/ConstantVisibility:
+    Enabled: false
+
+Style/Copyright:
+    Enabled: false
 
 Style/FrozenStringLiteralComment:
     Enabled: false
@@ -7,11 +23,29 @@ Style/FrozenStringLiteralComment:
 Style/Documentation:
     Enabled: false
 
+Style/DocumentationMethod:
+    Enabled: false
+
+Style/ImplicitRuntimeError:
+    Enabled: false
+
+Style/InlineComment:
+    Enabled: false
+
+Style/MissingElse:
+    Enabled: false
+
+Style/StringHashKeys:
+    Enabled: false
+
 Metrics/MethodLength:
     Enabled: false
 
 Metrics/CyclomaticComplexity:
-    Max: 8
+    Enabled: false
+
+Metrics/PerceivedComplexity:
+    Enabled: false
 
 Naming/MethodParameterName:
     Enabled: false

data/CHANGELOG.md

@@ -1,21 +1,35 @@
-## 0.1.2
+## 0.5.0
 
-- Add ability to set `service_name` and `service_version`
+- Fix bug with SDK initialization
+- Fix bug with `service.name` and `deployment.environment` not being set
+- Adds `telemetry.distro.*` attributes as resource spans
+- Add `highlight_traceparent_meta` Rails tag helper
+- Fixes up the Rubocop configs and addresses new issues reported
 
-## 0.1.4
+## 0.4.0
 
-- Tune settings of opentelemetry SDK to reduce memory usage.
-- Enable GZIP compression of exported data.
+- Add `H.init` alias
+- Auto instrument Rails requests and eliminate need for `around_action`
+- Fix warning about incompatibility with `ActiveSupport::LoggerSilence`
+
+## 0.2.2
+
+- Fix duplicate errors recorded on traces.
+
+## 0.2.1
+
+- Ensure `message` on logs is always a string.
 
 ## 0.2.0
 
 - Support setting `environment` attribute to SDK initialization.
 - `otlp_endpoint` updated to keyword parameter when initializing.
 
-## 0.2.1
+## 0.1.4
 
-- Ensure `message` on logs is always a string.
+- Tune settings of opentelemetry SDK to reduce memory usage.
+- Enable GZIP compression of exported data.
 
-## 0.2.2
+## 0.1.2
 
-- Fix duplicate errors recorded on traces.
+- Add ability to set `service_name` and `service_version`

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    highlight_io (0.3.1)
-      grpc (~> 1.65)
+    highlight_io (0.5.0)
+      grpc (~> 1.66)
       opentelemetry-exporter-otlp (~> 0.28.1)
       opentelemetry-instrumentation-all (~> 0.62.1)
       opentelemetry-sdk (~> 1.5.0)
@@ -12,20 +12,20 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    google-protobuf (3.25.3-arm64-darwin)
-    google-protobuf (3.25.3-x86_64-linux)
+    google-protobuf (3.25.4-arm64-darwin)
+    google-protobuf (3.25.4-x86_64-linux)
     googleapis-common-protos-types (1.15.0)
       google-protobuf (>= 3.18, < 5.a)
-    grpc (1.65.2-arm64-darwin)
+    grpc (1.66.0-arm64-darwin)
       google-protobuf (>= 3.25, < 5.0)
       googleapis-common-protos-types (~> 1.0)
-    grpc (1.65.2-x86_64-linux)
+    grpc (1.66.0-x86_64-linux)
       google-protobuf (>= 3.25, < 5.0)
       googleapis-common-protos-types (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     minitest (5.18.0)
-    opentelemetry-api (1.3.0)
+    opentelemetry-api (1.4.0)
     opentelemetry-common (0.21.0)
       opentelemetry-api (~> 1.0)
     opentelemetry-exporter-otlp (0.28.1)
@@ -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.3)
       opentelemetry-api (~> 1.0)
-      opentelemetry-instrumentation-active_support (~> 0.1)
+      opentelemetry-instrumentation-active_support (~> 0.6)
       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)

data/highlight.gemspec

@@ -15,16 +15,18 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  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'
-  spec.add_runtime_dependency 'opentelemetry-semantic_conventions', '~> 1.10.1'
+  spec.add_dependency('grpc', '~> 1.66')
+  spec.add_dependency('opentelemetry-exporter-otlp', '~> 0.28.1')
+  spec.add_dependency('opentelemetry-instrumentation-all', '~> 0.62.1')
+  spec.add_dependency('opentelemetry-sdk', '~> 1.5.0')
+  spec.add_dependency('opentelemetry-semantic_conventions', '~> 1.10.1')
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/highlight/version.rb

@@ -1,3 +1,3 @@
 module Highlight
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/highlight.rb

@@ -1,10 +1,10 @@
-require 'opentelemetry/sdk'
-require 'opentelemetry/exporter/otlp'
-require 'opentelemetry/instrumentation/all'
-require 'opentelemetry/semantic_conventions'
 require 'date'
 require 'json'
 require 'logger'
+require 'opentelemetry/exporter/otlp'
+require 'opentelemetry/instrumentation/all'
+require 'opentelemetry/sdk'
+require 'opentelemetry/semantic_conventions'
 require 'securerandom'
 
 module Highlight
@@ -18,29 +18,58 @@ module Highlight
     end
   end
 
+  def self.init(project_id, environment: '', otlp_endpoint: H::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?
+    if H.initialized?
       H.instance.start_span(name, attrs, &block)
-    else
-      H.instance.start_span(name, attrs) { |_| }
+    elsif block_given?
+      yield(OpenTelemetry::Trace::Span::INVALID)
     end
   end
 
   def self.log(level, message, attrs = {})
-    H.instance.record_log(nil, nil, level, message, attrs)
+    return unless H.initialized?
+
+    H.instance&.record_log(nil, nil, level, message, attrs)
   end
 
   def self.exception(error, attrs = {})
-    H.instance.record_exception(error, attrs)
+    return unless H.initialized?
+
+    H.instance&.record_exception(error, attrs)
   end
 
   def self.traceparent_meta
+    return unless H.initialized?
+
     Helpers.traceparent_meta
   end
 
+  def self.traceparent_meta_tag
+    return unless H.initialized?
+
+    Helpers.traceparent_meta_tag
+  end
+
+  def self.flush
+    return unless H.initialized?
+
+    H.instance.flush
+  end
+
+  def self.shutdown
+    return unless H.initialized?
+
+    H.instance.shutdown
+  end
+
   class H
-    HIGHLIGHT_REQUEST_HEADER = 'X-Highlight-Request'.freeze
+    SDK_NAME = 'highlight-ruby'.freeze
     OTLP_HTTP = 'https://otel.highlight.io:4318'.freeze
+    HIGHLIGHT_REQUEST_HEADER = 'X-Highlight-Request'.freeze
     HIGHLIGHT_PROJECT_ATTRIBUTE = 'highlight.project_id'.freeze
     HIGHLIGHT_SESSION_ATTRIBUTE = 'highlight.session_id'.freeze
     HIGHLIGHT_TRACE_ATTRIBUTE = 'highlight.trace_id'.freeze
@@ -50,171 +79,170 @@ module Highlight
     CODE_FILEPATH = OpenTelemetry::SemanticConventions::Trace::CODE_FILEPATH
     CODE_LINENO = OpenTelemetry::SemanticConventions::Trace::CODE_LINENO
     CODE_FUNCTION = OpenTelemetry::SemanticConventions::Trace::CODE_FUNCTION
+    DEPLOYMENT_ENVIRONMENT_ATTRIBUTE = OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT
+    HIGHLIGHT_SDK_VERSION_ATTRIBUTE = 'telemetry.distro.version'.freeze
+    HIGHLIGHT_SDK_NAME_ATTRIBUTE = 'telemetry.distro.name'.freeze
 
-    def self.instance
-      @@instance
+    class << self
+      attr_reader :instance
     end
 
-    def initialize(project_id, environment: '', otlp_endpoint: OTLP_HTTP)
-      @@instance = self # rubocop:disable Style/ClassVars
+    def self.initialized?
+      !@instance.nil?
+    end
 
-      @project_id = project_id
-      @otlp_endpoint = otlp_endpoint
+    def self.parse_headers(headers)
+      return HighlightHeaders.new(nil, nil) if headers.nil? || !headers.key?(HIGHLIGHT_REQUEST_HEADER)
 
-      OpenTelemetry::SDK.configure do |c|
-        c.add_span_processor(Highlight::Tracing::BaggageSpanProcessor.new)
+      session_id, request_id = headers[HIGHLIGHT_REQUEST_HEADER].split('/')
+      traceparent = headers['traceparent']
+      trace_id = traceparent&.split('-')&.[](1) || request_id
+      HighlightHeaders.new(session_id, trace_id)
+    end
 
-        c.add_span_processor(
-          OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-            OpenTelemetry::Exporter::OTLP::Exporter.new(
-              endpoint: "#{@otlp_endpoint}/v1/traces",
-              compression: 'gzip'
-            ),
-            schedule_delay: 1000,
-            max_export_batch_size: 128,
-            max_queue_size: 1024
-          )
-        )
+    def self.log_level_string(level)
+      case level
+      when Logger::FATAL then 'FATAL'
+      when Logger::ERROR then 'ERROR'
+      when Logger::WARN then 'WARN'
+      when Logger::INFO then 'INFO'
+      when Logger::DEBUG then 'DEBUG'
+      else 'UNKNOWN'
+      end
+    end
 
-        c.resource = OpenTelemetry::SDK::Resources::Resource.create(
-          HIGHLIGHT_PROJECT_ATTRIBUTE => @project_id,
-          OpenTelemetry::SemanticConventions::Resource::SERVICE_NAME => environment,
-          OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT => environment
-        )
+    def initialize(project_id, environment: '', otlp_endpoint: OTLP_HTTP, &block)
+      self.class.instance_variable_set(:@instance, self)
 
-        c.use_all
+      @project_id = project_id
+      @otlp_endpoint = otlp_endpoint
+      @environment = environment
 
-        yield c if block_given?
-      end
+      configure_opentelemetry(&block)
 
       @tracer_provider = OpenTelemetry.tracer_provider
       @tracer = @tracer_provider.tracer('highlight-tracer')
     end
 
     def initialized?
-      defined?(@tracer_provider)
+      !@tracer_provider.nil?
     end
 
     def flush
-      return unless initialized?
+      @tracer_provider&.force_flush
+    end
 
-      @tracer_provider.force_flush
+    def shutdown
+      @tracer_provider&.shutdown
     end
 
     def trace(session_id, request_id, attrs = {}, name: 'highlight.span', &block)
       return unless initialized?
 
-      # Passed along by the BaggageSpanProcessor to child spans as attributes.
       ctx = OpenTelemetry::Baggage.set_value(HIGHLIGHT_SESSION_ATTRIBUTE, session_id || '')
       ctx = OpenTelemetry::Baggage.set_value(HIGHLIGHT_TRACE_ATTRIBUTE, request_id || '', context: ctx)
-
-      OpenTelemetry::Context.with_current(ctx) do
-        start_span(name, attrs, &block)
-      end
+      OpenTelemetry::Context.with_current(ctx) { start_span(name, attrs, &block) }
     end
 
-    def start_span(name, attrs = {}, &block)
+    def start_span(name, attrs = {})
       return unless initialized?
 
-      if block_given?
-        @tracer.in_span(name, attributes: attrs, &block)
-      else
-        @tracer.in_span(name, attributes: attrs) { |_| }
-      end
+      @tracer.in_span(name, attributes: attrs.transform_keys(&:to_s)) { |span| yield(span) if block_given? }
     end
 
     def record_exception(e, attrs = {})
       return unless initialized?
 
-      span = OpenTelemetry::Trace.current_span
-      return unless span
-
-      span.record_exception(e, attributes: attrs)
+      OpenTelemetry::Trace.current_span&.record_exception(e, attributes: attrs.transform_keys(&:to_s))
     end
 
     def record_log(session_id, request_id, level, message, attrs = {})
       return unless initialized?
 
-      caller_info = caller[0].split(':', 3)
-      function = caller_info[2]
-      if function
-        # format: "in `<function_name>""
-        function.delete_prefix!('in `')
-        function.delete_suffix!('"')
-      end
+      log_attributes = create_log_attributes(level, message, attrs)
 
-      @tracer.in_span('highlight.log', attributes: {
-        HIGHLIGHT_SESSION_ATTRIBUTE => session_id,
-        HIGHLIGHT_TRACE_ATTRIBUTE => request_id
-      }.compact) do |span|
+      @tracer.in_span(
+        'highlight.log',
+        attributes: {
+          HIGHLIGHT_SESSION_ATTRIBUTE => session_id || '',
+          HIGHLIGHT_TRACE_ATTRIBUTE => request_id || ''
+        }.compact
+      ) do |span|
         span.status = OpenTelemetry::Trace::Status.error(message) if [Logger::ERROR, Logger::FATAL].include?(level)
-        span.add_event(LOG_EVENT, attributes: {
-          LOG_SEVERITY_ATTRIBUTE => H.log_level_string(level),
-          LOG_MESSAGE_ATTRIBUTE => message.to_s,
-          CODE_FILEPATH => caller_info[0],
-          CODE_LINENO => caller_info[1],
-          CODE_FUNCTION => function
-        }.merge(attrs))
+        span.add_event(LOG_EVENT, attributes: log_attributes)
       end
     end
 
-    def self.parse_headers(headers)
-      if headers && headers[HIGHLIGHT_REQUEST_HEADER]
-        session_id, request_id = headers[HIGHLIGHT_REQUEST_HEADER].split('/')
-        traceparent = headers['traceparent']
-        trace_id = traceparent&.split('-')&.second || request_id
-        return HighlightHeaders.new(session_id, trace_id)
+    private
+
+    def configure_opentelemetry
+      OpenTelemetry::SDK.configure do |c|
+        c.add_span_processor(Highlight::Tracing::BaggageSpanProcessor.new)
+        c.add_span_processor(create_batch_span_processor)
+        c.resource = create_resource
+        c.use_all
+        yield(c) if block_given?
       end
-      HighlightHeaders.new(nil, nil)
     end
 
-    def self.log_level_string(level)
-      case level
-      when Logger::UNKNOWN
-        'UNKNOWN'
-      when Logger::FATAL
-        'FATAL'
-      when Logger::ERROR
-        'ERROR'
-      when Logger::WARN
-        'WARN'
-      when Logger::INFO
-        'INFO'
-      when Logger::DEBUG
-        'DEBUG'
-      else
-        'UNKNOWN'
-      end
+    def create_batch_span_processor
+      OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+        OpenTelemetry::Exporter::OTLP::Exporter.new(
+          endpoint: "#{@otlp_endpoint}/v1/traces",
+          compression: 'gzip'
+        ),
+        schedule_delay: 1000,
+        max_export_batch_size: 128,
+        max_queue_size: 1024
+      )
     end
 
-    private
+    def create_resource
+      OpenTelemetry::SDK::Resources::Resource.create(
+        HIGHLIGHT_PROJECT_ATTRIBUTE => @project_id,
+        HIGHLIGHT_SDK_VERSION_ATTRIBUTE => Highlight::VERSION,
+        HIGHLIGHT_SDK_NAME_ATTRIBUTE => SDK_NAME,
+        DEPLOYMENT_ENVIRONMENT_ATTRIBUTE => @environment
+      )
+    end
+
+    def create_log_attributes(level, message, attrs)
+      caller_info = parse_caller_info
 
-    def trace_id_from_headers(headers)
-      headers.traceparent&.split('-')&.first
+      {
+        LOG_SEVERITY_ATTRIBUTE => self.class.log_level_string(level),
+        LOG_MESSAGE_ATTRIBUTE => message.to_s,
+        CODE_FILEPATH => caller_info.first,
+        CODE_LINENO => caller_info[1],
+        CODE_FUNCTION => caller_info[2]
+      }.merge(attrs).transform_keys(&:to_s)
+    end
+
+    def parse_caller_info
+      caller_info = caller.first.split(':', 3)
+      function = caller_info[2]&.gsub(/^in `|'$/, '')
+      [caller_info.first, caller_info[1], function]
     end
   end
 
   class Logger < ::Logger
+    include ActiveSupport::LoggerSilence if defined?(::ActiveSupport::LoggerSilence)
+
     def initialize(*args)
       super
       @local_level = nil
     end
 
     def add(severity, message = nil, progname = nil, &block)
-      severity ||= UNKNOWN
+      severity ||= ::Logger::UNKNOWN
       return true if @logdev.nil? || severity < level
 
-      progname = @progname if progname.nil?
-      if message.nil?
-        if block_given?
-          message = yield
-        else
-          message = progname
-          progname = @progname
-        end
-      end
-      super(severity, message, progname, &block)
-      H.instance.record_log(nil, nil, severity, message)
+      progname ||= @progname
+      message = yield if message.nil? && block_given?
+      message = progname if message.nil?
+
+      super
+      H.instance&.record_log(nil, nil, severity, message)
     end
   end
 
@@ -223,41 +251,49 @@ module Highlight
       def self.included(base)
         base.extend(ClassMethods)
         base.helper_method(:highlight_headers)
+        base.around_action(:with_highlight_context)
+        base.helper(ViewHelpers)
       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
 
       def set_highlight_headers
         @highlight_headers = H.parse_headers(request.headers)
-        return unless @highlight_headers.session_id.nil?
+        return if @highlight_headers.session_id
 
         session_id = request.cookies['sessionID'].presence || SecureRandom.alphanumeric(28)
-
         session_data_key = "sessionData_#{session_id}"
-        @session_data = request.cookies[session_data_key] || {
+        @session_data = request.cookies[session_data_key] || create_session_data(session_id)
+
+        set_cookies(session_id, session_data_key)
+        @highlight_headers = HighlightHeaders.new(session_id, nil)
+      end
+
+      def create_session_data(session_id)
+        {
           sessionSecureID: session_id,
           projectID: @project_id,
           payloadID: 1,
-          sessionStartTime: DateTime.now.strftime('%Q'),
-          lastPushTime: DateTime.now.strftime('%Q')
+          sessionStartTime: Time.now.strftime('%Q'),
+          lastPushTime: Time.now.strftime('%Q')
         }
+      end
 
-        cookies[:sessionID] = {
-          value: session_id,
-          expires: 15.minutes.from_now
-        }
-        cookies[session_data_key] = {
-          value: @session_data.to_json,
-          expires: 15.minutes.from_now
-        }
+      def set_cookies(session_id, session_data_key)
+        expiration = 15.minutes.from_now
 
-        @highlight_headers = HighlightHeaders.new(session_id, nil)
+        cookies[:sessionID] = { value: session_id, expires: expiration }
+        cookies[session_data_key] = { value: @session_data.to_json, expires: expiration }
       end
 
       def highlight_headers
@@ -266,6 +302,12 @@ module Highlight
 
       module ClassMethods
       end
+
+      module ViewHelpers
+        def highlight_traceparent_meta
+          tag.meta(name: 'traceparent', content: Helpers.traceparent_meta)
+        end
+      end
     end
   end
 
@@ -279,10 +321,24 @@ module Highlight
       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'
+      hex_trace_id = trace_id&.unpack1('H*') || ('0' * 32)
+      hex_span_id = span_id&.unpack1('H*') || ('0' * 16)
+
+      "00-#{hex_trace_id}-#{hex_span_id}-01"
+    end
 
-      tag(:meta, name: 'traceparent', content: "00-#{hex_trace_id}-#{hex_span_id}-01")
+    def self.traceparent_meta_tag
+      "<meta name=\"traceparent\" content=\"#{traceparent_meta}\">"
+    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.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Highlight
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.65'
+        version: '1.66'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.65'
+        version: '1.66'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://www.highlight.io
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: The Highlight SDK for Ruby