timber 2.0.9 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77cca27158a28ec9275818a2efaba37229e2d121
-  data.tar.gz: 5423ac901328f3c57811bfc1a7855970d798b55c
+  metadata.gz: d8f4370bada35338e39a28f00a5c1530175e285a
+  data.tar.gz: b15a814d3c4d6fdd557f7a509bc2452fd86a99ff
 SHA512:
-  metadata.gz: b58fb47529e061305c0d178458bf2a5bc170610986492fd4a9573f1fae52ad85b5809f12ec2e2dea7b6553441d10a5d849c63cdfff0ae1cc573bf27e3a0f0d4b
-  data.tar.gz: 7a9d4dcde4b68e23b15a62a2e607c76fb371dd313dd28a9d650607be12d3af3fb97e0f6e3ad273ae2ac46762025541d918c7ca065fd3ee045483b65ba75c5fb9
+  metadata.gz: eb512f1759ec51bcbeb28b3cfbbb193dc805cc55c403e48d1fa519fbed4012bebd00802d8467a8af2a0cc56dc5ba50bb27eb78109626d27b00e77e3f74994c58
+  data.tar.gz: b240d0b6062fc042676be8ab4e9fa89622efad45ccdee3514b102b53d83f0879a829617dbc9eac99372e22466030e088ef948a6bc80ad6dded4019cd031ecac8

data/lib/timber/config.rb

@@ -29,6 +29,9 @@ module Timber
     # This is useful for debugging. This Sets a debug_logger to view internal Timber library
     # log messages. The default is `nil`. Meaning log to nothing.
     #
+    # See `debug_to_file` and `debug_to_stdout` for convenience methods that handle creating
+    # and setting the logger.
+    #
     # @example Rails
     #   config.timber.debug_logger = ::Logger.new(STDOUT)
     # @example Everything else
@@ -37,6 +40,34 @@ module Timber
       @debug_logger
     end
 
+    # A convenience method for writing debug messages to a file.
+    #
+    # @example Rails
+    #   config.timber.debug_to_file("#{Rails.root}/log/timber.log")
+    # @example Everything else
+    #   Timber::Config.instance.debug_to_file("log/timber.log")
+    def debug_to_file(file_path)
+      unless File.exist? File.dirname path
+        FileUtils.mkdir_p File.dirname path
+      end
+      file = File.open file_path, "a"
+      file.binmode
+      file.sync = config.autoflush_log
+      file_logger = ::Logger.new(file)
+      self.debug_logger = file_logger
+    end
+
+    # A convenience method for writing debug messages to a file.
+    #
+    # @example Rails
+    #   config.timber.debug_to_file("#{Rails.root}/log/timber.log")
+    # @example Everything else
+    #   Timber::Config.instance.debug_to_file("log/timber.log")
+    def debug_to_stdout
+      stdout_logger = ::Logger.new(STDOUT)
+      self.debug_logger = stdout_logger
+    end
+
     # The environment your app is running in. Defaults to `RACK_ENV` and `RAILS_ENV`.
     # It should be rare that you have to set this. If the aforementioned env vars are not
     # set please do.

data/lib/timber/contexts/system.rb

@@ -4,15 +4,16 @@ module Timber
     class System < Context
       @keyspace = :system
 
-      attr_reader :pid
+      attr_reader :hostname, :pid
 
       def initialize(attributes)
-        @pid = attributes[:pid] || raise(ArgumentError.new(":pid is required"))
+        @hostname = attributes[:hostname]
+        @pid = attributes[:pid]
         @pid = @pid.to_s
       end
 
       def as_json(_options = {})
-        {pid: Timber::Util::Object.try(pid, :to_s)}
+        {hostname: hostname, pid: Timber::Util::Object.try(pid, :to_s)}
       end
     end
   end

data/lib/timber/log_entry.rb

@@ -1,3 +1,5 @@
+require 'socket'
+
 module Timber
   # Represents a new log entry into the log. This is an intermediary class between
   # `Logger` and the log device that you set it up with.
@@ -26,7 +28,9 @@ module Timber
       @time_ms = options[:time_ms]
 
       context_snapshot = {} if context_snapshot.nil?
-      system_context = Contexts::System.new(pid: Process.pid)
+      hostname = Socket.gethostname
+      pid = Process.pid
+      system_context = Contexts::System.new(hostname: hostname, pid: pid)
       context_snapshot[system_context.keyspace] = system_context.as_json
 
       @context_snapshot = context_snapshot

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.0.9"
+  VERSION = "2.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.0.10
 platform: ruby
 authors:
 - Timber Technologies, Inc.