lognorth 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd243e69bd9758c158d11868e091edc0f0c629916cebc8094fdcfb74664b0b3
-  data.tar.gz: db2c6d4d5e68353da4ecb2757737595ec144c9ae002202bf3cde5abcacdfa978
+  metadata.gz: 6facae6811a9d61603077a6c369bfbad5873d9263e7ca2cbee5d4bead5ab3852
+  data.tar.gz: '08afbfff31cc87bbdd4f15c6e65c5f55f2be5e056589c3b0d46ab6962a33222d'
 SHA512:
-  metadata.gz: 1381eee25cc094217d00d294ee381846cdb0390110e2e727c104459c5199918ede21c6157b1dfbd723b39d8fde5cc45b74998e031b352df058d76676a437a57e
-  data.tar.gz: 70a5edefba779fd982adcaf91465c34ec89082242428c953485ba4a9855ddb7852f4950c6e01ba21636ac1c2bbfb6963ef66cbbc3208f6594abc85196b1914f7
+  metadata.gz: de01d5ef4b8693410fdd5998f79b2a532404b6a0e9f52bfcaa23176195ee8c3864c3d89e36c146a02f0e7ebbd943f132cb9c394a0a9347fd917bfa23e4c06efb
+  data.tar.gz: c2b6f280ac33dced59879406dfbc9ace7f6f23be12153c164e9edc56937e0ee071388b52f08cb862db4dbf102026485384789d08862bf760ab5ef77f2046a6dd

data/README.md

@@ -5,7 +5,7 @@ Send errors and logs from Rails to [LogNorth](https://lognorth.com) for monitori
 ## Installation
 
 ```ruby
-gem "lognorth", github: "karloscodes/lognorth-sdk-rails"
+gem "lognorth"
 ```
 
 ## Rails Setup
@@ -82,6 +82,20 @@ end
 LogNorth.flush
 ```
 
+### Who hit the error, and in which release
+
+LogNorth reads `Current.user` when your app defines it, as the Rails authentication generator does. Otherwise, name the user yourself. Use an ID, not an email:
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action { LogNorth.user = current_user&.id }
+end
+```
+
+The request event and its errors carry the user, so LogNorth shows how many users an issue hit.
+
+Errors also carry the release. The gem reads `KAMAL_VERSION`, `LOGNORTH_RELEASE`, `GIT_SHA`, or the commit variable of Render, Heroku, Railway, Vercel, or Coolify. When the release is set, the gem logs `Release <version> started` once at boot. LogNorth marks each release's first start on its charts. A failed request (5xx) also carries its user agent, so you can tell a bot from a browser.
+
 ## Batching and delivery
 
 Logging calls never block and never raise. They add the event to a queue in memory.

data/lib/lognorth/client.rb

@@ -15,7 +15,12 @@ module LogNorth
   MAX_STACK_TRACE_BYTES = 16 * 1024
   MAX_STRING_BYTES = 8 * 1024
   # The context keys an event keeps when it is still too big after trimming.
-  ESSENTIAL_KEYS = %w[error error_class error_file error_line method path status environment].freeze
+  ESSENTIAL_KEYS = %w[error error_class error_file error_line method path status environment release user].freeze
+  # Where deploy tools put the version that runs. The first one set wins.
+  RELEASE_ENV = %w[
+    LOGNORTH_RELEASE GIT_SHA GIT_COMMIT SOURCE_COMMIT KAMAL_VERSION
+    RENDER_GIT_COMMIT HEROKU_SLUG_COMMIT SOURCE_VERSION RAILWAY_GIT_COMMIT_SHA VERCEL_GIT_COMMIT_SHA
+  ].freeze
 
   module Client
     # An event in the queue, with its JSON size and whether it is an error.
@@ -39,6 +44,8 @@ module LogNorth
     @endpoint = nil
     @api_key = nil
     @environment = nil
+    @release = nil
+    @announced = nil # the release this process last said it started
 
     # Wait times in seconds. Tests set them lower.
     @flush_interval = 5
@@ -53,13 +60,15 @@ module LogNorth
     class << self
       attr_accessor :debug
 
-      def config(url, key, environment: nil)
+      def config(url, key, environment: nil, release: nil)
         @mutex.synchronize do
           @endpoint = url.chomp("/")
           @api_key = key
           @environment = environment
+          @release = release || release_from_env
         end
         log_debug("configured with url=#{url} env=#{environment.inspect}")
+        announce_release
       end
 
       def configured?
@@ -82,6 +91,22 @@ module LogNorth
         Thread.current[:lognorth_trace_id] = id
       end
 
+      # The user of the request on this thread: the one set with LogNorth.user=,
+      # or else Current.user, which the Rails authentication generator defines.
+      def current_user
+        Thread.current[:lognorth_user] || user_from_current_attributes
+      end
+
+      def current_user=(id)
+        Thread.current[:lognorth_user] = id&.to_s
+      end
+
+      # Forgets the trace ID and the user when a request ends.
+      def end_request
+        Thread.current[:lognorth_trace_id] = nil
+        Thread.current[:lognorth_user] = nil
+      end
+
       def send_event(message, context = {}, trace_id: nil, duration_ms: nil, timestamp: nil)
         return unless configured?
 
@@ -89,7 +114,7 @@ module LogNorth
         event = {
           message: message,
           timestamp: (timestamp || Time.now).utc.iso8601(3),
-          context: stamp_environment(context)
+          context: stamp_user(stamp_environment(context))
         }
         event[:trace_id] = trace_id if trace_id
         event[:duration_ms] = duration_ms if duration_ms
@@ -115,14 +140,14 @@ module LogNorth
         event = {
           message: message,
           timestamp: (timestamp || Time.now).utc.iso8601(3),
-          context: stamp_environment(context.merge(
+          context: stamp_user(stamp_environment(context.merge(
             error: exception.message,
             error_class: exception.class.name,
             error_file: error_file,
             error_line: error_line,
             error_caller: error_caller,
             stack_trace: exception.backtrace&.first(20)&.join("\n")
-          ))
+          )))
         }
         event[:trace_id] = trace_id if trace_id
         event[:duration_ms] = duration_ms if duration_ms
@@ -169,8 +194,48 @@ module LogNorth
         context.merge(environment: env)
       end
 
+      # Logs "Release <version> started" once per release, when the client is
+      # configured. LogNorth takes the first start of a release as its deploy
+      # time and marks it on its charts.
+      def announce_release
+        release = @mutex.synchronize do
+          next if @release.nil? || @release == @announced
+
+          @announced = @release
+        end
+        send_event("Release #{release} started", { release: release }) if release
+      end
+
+      def stamp_user(context)
+        user = current_user
+        return context if user.nil? || fetch(context, :user)
+
+        context.merge(user: user)
+      end
+
+      def user_from_current_attributes
+        return unless defined?(::Current) && ::Current.respond_to?(:user)
+
+        ::Current.user&.id&.to_s
+      rescue StandardError
+        nil
+      end
+
+      # Errors carry the release: that is where it answers which deploy broke
+      # something. Other events stay small.
+      def stamp_release(event)
+        release = @mutex.synchronize { @release }
+        return event if release.nil? || !error_event?(event[:context]) || fetch(event[:context], :release)
+
+        event.merge(context: event[:context].merge(release: release))
+      end
+
+      def release_from_env
+        RELEASE_ENV.lazy.map { |k| ENV[k].to_s.strip }.find { |v| !v.empty? }
+      end
+
       def enqueue(event, urgent: false)
-        entry = new_entry(trim(event))
+        entry = new_entry(trim(stamp_release(event)))
         @mutex.synchronize do
           push(entry)
           @urgent = true if urgent

data/lib/lognorth/middleware.rb

@@ -26,7 +26,7 @@ module LogNorth
 
       # Don't track requests that didn't match any route (scanner noise)
       if status == 404 && !env["action_controller.instance"]
-        LogNorth::Client.current_trace_id = nil
+        LogNorth::Client.end_request
         return [status, headers, response]
       end
 
@@ -35,6 +35,7 @@ module LogNorth
 
       context = { method: env["REQUEST_METHOD"], path: env["PATH_INFO"], status: status }
       merge_route_info!(context, env)
+      merge_user_agent!(context, env, status)
 
       LogNorth::Client.send_event(
         "#{env['REQUEST_METHOD']} #{env['PATH_INFO']} → #{status}",
@@ -46,7 +47,7 @@ module LogNorth
 
       LogNorth.flush if status >= 500
 
-      LogNorth::Client.current_trace_id = nil
+      LogNorth::Client.end_request
       [status, headers, response]
     rescue StandardError => e
       duration_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000).round
@@ -60,17 +61,17 @@ module LogNorth
           "#{env['REQUEST_METHOD']} #{env['PATH_INFO']} → #{status}", context,
           trace_id: trace_id, duration_ms: duration_ms, timestamp: start_time
         )
