rails_loki_exporter 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf716f8af36e10dc3e446c2dc7e044835927161c00cca433f666ef4c34afcd50
-  data.tar.gz: fd8d98a489d8123d88e5e28b048d33fedd5d069e3d88e884ab0e1ef5a4e8ff5c
+  metadata.gz: bce248aa49394ba911efadd30695bc1d71a19ea2e8cd9909099339a4cb2bc5eb
+  data.tar.gz: c744a44f2bd0ee8f01391d0a2b8da796bc84ff71fad4ac8d1cbf7b5d95c12fc3
 SHA512:
-  metadata.gz: b0e41dfe931cefead14aa113b5c35268757a43d517ba296ba48b410612b3f03721808d67896f64ca187cb5d36f9797c16152b2e9f50bdeef814913b4f6163cf0
-  data.tar.gz: 2a949bbe2ef8a94c40c5096992dea844598e043a20dba564f2aa43e86030cd2a0ede0ce34cbcfe1e2def25701a81c74bdedc0e6fee1f9a7df9f3c9a4e7c02ad8
+  metadata.gz: 40491ac4ac77da177c05f445ad2e31332535f4784654aaeebf78d81eb1ec15e45f5ad8db6306a955b47e67d887574f22cefcd7efac8759bcd4b050f05ecb3c90
+  data.tar.gz: 5a5d1ec7f81b184cee101091a3330c6f7c6d31d300681f6028d28e113bb732aa8cf2690aaf99dae689218f9c473bea2c5585299a11f48fe12fa42541bddf7bd6

data/lib/rails_loki_exporter/intercepting_logger.rb

@@ -8,7 +8,7 @@ module RailsLokiExporter
   class InterceptingLogger < ActiveSupport::Logger
     attr_accessor :client
 
-    SEVERITY_NAMES = %w(DEBUG INFO WARN ERROR FATAL).freeze
+    SEVERITY_NAMES = %w(DEBUG INFO WARN ERROR FATAL ANY).freeze
 
     def initialize(intercept_logs: false)
       @intercept_logs = intercept_logs
@@ -23,37 +23,18 @@ module RailsLokiExporter
       if log_message.nil?
         if block_given?
           log_message = yield
-        end
-      end
-
-      if @intercept_logs
-        if log_message.nil?
-          puts caller
         else
-          client.send_log(@log) if client
+          log_message = progname
+          progname = @progname
         end
       end
-      super(severity, message, progname, &block)
-    end
-
-    def debug(log_message = "")
-      client.send_log("#{log_message}") if client
-    end
 
-    def info(log_message = "")
-      client.send_log("#{log_message}") if client
-    end
-
-    def fatal(log_message = "")
-      client.send_log("#{log_message}") if client
-    end
-
-    def warn(log_message = "")
-      client.send_log("#{log_message}") if client
-    end
+      if @intercept_logs && !log_message.nil?
+          formatted_message = format_message(severity_name, Time.now, progname, log_message)
+          client.send_log(formatted_message) if client
+      end
 
-    def error(log_message = "")
-      client.send_log("#{log_message}") if client
+      super(severity, message, progname, &block)
     end
 
     def broadcast_to(console)

data/lib/rails_loki_exporter/loki_http_client.rb

