lokilogger 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d31b9a0ca62456df630504045404e80c8fdc08376afc0d6eb420457d9b0745b
-  data.tar.gz: '0283cd8fe736ecf933699b54d60f31a3e973d232c8794e8cdebff560624d7802'
+  metadata.gz: 013c3df35dc258985f0bce263e8b891e77248458501166742e48323faf31a920
+  data.tar.gz: d333983151ff4524daedfdc1a5f7a94b6e25e427786dcf1103fba5113ce3adca
 SHA512:
-  metadata.gz: 338a081fc21929144d234674eb0cdaf64baf35e8fec2b9f84cf01f58acae1039ef6c9a6fcde6257126aee677ea21a6e4123f30246b9c020711d636955414d36f
-  data.tar.gz: eee408bb6e620234d75bee583aad338ae1200ce04d185027600bcd3d3ac4ac1bacd168002fc09abdfe52fca48baaee7d0a47d041351b1d29f3ae0f996370c33f
+  metadata.gz: 61907a403d311da65316452abf1beba6cc12fd8e98bf9283a576551b696972a42dd2496f77671f2d9491802269ad36153ff2f8fc894e375f505e9aa175847763
+  data.tar.gz: 4e392ebaf36816ce9442e6e1fa58b2fcadf68053280e79c0275b58daf89d0786b582a36371705595d19a5579ceaff99b3581583675ff005fdc465e24bcbc9914

data/README.adoc

@@ -59,14 +59,15 @@ Start by creating a new logger instance:
 
 [source,ruby]
 ----
