semantic_logger 4.7.2 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a735a9fbaff1f869e8beb81bf7196688a87f94bb40f8fb7861ce505f60d8a1
-  data.tar.gz: 0e5f6075ca9cd65fed94330affc7180c5bc638832391e967b5d7493d26f53e90
+  metadata.gz: 2ff7d4bcb345581f6ba19f834bb1bf2f921e97904f4b6236142b87af75a4526d
+  data.tar.gz: b1069d5360296c61c9796f630b1ec065eb1a0a7dc549778c66c5e26c90d0eadb
 SHA512:
-  metadata.gz: 27046a2405e9662215ac6ed66d6db4a68171301c65f9c3ff06500bfedb1bf3dc2a18c2e67bbedbe705db54b26ff412623556a9f24b1b69b2a2508f54413d1951
-  data.tar.gz: 43db220b7e11cf718f73bcc8343c3f60f77ad63569fba509ebb1d47531055fae87c2233b2de95ed942216bb2e741f77c5ab8902ccf9686f6caf540c3a8efd27f
+  metadata.gz: c5cfbac7dd8795b11cf79ed3fa9a4a086128d5ee030f0e9db40b75f30f58997c1674a4284b4b287939216bc8de83372e2b7fe00d73e7856c3cc6830310740f0d
+  data.tar.gz: 2150a809562247d771103a5d387ae5852ff5b0649a4f4288a7dd07a94420bafcfb6b36f3e21077fcc053c2d8bcaffe80a110ab65b52178fb612b7368fd79d87d

data/README.md

@@ -1,25 +1,13 @@
 # Semantic Logger