@@ -0,0 +1,121 @@
+require 'socket'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module RailsLokiExporter
+  LOGS_TYPE = %w(ERROR WARN FATAL INFO DEBUG).freeze
+
+  class LokiHttpClient
+
+    def initialize(config)
+      uri = URI.parse(config['base_url'])
+      @base_url =       uri
+      @log_file_path =  config['log_file_path']
+      @logs_type =      config['logs_type']
+      @intercept_logs = config['intercept_logs']
+      @job_name =       config['job_name'] || "#{$0}_#{Process.pid}"
+      @host_name =      config['host_name'] || Socket.gethostname
+      @user_name =      config['user_name']
+      @password =       config['password']
+      @auth_enabled =   config['auth_enabled']
+      @log_buffer = []
+      @last_interaction_time = nil
+      @interaction_interval = 1       # in seconds, adjust as needed
+      @max_buffer_size = 10           # set the maximum number of logs to buffer
+
+      http = Net::HTTP.new(@base_url.to_s, @base_url.port)
+      http.use_ssl = @base_url.scheme == 'https'
+      http.read_timeout = 30
+      http.open_timeout = 30
+      http
+    end
+
+    def send_log(log_message)
+        @log_buffer << log_message
+        if @log_buffer.size >= @max_buffer_size || can_send_log?
+          send_buffered_logs
+          @last_interaction_time = Time.now
+        else
+          # @logger.info('Log buffered. Waiting for more logs or interaction interval.')
+        end
+    end
+
+    private
+    def send_buffered_logs
+      return if @log_buffer.empty?
+
+      curr_datetime = Time.now.to_i * 1_000_000_000
+      msg = "On server #{@host_name} detected error"
+      payload = {
+        'streams' => [
+          { 'stream' => {
+            'job' => @job_name,
+            'host' => @host_name },
+            'values' => @log_buffer.map { |log| [curr_datetime.to_s, log] }}
+        ]
+      }
+
+      json_payload = JSON.generate(payload)
+      uri = '/loki/api/v1/push'
+      post(uri, json_payload)
+
+      @log_buffer.clear
+    end
+
+    def can_send_log?
+      return true if @last_interaction_time.nil?
+
+      elapsed_time = Time.now - @last_interaction_time
+      elapsed_time >= @interaction_interval
+    end
+
+    def match_logs_type?(log_line)
+      return false if log_line.nil?
+
+      type_match = log_line.match(/(ERROR|WARN|FATAL|INFO|DEBUG)/)
+      type = type_match ? type_match.to_s : 'UNMATCHED'
+      type == 'UNMATCHED' || @logs_type.include?(type)
+    end
+    
+    def post(url_loki, body)
+      url = @base_url.to_s + url_loki
+      username = @user_name
+      password = @password
+      send_authenticated_post(url, body, username, password)
+    end
+  
+    def send_authenticated_post(url, body, username, password)
+      uri = URI.parse(url)
+      request = Net::HTTP::Post.new(uri.path)
+      request['Content-Type'] = 'application/json'
+      request.body = body
+  
+      if username && password && @auth_enabled
+        request.basic_auth(username, password)
+      else
+        raise "Username or password is nil."
+      end
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+  
+      case response
+      when Net::HTTPSuccess
+        response.body ? JSON.parse(response.body) : nil
+      when Net::HTTPNoContent
+        puts "Request successful, but no content was returned."
+        nil
+      else
+        raise "Failed to make POST request. Response code: #{response.code}, Response body: #{response.body}"
+      end
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+    end
+  
+    def base64_encode_credentials(user_name, password)
+      credentials = "#{user_name}:#{password}"
+      Base64.strict_encode64(credentials)
+    end
+  end
+end

data/lib/rails_loki_exporter/version.rb

@@ -1,3 +1,3 @@
 module RailsLokiExporter
-    VERSION = '1.0.2'
+    VERSION = '1.0.4'
 end 

data/lib/rails_loki_exporter.rb

@@ -7,23 +7,12 @@ module RailsLokiExporter
   class << self
     def create_logger(config_file_path)
       config = load_config(config_file_path)
-
-      connection_instance =  MyConnection.new(
-        config['base_url'],
-        config['user_name'],
-        config['password'],
-        config['auth_enabled'],
-        config['host_name'],
-        config['job_name']
-      )
-
-      client = Client.new(config)
+      client = LokiHttpClient.new(config)
       logger = InterceptingLogger.new(intercept_logs: config['intercept_logs'])
       if config['enable_log_subscriber'] 
         CustomLogSubscriber.client = client
       end
       logger.client = client
-      client.connection = connection_instance
       logger
     end
 
@@ -35,7 +24,6 @@ module RailsLokiExporter
       if File.exist?(expanded_path)
         config_erb = ERB.new(File.read(expanded_path)).result
         config = YAML.safe_load(config_erb, aliases: true)