-# pass url, username, password
-logger = Lokilogger.new({url:, log_level: 0, version: "v1", username:, password:, tags: {foo: "bar"}})
+# required: url, log_level, version and tags
+# optional: username and password (if one of them is nil, no auth will be used)
+logger = Lokilogger::Logger.new({url:, log_level: 0, version: "v1", username:, password:, tags: {foo: "bar"}})
 ----
 
 If you need proxy or custom TLS settings, you can optionally pass as well:
 
 - ssl_options (link:https://lostisland.github.io/faraday/#/customization/ssl-options[Faraday docs on ssl options])
-- proxy_options (link:https://lostisland.github.io/faraday/#/customization/proxy-options[Farady docs on proxy options])
+- proxy_options (link:https://lostisland.github.io/faraday/#/customization/proxy-options[Faraday docs on proxy options])
 
 then it's straight forward:
 

data/lib/lokilogger/client.rb

@@ -17,15 +17,13 @@ module Lokilogger
 
       Faraday.default_adapter = :async_http
       @conn = Faraday.new url: @config[:url], headers: {"Content-Type" => "application/json"}, ssl: ssl_options, proxy: proxy_options, request: request_options do |builder|
-        builder.request :authorization, :basic, @config[:username], @config[:password]
+        builder.request :authorization, :basic, @config[:username], @config[:password] if @config[:username] && @config[:password]
       end
     end
 
     def check_config
       fail ConfigError, "missing/malformed url in config" if !@config[:url] || @config[:url] !~ %r{^(http|https)://}
       fail ConfigError, "missing version in config" unless @config[:version]
-      fail ConfigError, "missing auth username in config" unless @config[:username]
-      fail ConfigError, "missing auth password in config" unless @config[:password]
       fail ConfigError, "missing tags in config" unless @config[:tags]
       fail ConfigError, "missing log_level in config" unless @config[:log_level]
     end

data/lib/lokilogger/formatter.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Lokilogger
+  # Default formatter for log messages.
+  class Formatter
+    Format = "%.1s, [%s #%d] %5s -- %s: %s\n"
+    DatetimeFormat = "%Y-%m-%dT%H:%M:%S.%6N"
+
+    attr_accessor :datetime_format
+
+    def initialize
+      @datetime_format = nil
+    end
+
+    def call severity, time, progname, msg
+      format Format, severity, format_datetime(time), Process.pid, severity, progname, msg2str(msg)
+    end
+
+    private
+
+    def format_datetime time
+      time.strftime(@datetime_format || DatetimeFormat)
+    end
+
+    def msg2str msg
+      case msg
+        when ::String
+          msg
+        when ::Exception
+          "#{msg.message} (#{msg.class})\n#{msg.backtrace.join "\n" if msg.backtrace}"
+        else
+          msg.inspect
+      end
+    end
+  end
+end

data/lib/lokilogger/severity.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lokilogger
+  # Logging severity.
+  module Severity
+    # Low-level information, mostly for developers.
+    DEBUG = 0
+    # Generic (useful) information about system operation.
+    INFO = 1
+    # A warning.
+    WARN = 2
+    # A handleable error condition.
+    ERROR = 3
+    # An unhandleable error that results in a program crash.
+    FATAL = 4
+    # An unknown message that should always be logged.
+    UNKNOWN = 5
+
+    LEVELS = {"debug" => DEBUG, "info" => INFO, "warn" => WARN, "error" => ERROR, "fatal" => FATAL, "unknown" => UNKNOWN}.freeze
+    private_constant :LEVELS
+
+    def self.coerce severity
+      if severity.is_a? Integer
+        severity
+      else
+        key = severity.to_s.downcase
+        LEVELS[key] || fail(ArgumentError, "invalid log level: #{severity}")
+      end
+    end
+  end
+end

data/lib/lokilogger/version.rb

@@ -2,5 +2,5 @@
 
 # Main namespace.
 module Lokilogger
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/lib/lokilogger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "lokilogger/formatter"
+require "lokilogger/severity"
 require "zeitwerk"
 
 Zeitwerk::Loader.new.then do |loader|
@@ -14,77 +16,109 @@ module Lokilogger
     @loader ||= registry.loaders.find { |loader| loader.tag == File.basename(__FILE__, ".rb") }
   end
 
-  def self.new config
-    @client = Lokilogger::Client.new config
-    self
-  end
+  class Logger
+    include Severity
 
-  def self.debug(*args)
-    message "debug", args
-  end
+    def initialize config
+      @client = Lokilogger::Client.new config
+      @default_formatter = Formatter.new
+    end
 
-  def self.debug?
-    true
-  end
+    def datetime_format= datetime_format
+      @default_formatter.datetime_format = datetime_format
+    end
 
-  def self.info(*args)
-    message "info", args
-  end
+    def datetime_format
+      @default_formatter.datetime_format
+    end
 
-  def self.info?
-    true
-  end
+    attr_accessor :formatter
 
-  def self.warn(*args)
-    message "warn", args
-  end
+    def debug(*args)
+      message "debug", args
+    end
 
-  def self.warn?
-    true
-  end
+    def debug?
+      @client.log_level <= DEBUG
+    end
 
-  def self.error(*args)
-    message "error", args
-  end
+    def debug!
+      @client.log_level = DEBUG
+    end
 
-  def self.error?
-    true
-  end
+    def info(*args)
+      message "info", args
+    end
 
-  def self.fatal(*args)
-    message "fatal", args
-  end
+    def info?
+      @client.log_level <= INFO
+    end
 
-  def self.fatal?
-    true
-  end
+    def info!
+      @client.log_level = INFO
+    end
 
-  def self.unknown(*args)
-    message "unknown", args
-  end
+    def warn(*args)
+      message "warn", args
+    end
 
-  def self.unknown?
-    true
-  end
+    def warn?
+      @client.log_level <= WARN
+    end
 
-  def self.level= level
-    @client.log_level = level
-  end
+    def warn!
+      @client.log_level = WARN
+    end
 
-  def self.level
-    @client.log_level
-  end
+    def error(*args)
+      message "error", args
+    end
 
-  def self.formatter
-  end
+    def error?
+      @client.log_level <= ERROR
+    end
 
-  def self.formatter=(*args)
-  end
+    def error!
+      @client.log_level = ERROR
+    end
+
+    def fatal(*args)
+      message "fatal", args
+    end
+
+    def fatal?
+      @client.log_level <= FATAL
+    end
+
+    def fatal!
+      @client.log_level = FATAL
+    end
+
+    def unknown(*args)
+      message "unknown", args
+    end
+
+    def unknown?
+      @client.log_level <= UNKNOWN
+    end
+
+    def unknown!
+      @client.log_level = UNKNOWN
+    end
+
+    def level= severity
+      @client.log_level = Severity.coerce severity
+    end
+
+    def level
+      @client.log_level
+    end
 
-  def self.message(severity, *args)
-    message = args[0][0]
-    extra_tags = args[0][1] if args[0].count > 1
+    def message(severity, *args)
+      message = args[0][0]
+      extra_tags = args[0][1] if args[0].count > 1
 
-    @client.request severity, message, extra_tags
+      @client.request severity, message, extra_tags
+    end
   end
 end

data/lokilogger.gemspec

@@ -15,9 +15,6 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {"label" => "lokilogger", "rubygems_mfa_required" => "true"}
 
-  #spec.signing_key = Gem.default_key_path
-  #spec.cert_chain = [Gem.default_cert_path]
-
   spec.required_ruby_version = "~> 3.2"
   spec.add_dependency "async", "~> 2.6", ">= 2.6.5"
   spec.add_dependency "async-http-faraday", "~> 0.12.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokilogger
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nils Bartels
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-03 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -106,6 +106,8 @@ files:
 - lib/lokilogger.rb
 - lib/lokilogger/client.rb
 - lib/lokilogger/error.rb
+- lib/lokilogger/formatter.rb
+- lib/lokilogger/severity.rb
 - lib/lokilogger/version.rb
 - lokilogger.gemspec
 homepage: https://gitlab.com/sukunai/lokilogger