-[![Gem Version](https://img.shields.io/gem/v/semantic_logger.svg)](https://rubygems.org/gems/semantic_logger) [![Build Status](https://travis-ci.org/rocketjob/semantic_logger.svg?branch=master)](https://travis-ci.org/rocketjob/semantic_logger) [![Downloads](https://img.shields.io/gem/dt/semantic_logger.svg)](https://rubygems.org/gems/semantic_logger) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
+[![Gem Version](https://img.shields.io/gem/v/semantic_logger.svg)](https://rubygems.org/gems/semantic_logger) [![Build Status](https://github.com/reidmorrison/semantic_logger/workflows/build/badge.svg)](https://github.com/reidmorrison/semantic_logger/actions?query=workflow%3Abuild) [![Downloads](https://img.shields.io/gem/dt/semantic_logger.svg)](https://rubygems.org/gems/semantic_logger) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg)
 
 Semantic Logger is a feature rich logging framework, and replacement for existing Ruby & Rails loggers.  
 
-* https://rocketjob.github.io/semantic_logger/
+* https://logger.rocketjob.io/
 
 ## Documentation
 
-[Semantic Logger Guide](http://rocketjob.github.io/semantic_logger)
-
-[Reference Documentation](http://www.rubydoc.info/gems/semantic_logger/)
-
-## Upgrading to Semantic Logger v4.4
-
-With some forking frameworks it is necessary to call `reopen` after the fork. With v4.4 the
-workaround for Ruby 2.5 crashes is no longer needed. 
-I.e. Please remove the following line if being called anywhere:
-
-~~~ruby
-SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
-~~~
+[Semantic Logger Guide](https://logger.rocketjob.io/)
 
 ## Logging Destinations
 
@@ -34,7 +22,7 @@ Logging to the following destinations are all supported "out-of-the-box":
 * Splunk
 * MongoDB
 * Honeybadger
-* Sentry
+* Sentry (both with legacy `sentry-raven` and modern `sentry-ruby` gem)
 * HTTP
 * TCP
 * UDP
@@ -50,7 +38,7 @@ handles saving log information to multiple destinations / appenders.
 
 ## Rails
 
-When running Rails, use [rails_semantic_logger](http://github.com/rocketjob/rails_semantic_logger)
+When running Rails, use [rails_semantic_logger](http://github.com/reidmorrison/rails_semantic_logger)
 instead of Semantic Logger directly since it will automatically replace the Rails default logger with Semantic Logger.
 
 ## Rocket Job
@@ -72,8 +60,50 @@ and are therefore not automatically included by this gem:
 - Splunk Appender: gem 'splunk-sdk-ruby'
 - Elasticsearch Appender: gem 'elasticsearch'
 - Kafka Appender: gem 'ruby-kafka'
+- Legacy Sentry Appender: gem 'sentry-raven' (deprecated)
+- Sentry Appender: gem 'sentry-ruby'
+
+## Upgrading to Semantic Logger v4.9
+
+These changes should not be noticeable by the majority of users of Semantic Logger, since
+they are to the internal API. It is possible that advanced users may be using these internal
+API's directly.
+
+This does not affect any calls to the public api `SemanticLogger.add_appender`.
+
+File and IO are now separate appenders. When creating the File appender explicitly, its arguments
+have changed. For example, when requesting an IO stream, it needs to be changed from:
+
+~~~ruby
+SemanticLogger::Appender::File.new(io: $stderr)
+~~~
+to:
+~~~ruby
+SemanticLogger::Appender::IO.new($stderr)
+~~~
+
+Additionally, this needs to be changed from:
+~~~ruby
+SemanticLogger::Appender::File.new(file_name: "file.log")
+~~~
+to:
+~~~ruby
+SemanticLogger::Appender::File.new("file.log")
+~~~
+
+Rails Semantic Logger, if used, needs to be upgraded to v4.9 when upgrading to Semantic Logger v4.9.
+
+## Upgrading to Semantic Logger v4.4
+
+With some forking frameworks it is necessary to call `reopen` after the fork. With v4.4 the
+workaround for Ruby 2.5 crashes is no longer needed.
+I.e. Please remove the following line if being called anywhere:
+
+~~~ruby
+SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
+~~~
 
-## V4 Upgrade notes
+## Upgrading to Semantic Logger v4.0
 
 The following changes need to be made when upgrading to V4:
 - Ruby V2.3 / JRuby V9.1 is now the minimum runtime version.
@@ -129,13 +159,13 @@ SemanticLogger.default_level = :trace
 SemanticLogger.add_appender(file_name: 'development.log', formatter: :color)
 ~~~
 
-If running rails, see: [Semantic Logger Rails](http://rocketjob.github.io/semantic_logger/rails.html)
+If running rails, see: [Semantic Logger Rails](https://logger.rocketjob.io/rails.html)
 
 ## Author
 
 [Reid Morrison](https://github.com/reidmorrison)
 
-[Contributors](https://github.com/rocketjob/semantic_logger/graphs/contributors)
+[Contributors](https://github.com/reidmorrison/semantic_logger/graphs/contributors)
 
 ## Versioning
 

data/lib/semantic_logger/appender/async.rb

@@ -53,7 +53,7 @@ module SemanticLogger
       # Re-open appender after a fork
       def reopen
         # Workaround CRuby crash on fork by recreating queue on reopen
-        #   https://github.com/rocketjob/semantic_logger/issues/103
+        #   https://github.com/reidmorrison/semantic_logger/issues/103
         @queue&.close
         create_queue
 

data/lib/semantic_logger/appender/async_batch.rb

@@ -64,6 +64,7 @@ module SemanticLogger
           signal.wait(batch_seconds)
 
           logs          = []
+          messages      = []
           first         = true
           message_count = queue.length
           message_count.times do
@@ -76,10 +77,11 @@ module SemanticLogger
                 first = false
               end
             else
-              process_message(message)
+              messages << message
             end
           end
           appender.batch(logs) if logs.size.positive?
+          messages.each { |message| process_message(message) }
           signal.reset unless queue.size >= batch_size
         end
       end

data/lib/semantic_logger/appender/bugsnag.rb

@@ -40,42 +40,55 @@ module SemanticLogger
 
       # Returns [Hash] of parameters to send to Bugsnag.
       def call(log, logger)
-        h            = SemanticLogger::Formatters::Raw.new.call(log, logger)
-        h[:severity] = log_level(log)
-        h.delete(:message) if h[:exception] && (h[:message] == h[:exception][:message])
-        h.delete(:time)
-        h.delete(:exception)
-        h
+        hash = SemanticLogger::Formatters::Raw.new.call(log, logger)
+        hash.delete(:message) if hash[:exception] && (hash[:message] == hash[:exception][:message])
+        hash.delete(:time)
+        hash.delete(:level_index)
+        hash.delete(:exception)
+        hash[:file] = "#{hash[:file]}:#{hash.delete(:line)}" if hash.key?(:file)
+        hash
       end
 
-      # Send an error notification to Bugsnag
       def log(log)
         # Ignore logs coming from Bugsnag itself
         return false if log.name == "Bugsnag"
 
         # Send error messages as Runtime exceptions
-        exception =
-          if log.exception
-            # Manually constructed Exception, without a backtrace.
-            log.exception.set_backtrace(log.backtrace) if !log.exception.backtrace && log.backtrace
-            log.exception
-          else
-            error = RuntimeError.new(log.message)
-            error.set_backtrace(log.backtrace) if log.backtrace
-            error
-          end
-
-        # For more documentation on the Bugsnag.notify method see:
-        # https://bugsnag.com/docs/notifiers/ruby#sending-handled-exceptions
-        ::Bugsnag.notify(exception, formatter.call(log, self))
+        exception = extract_exception(log)
+        hash      = formatter.call(log, self)
+        bugsnag_notify(exception, hash, log_level(log.level))
         true
       end
 
       private
 
+      def bugsnag_notify(exception, hash, level)
+        if ::Bugsnag::VERSION.to_i >= 6
+          ::Bugsnag.notify(exception) do |report|
+            report.severity = level
+            hash.each_pair { |key, value| report.add_tab(key, value) }
+          end
+        else
+          hash[:severity] = level
+          ::Bugsnag.notify(exception, hash)
+        end
+      end
+
+      def extract_exception(log)
+        if log.exception
+          # Manually constructed Exception, without a backtrace.
+          log.exception.set_backtrace(log.backtrace) if !log.exception.backtrace && log.backtrace
+          return log.exception
+        end
+
+        error = RuntimeError.new(log.message)
+        error.set_backtrace(log.backtrace) if log.backtrace
+        error
+      end
+
       # Bugsnag supports: error, warning or info
-      def log_level(log)
-        case log.level
+      def log_level(level)
+        case level
         when :error, :fatal
           "error"
         when :warn

data/lib/semantic_logger/appender/elasticsearch.rb

@@ -1,7 +1,8 @@
 begin
   require "elasticsearch"
 rescue LoadError
-  raise LoadError, 'Gem elasticsearch is required for logging to Elasticsearch. Please add the gem "elasticsearch" to your Gemfile.'
+  raise LoadError,
+        'Gem elasticsearch is required for logging to Elasticsearch. Please add the gem "elasticsearch" to your Gemfile.'
 end
 
 require "date"
@@ -17,7 +18,8 @@ require "date"
 module SemanticLogger
   module Appender
     class Elasticsearch < SemanticLogger::Subscriber
-      attr_accessor :url, :index, :date_pattern, :type, :client, :flush_interval, :timeout_interval, :batch_size, :elasticsearch_args
+      attr_accessor :url, :index, :date_pattern, :type, :client, :flush_interval, :timeout_interval, :batch_size,
+                    :elasticsearch_args
 
       # Create Elasticsearch appender over persistent HTTP(S)
       #
@@ -133,7 +135,7 @@ module SemanticLogger
                      application: nil,
                      environment: nil,
                      host: nil,
-                     metrics: false,
+                     data_stream: false,
                      **elasticsearch_args,
                      &block)
 
@@ -144,6 +146,7 @@ module SemanticLogger
         @elasticsearch_args          = elasticsearch_args.dup
         @elasticsearch_args[:url]    = url if url && !elasticsearch_args[:hosts]
         @elasticsearch_args[:logger] = logger
+        @data_stream = data_stream
 
         super(level: level, formatter: formatter, filter: filter, application: application, environment: environment, host: host, metrics: false, &block)
         reopen
@@ -173,7 +176,12 @@ module SemanticLogger
       private
 
       def write_to_elasticsearch(messages)
-        bulk_result = @client.bulk(body: messages)
+        bulk_result = if @data_stream
+                        @client.bulk(index: index, body: messages)
+                      else
+                        @client.bulk(body: messages)
+                      end
+
         return unless bulk_result["errors"]
 
         failed = bulk_result["items"].reject { |x| x["status"] == 201 }
@@ -182,11 +190,21 @@ module SemanticLogger
 
       def bulk_index(log)
         expanded_index_name = log.time.strftime("#{index}-#{date_pattern}")
-        {"index" => {"_index" => expanded_index_name, "_type" => type}}
+        if @data_stream
+          {"create" => {}}
+        else
+          {"index" => {"_index" => expanded_index_name, "_type" => type}}
+        end
       end
 
       def default_formatter
-        SemanticLogger::Formatters::Raw.new(time_format: :iso_8601, time_key: :timestamp)
+        time_key = if @data_stream
+                     "@timestamp"
+                   else
+                     :timestamp
+                   end
+
+        SemanticLogger::Formatters::Raw.new(time_format: :iso_8601, time_key: time_key)
       end
     end
   end

data/lib/semantic_logger/appender/file.rb

@@ -1,3 +1,4 @@
+require "date"
 # File appender
 #
 #   Writes log messages to a file or open iostream
@@ -5,105 +6,285 @@
 module SemanticLogger
   module Appender
     class File < SemanticLogger::Subscriber
-      # Create a File Logger appender instance.
+      attr_accessor :file_name, :retry_count, :append, :exclusive_lock, :encoding,
+                    :reopen_period, :reopen_count, :reopen_size
+      attr_reader :log_count, :log_size, :current_file_name, :reopen_at
+
+      # Create an appender to log to a named file.
       #
       # Parameters
-      #  :file_name [String]
-      #    Name of file to write to.
-      #  Or,
-      #  :io [IO]
-      #    An IO stream to which to write the log messages to.
-      #
-      #  :level [:trace | :debug | :info | :warn | :error | :fatal]
-      #    Override the log level for this appender.
-      #    Default: SemanticLogger.default_level
-      #
-      #  :formatter: [Object|Proc]
-      #    An instance of a class that implements #call, or a Proc to be used to format
-      #    the output from this appender
-      #    Default: Use the built-in formatter (See: #call)
-      #
-      #  :filter [Regexp|Proc]
-      #    RegExp: Only include log messages where the class name matches the supplied
-      #    regular expression. All other messages will be ignored.
-      #    Proc: Only include log messages where the supplied Proc returns true
-      #          The Proc must return true or false.
+      #   file_name [String]
+      #     Name of the file to write to.
       #
-      # Example
-      #    require 'semantic_logger'
+      #     File name format directives:
+      #       %p - Process Id
+      #       %n - Short hostname (SemanticLogger.host). Everything before the first period in the hostname.
+      #       %N - Full hostname (SemanticLogger.host)
+      #       %a - Application name (SemanticLogger.application)
+      #       %e - Environment name (SemanticLogger.environment)
+      #       %D - Current Date. Equivalent to "%Y%m%d"
+      #       %T - Current Time. Equivalent to "%H%M%S"
+      #       %% - Literal `%` character
       #
-      #    # Enable trace level logging
-      #    SemanticLogger.default_level = :info
+      #     Date:
+      #       %Y - Year with century
+      #       %C - year / 100 (round down.  20 in 2009)
+      #       %y - year % 100 (00..99)
+      #       %m - Month of the year, zero-padded (01..12)
+      #       %d - Day of the month, zero-padded (01..31)
+      #       %j - Day of the year (001..366)
+      #       %U - Week number of the year.  The week starts with Sunday.  (00..53)
+      #       %W - Week number of the year.  The week starts with Monday.  (00..53)
       #
-      #    # Log to screen
-      #    SemanticLogger.add_appender(io: STDOUT, formatter: :color)
+      #     Time:
+      #       %H - 24 Hour of the day, zero-padded (00..23)
+      #       %M - Minute of the hour (00..59)
+      #       %S - Second of the minute (00..60)
       #
-      #    # And log to a file at the same time
-      #    SemanticLogger.add_appender(file_name: 'application.log', formatter: :color)
+      #     Examples:
+      #       Create a log file name consisting of the short host name, process id, date, and time.
+      #         "log/production-%n-%p-%D-%T.log"
       #
-      #    logger = SemanticLogger['test']
-      #    logger.info 'Hello World'
+      #   :level [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: SemanticLogger.default_level
       #
-      # Example 2. To log all levels to file and only :info and above to screen:
+      #   :formatter: [Object|Proc]
+      #     An instance of a class that implements #call, or a Proc to be used to format
+      #     the output from this appender
+      #     Default: Use the built-in formatter (See: #call)
       #
-      #    require 'semantic_logger'
+      #   :filter [Regexp|Proc]
+      #     RegExp: Only include log messages where the class name matches the supplied
+      #     regular expression. All other messages will be ignored.
+      #     Proc: Only include log messages where the supplied Proc returns true
+      #           The Proc must return true or false.
       #
-      #    # Enable trace level logging
-      #    SemanticLogger.default_level = :trace
+      #   :append [true|false]
+      #     Append to the log file if already present?
+      #     Default: true
       #
-      #    # Log to screen but only display :info and above
-      #    SemanticLogger.add_appender(io: STDOUT, level: :info)
+      #   :exclusive_lock [true|false]
+      #     Obtain an exclusive lock on the file, for operating systems that support it.
+      #     Prevents multiple processes from trying to write to the same log file.
+      #     Default: false
       #
-      #    # And log to a file at the same time, including all :trace level data
-      #    SemanticLogger.add_appender(file_name: 'application.log')
+      #   :encoding ["UTF-8", "UTF-16", etc.]
+      #     Encoding to use when writing to the file.
+      #     Default: Encoding::BINARY
       #
-      #    logger =  SemanticLogger['test']
-      #    logger.info 'Hello World'
-      def initialize(io: nil, file_name: nil, **args, &block)
-        if io
-          @log = io
-        else
-          @file_name = file_name
-          raise "SemanticLogging::Appender::File missing mandatory parameter :file_name or :io" unless file_name
-
-          reopen
+      #   :retry_count [Integer]
+      #     Number of times to attempt to re-open the file name when an error occurs trying to
+      #     write to the file.
+      #     Note: Set to 0 to disable retries.
+      #     Default: 1
+      #
+      #   :reopen_period [String]
+      #     Specify a period after which to re-open the log file, specified in minutes, hours, or days.
+      #     The format of the duration must start with an Integer or Float number,
+      #     followed by the duration specified as:
+      #       "m" : minutes
+      #       "h" : hours
+      #       "d" : days
+      #     The time is rounded down to the specified time interval, so that:
+      #     - "1h" will re-open every hour at the beginning of the hour.
+      #     - "30m" will re-open every 30 minutes at the beginning of the 30th minute.
+      #     - "1d" will re-open every day at midnight.
+      #     Examples:
+      #       "60m" : Every 60 minutes at the beginning of the minute: 10:24:00, 11:24:00, 12:24:00, ...
+      #       "1h"  : Every hour at the beginning of the hour: 10:00:00, 11:00:00, 12:00:00, ...
+      #       "1d"  : Every day at the beginning of the day: "20211008 00:00:00", "20211009 00:00:00", ...
+      #     Default: nil (Disabled)
+      #
+      #   :reopen_count [Integer]
+      #     Close and re-open the log file after every `reopen_count` number of logged entries.
+      #     Default: 0 (Disabled)
+      #
+      #   :reopen_size [Integer]
+      #     Approximate number of bytes to write to a log file by this process before closing and re-opening it.
+      #     Notes:
+      #     - When `append: true` and the file already exists, it reads the size of the current log file
+      #       and starts with that size.
+      #       - If the current log file size already exceeds the `reopen_size`, its current size is ignored.
+      #     - The `reopen_size` is only the amount of bytes written by this process, it excludes data
+      #       written by other processes. Use a unique filename to prevent multiple processes from writing to
+      #       the same log file at the same time.
+      #     Default: 0 (Disabled)
+      #
+      # Example
+      #    require "semantic_logger"
+      #
+      #    # Enable trace level logging
+      #    SemanticLogger.default_level = :info
+      #
+      #    # Log to a file
+      #    SemanticLogger.add_appender(file_name: "application.log", formatter: :color)
+      #
+      #    logger = SemanticLogger["test"]
+      #    logger.info "Hello World"
+      def initialize(file_name, retry_count: 1, append: true, reopen_period: nil, reopen_count: 0, reopen_size: 0, encoding: Encoding::BINARY, exclusive_lock: false, **args, &block)
+        if !file_name.is_a?(String) || file_name.empty?
+          raise(ArgumentError, "SemanticLogging::Appender::File file_name must be a non-empty string")
         end
 
+        @file_name      = file_name
+        @retry_count    = retry_count
+        @file           = nil
+        @append         = append
+        @reopen_period  = reopen_period
+        @reopen_count   = reopen_count
+        @reopen_size    = reopen_size
+        @encoding       = encoding
+        @exclusive_lock = exclusive_lock
+        @log_count      = 0
+        @log_size       = 0
+        @reopen_at      = nil
+
         super(**args, &block)
       end
 
       # After forking an active process call #reopen to re-open
-      # open the file handles etc to resources
-      #
-      # Note: This method will only work if :file_name was supplied
-      #       on the initializer.
-      #       If :io was supplied, it will need to be re-opened manually.
+      # open the file handles etc to resources.
       def reopen
-        return unless @file_name
+        begin
+          @file&.close
+        rescue StandardError
+          nil
+        end
+
+        self.current_file_name = apply_format_directives(file_name)
+        if ::File.directory?(file_name)
+          raise(ArgumentError, "The supplied log file_name: #{current_file_name} is already a directory.")
+        end
+
+        self.log_count = 0
+        if append && reopen_size && ::File.exist?(current_file_name)
+          self.log_size = ::File.size(current_file_name)
+          self.log_size = 0 if log_size >= reopen_size
+        else
+          self.log_size = 0
+        end
+
+        self.reopen_at = reopen_period ? next_reopen_period(reopen_period) : nil
 
-        @log = ::File.open(@file_name, ::File::WRONLY | ::File::APPEND | ::File::CREAT)
+        options = ::File::WRONLY | ::File::CREAT
+        options |= ::File::APPEND if append
+        @file = ::File.open(current_file_name, options)
         # Force all log entries to write immediately without buffering
         # Allows multiple processes to write to the same log file simultaneously
-        @log.sync = true
-        @log.set_encoding(Encoding::BINARY) if @log.respond_to?(:set_encoding)
-        @log
+        @file.sync = true
+        @file.set_encoding(encoding) if @file.respond_to?(:set_encoding)
+        @file.flock(::File::LOCK_EX) if exclusive_lock
+        @file
       end
 
-      # Pass log calls to the underlying Rails, log4j or Ruby logger
-      #  trace entries are mapped to debug since :trace is not supported by the
-      #  Ruby or Rails Loggers
+      # Since only one appender thread will be writing to the file at a time
+      # it is not necessary to protect access to the file with a semaphore.
       def log(log)
-        # Since only one appender thread will be writing to the file at a time
-        # it is not necessary to protect access to the file with a semaphore
-        # Allow this logger to filter out log levels lower than it's own
-        @log.write(formatter.call(log, self) << "\n")
+        reopen if time_to_reopen?
+
+        count = 0
+        begin
+          message = formatter.call(log, self) << "\n"
+          @file.write(message)
+          @log_count += 1
+          @log_size  += message.size
+        rescue StandardError => e
+          if count < retry_count
+            count += 1
+            reopen
+            retry
+          end
+          raise(e)
+        end
         true
       end
 
       # Flush all pending logs to disk.
-      #  Waits for all sent documents to be writted to disk
+      #  Waits for all sent documents to be written to disk
       def flush
-        @log.flush if @log.respond_to?(:flush)
+        @file&.flush
+      end
+
+      private
+
+      attr_writer :log_count, :log_size, :current_file_name, :reopen_at
+
+      def time_to_reopen?
+        return true unless @file
+
+        (reopen_count.positive? && (log_count >= reopen_count)) ||
+          (reopen_size.positive? && (log_size >= reopen_size)) ||
+          (reopen_at && (Time.now > reopen_at))
+      end
+
+      def apply_format_directives(file_name)
+        return file_name unless file_name.include?("%")
+
+        file_name.gsub(/%(.)/) { format_directive(Regexp.last_match(1)) }
+      end
+
+      def format_directive(directive)
+        case directive
+        when "p"
+          $$
+        when "n"
+          SemanticLogger.host.split(".")[0]
+        when "N"
+          SemanticLogger.host
+        when "a"
+          SemanticLogger.application
+        when "e"
+          SemanticLogger.environment
+        when "D"
+          Date.today.strftime("%Y%m%d")
+        when "Y", "C", "y", "m", "d", "j", "U", "W"
+          Date.today.strftime("%#{directive}")
+        when "T"
+          Time.now.strftime("%H%M%S")
+        when "H", "M", "S"
+          Time.now.strftime("%#{directive}")
+        when "%"
+          "%"
+        else
+          raise(ArgumentError, "Format Directive '#{directive}' in file_name: #{file_name} is not supported.")
+        end
+      end
+
+      def next_reopen_period(period_string)
+        return unless period_string
+
+        duration, period = parse_period(period_string)
+        calculate_reopen_at(duration, period)
+      end
+
+      def parse_period(period_string)
+        match = period_string.to_s.downcase.gsub(/\s+/, "").match(/([\d.]+)([mhd])/)
+        unless match
+          raise(ArgumentError,
+                "Invalid period definition: #{period_string}, must begin with an integer, followed by m,h, or d.")
+        end
+
+        duration = match[1]
+        period   = match[2]
+        raise(ArgumentError, "Invalid or missing duration in: #{period_string}, must begin with an integer.") unless duration
+        raise(ArgumentError, "Invalid or missing period in: #{period_string}, must end with m,h, or d.") unless period
+
+        [duration.to_i, period]
+      end
+
+      # Round down the current time based on the period, then add on the duration for that period
+      def calculate_reopen_at(duration, period, time = Time.now)
+        case period
+        when "m"
+          Time.new(time.year, time.month, time.day, time.hour, time.min, 0) + (duration * 60)
+        when "h"
+          Time.new(time.year, time.month, time.day, time.hour, 0, 0) + (duration * 60 * 60)
+        when "d"
+          Time.new(time.year, time.month, time.day, 0, 0, 0) + (duration * 24 * 60 * 60)
+        else
+          raise(ArgumentError, "Invalid or missing period in: #{reopen_period}, must end with m,h, or d.")
+        end
       end
     end
   end