-        puts config.to_json
         return config
       else
         puts "Config file not found: #{expanded_path}"

data/rails_loki_exporter.gemspec

@@ -3,11 +3,11 @@ require File.expand_path('lib/rails_loki_exporter/version', __dir__)
 Gem::Specification.new do |spec|
     spec.name                  = 'rails_loki_exporter'
     spec.version               = RailsLokiExporter::VERSION
-    spec.authors               = ['Oleg Ten', 'Assiya Kalykova']
-    spec.email                 = ['tennet0505@gmail.com']
-    spec.summary               = 'Ruby for Grafana Loki'
-    spec.description           = 'Attempt to make gem'
-    spec.homepage              = 'https://rubygems.org/gems/hello_app_ak_gem'
+    spec.authors               = ['planning.how', 'Oleg Ten', 'Assiya Kalykova']
+    spec.email                 = ['info@planning.how']
+    spec.summary               = 'Rails Loki exporter'
+    spec.description           = 'Export logs for your Rails application to Loki instance and access them through Grafana dashboard.'
+    spec.homepage              = 'https://github.com/planninghow/rails-loki-exporter'
     spec.license               = 'MIT'
     spec.platform              = Gem::Platform::RUBY
     spec.required_ruby_version = '>= 2.7.0'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rails_loki_exporter
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
+- planning.how
 - Oleg Ten
 - Assiya Kalykova
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -39,9 +40,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Attempt to make gem
+description: Export logs for your Rails application to Loki instance and access them
+  through Grafana dashboard.
 email:
-- tennet0505@gmail.com
+- info@planning.how
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -50,15 +52,12 @@ files:
 - Gemfile
 - README.md
 - lib/rails_loki_exporter.rb
-- lib/rails_loki_exporter/client.rb
-- lib/rails_loki_exporter/connection.rb
 - lib/rails_loki_exporter/custom_log_subscriber.rb
 - lib/rails_loki_exporter/intercepting_logger.rb
-- lib/rails_loki_exporter/my_connection.rb
-- lib/rails_loki_exporter/query.rb
+- lib/rails_loki_exporter/loki_http_client.rb
 - lib/rails_loki_exporter/version.rb
 - rails_loki_exporter.gemspec
-homepage: https://rubygems.org/gems/hello_app_ak_gem
+homepage: https://github.com/planninghow/rails-loki-exporter
 licenses:
 - MIT
 metadata: {}
@@ -80,5 +79,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Ruby for Grafana Loki
+summary: Rails Loki exporter
 test_files: []

data/lib/rails_loki_exporter/client.rb