-        LogNorth::Client.current_trace_id = nil
+        LogNorth::Client.end_request
         raise
       end
       LogNorth::Client.send_error_event(
         "Request failed: #{env['REQUEST_METHOD']} #{env['PATH_INFO']}", e,
-        { method: env["REQUEST_METHOD"], path: env["PATH_INFO"] },
+        merge_user_agent!({ method: env["REQUEST_METHOD"], path: env["PATH_INFO"] }, env, 500),
         trace_id: trace_id,
         duration_ms: duration_ms,
         timestamp: start_time
       )
-      LogNorth::Client.current_trace_id = nil
+      LogNorth::Client.end_request
       raise
     end
 
@@ -83,6 +84,14 @@ module LogNorth
       ignored_paths.any? { |p| path == p || path.start_with?("#{p}/") }
     end
 
+    # The user agent tells a bot from a browser on a failed request. Only
+    # failed ones carry it, to keep every other event small.
+    def merge_user_agent!(context, env, status)
+      agent = env["HTTP_USER_AGENT"].to_s
+      context[:user_agent] = agent if status.to_i >= 500 && !agent.empty?
+      context
+    end
+
     # Rails populates action_controller.instance after dispatch so the
     # controller/action names — and the named route when available —
     # can be pulled straight off the env.

data/lib/lognorth.rb

@@ -7,8 +7,17 @@ require_relative "lognorth/railtie" if defined?(Rails::Railtie)
 
 module LogNorth
   class << self
-    def config(url, key, environment: nil)
-      Client.config(url, key, environment: environment)
+    def config(url, key, environment: nil, release: nil)
+      Client.config(url, key, environment: environment, release: release)
+    end
+
+    # Names the user of the current request: an ID, not an email. The request
+    # event and its errors carry it, so an issue shows how many users it hit.
+    # Without it, LogNorth reads Current.user when the app defines one.
+    #
+    #   before_action { LogNorth.user = current_user&.id }
+    def user=(id)
+      Client.current_user = id
     end
 
     def log(message, context = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lognorth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - LogNorth