@@ -1,92 +0,0 @@
-require 'socket'
-module RailsLokiExporter
-  LOGS_TYPE = %w(ERROR WARN FATAL INFO DEBUG).freeze
-
-  class Client
-    include RailsLokiExporter::Connection
-
-    attr_accessor :job_name
-    attr_accessor :host_name
-    attr_accessor :max_buffer_size
-    attr_accessor :interaction_interval
-    attr_accessor :connection
-
-    def initialize(config)
-      @base_url = config['base_url']
-      @log_file_path = config['log_file_path']
-      @logs_type = config['logs_type']
-      @intercept_logs = config['intercept_logs']
-      @job_name = config['job_name'] || "#{$0}_#{Process.pid}"
-      @host_name = config['host_name'] || Socket.gethostname
-      @log_buffer = []
-      @last_interaction_time = nil
-      @interaction_interval = 1 # in seconds, adjust as needed
-      @max_buffer_size = 10 # set the maximum number of logs to buffer
-      @connection = connection
-    end
-
-    def send_all_logs
-      File.open(@log_file_path, 'r') do |file|
-        file.each_line do |line|
-          send_log(line) 
-        end
-      end
-    end
-
-    def send_log(log_message)
-        @log_buffer << log_message
-        if @log_buffer.size >= @max_buffer_size || can_send_log?
-          send_buffered_logs
-          @last_interaction_time = Time.now
-        else
-          # @logger.info('Log buffered. Waiting for more logs or interaction interval.')
-        end
-    end
-
-    private
-    def send_buffered_logs
-      return if @log_buffer.empty?
-
-      curr_datetime = Time.now.to_i * 1_000_000_000
-      msg = "On server #{@host_name} detected error"
-      payload = {
-        'streams' => [
-          {
-            'stream' => {
-              'job' => @job_name,
-              'host' => @host_name
-            },
-            'values' => @log_buffer.map { |log| [curr_datetime.to_s, log] },
-            'entries' => @log_buffer.map do |_|
-              {
-                'ts' => curr_datetime,
-                'line' => "[WARN] " + msg
-              }
-            end
-          }
-        ]
-      }
-
-      json_payload = JSON.generate(payload)
-      uri = '/loki/api/v1/push'
-      @connection.post(uri, json_payload)
-
-      @log_buffer.clear
-    end
-
-    def can_send_log?
-      return true if @last_interaction_time.nil?
-
-      elapsed_time = Time.now - @last_interaction_time
-      elapsed_time >= @interaction_interval
-    end
-
-    def match_logs_type?(log_line)
-      return false if log_line.nil?
-
-      type_match = log_line.match(/(ERROR|WARN|FATAL|INFO|DEBUG)/)
-      type = type_match ? type_match.to_s : 'UNMATCHED'
-      type == 'UNMATCHED' || @logs_type.include?(type)
-    end
-  end
-end

data/lib/rails_loki_exporter/connection.rb

@@ -1,60 +0,0 @@
-require 'json'
-require 'net/http'
-require 'uri'
-
-module RailsLokiExporter
-  module Connection
-    def initialize(base_url, user_name, password, auth_enabled, host_name, job_name)
-      uri = URI.parse(base_url)
-      @base_url = uri
-      @user_name = user_name
-      @password = password
-      @auth_enabled = auth_enabled
-    end
-    def connection
-      http = Net::HTTP.new(@base_url.to_s, @base_url.port)
-      http.use_ssl = @base_url.scheme == 'https'
-      http.read_timeout = 30 # Adjust as needed
-      http.open_timeout = 30 # Adjust as needed
-      http
-    end
-    def post(url_loki, body)
-      url = @base_url.to_s + url_loki
-      username = @user_name
-      password = @password
-      send_authenticated_post(url, body, username, password)
-    end
-    def send_authenticated_post(url, body, username, password)
-      uri = URI.parse(url)
-      request = Net::HTTP::Post.new(uri.path)
-      request['Content-Type'] = 'application/json'
-      request.body = body
-
-      if username && password && @auth_enabled
-        request.basic_auth(username, password)
-      else
-        raise "Username or password is nil."
-      end
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
-        http.request(request)
-      end
-
-      case response
-      when Net::HTTPSuccess
-        response.body ? JSON.parse(response.body) : nil
-      when Net::HTTPNoContent
-        puts "Request successful, but no content was returned."
-        nil
-      else
-        raise "Failed to make POST request. Response code: #{response.code}, Response body: #{response.body}"
-      end
-    rescue StandardError => e
-      puts "Error: #{e.message}"
-    end
-    def base64_encode_credentials(user_name, password)
-      credentials = "#{user_name}:#{password}"
-      Base64.strict_encode64(credentials)
-    end
-  end
-end

data/lib/rails_loki_exporter/my_connection.rb

@@ -1,8 +0,0 @@
-module RailsLokiExporter
-    class MyConnection
-      include Connection
-      def self.create(base_url, user_name, password, auth_enabled, host_name, job_name)
-        new(base_url, user_name, password, auth_enabled, host_name, job_name).connection
-      end
-    end
-end

data/lib/rails_loki_exporter/query.rb

@@ -1,8 +0,0 @@
-module RailsLokiExporter
-    class Query
-        attr_reader :streams_data
-        def initialize(response) 
-            @streams_data = response['streams']
-        end
-    end     
-end