coralogix_logger 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d582d5614b14fbb964f88944c436960ce35ebcd2
-  data.tar.gz: 72644f9c85ec8be14f7f7a7cda905c7ab5635764
+  metadata.gz: 444f4d0977a5a0d4a0111d7e5f5a7a4ed3428d2d
+  data.tar.gz: b43e3f213458541180e6e14782ac5d93f3457bf9
 SHA512:
-  metadata.gz: be293a220f99fad2f522db411f8698e10cab3e48d710ebbe7c4b458dbeccf6f55b8490020067cd97e0b54aa0a371a3f6232bca058a704cbe97f35e5c16a955c1
-  data.tar.gz: 61a94a4d2b80727950aa227d745b673983fe5c75f6998f66bb4b22c4b7265483642ac895412eff0621f08af1c19e7a49452cb274d06c92b4a2a9539cafb31010
+  metadata.gz: e648ae6b4703093c37be7ef9db79018fbef19b97e93748e3b32cfedf95f0234e51cd6742e47f710ed57b9fbdc93c8f0e3b2017bb50e3f75ccf21e5e0910a19b4
+  data.tar.gz: abab7b3b0313cb6c206929437a99822919cd2fcec39f4d4f21d05b936394c9baaf7946ade6ff55f48a819bfbe293029fd7b8a61e6427830892a8f53cbaa1ac9f

data/README.md

@@ -33,17 +33,18 @@ You must provide the following four variables when creating a Coralogix logger i
     APP_NAME = "MyTestApp"  
     SUB_SYSTEM = "BL"     
 
+    # Configure Coralogix SDK. You need to define it only once per process.
     Coralogix::CoralogixLogger.configure(PRIVATE_KEY, APP_NAME, SUB_SYSTEM)
 
-    #The common practice is to get an instance of the logger in each class and setting the logger name to the class name.
-    logger = Coralogix::CoralogixLogger.get_logger("category1")
+    # The common practice is to get an instance of the logger in each class and setting the logger name to the class name.
+    # logger name will be used as category unless specified otherwise.
+    logger = Coralogix::CoralogixLogger.get_logger("my class")
     
-    #Send "Hello World!" message with severity verbose. 
+    # Send "Hello World!" message with severity verbose. 
     logger.log(Coralogix::Severity::VERBOSE, "Hello World!")
 
-    #Additional options
-    #Severity, category and message parameters are mandatory. The rest of the parameters are optional.
-    #If category is not specified, logger name will be used instead
+    # Additional options
+    # Severity and message parameters are mandatory. The rest of the parameters are optional.
     logger.log(Coralogix::Severity::DEBUG, "Hello World!", category: "my category")
     logger.log(Coralogix::Severity::INFO, "Hello World!", category: "my category", className: "my class")
     logger.log(Coralogix::Severity::WARNING, "Hello World!", category: "my category", className: "my class", methodName: "my method")

data/lib/constants.rb

@@ -27,19 +27,19 @@ module Coralogix
 
 
     #Coralogix logs url
-    CORALOGIX_LOG_URL = "https://test.coralogix.com:443/api/v1/logs"
+    CORALOGIX_LOG_URL = "https://api.coralogix.com:443/api/v1/logs"
 
     #Coralogix time delat url
-    CORALOGIX_TIME_DELTA_URL = "https://test.coralogix.com:443/sdk/v1/time"
+    CORALOGIX_TIME_DELTA_URL = "https://api.coralogix.com:443/sdk/v1/time"
 
     #Default private key
     FAILED_PRIVATE_KEY = "9626c7dd-8174-5015-a3fe-5572e042b6d9"
 
     #Default application name
-    FAILED_APP_NAME = "FAILED_APP_NAME"  
+    NO_APP_NAME = "NO_APP_NAME"  
 
     #Default subsystem name
-    FAILED_SUB_SYSTEM = "FAILED_SUB_NAME"
+    NO_SUB_SYSTEM = "NO_SUB_NAME"
 
     #Default log file name
     LOG_FILE_NAME = "coralogix.sdk.log"
@@ -53,4 +53,10 @@ module Coralogix
     #Interval between failed http post requests
     HTTP_SEND_RETRY_INTERVAL = 2
 
+    # Coralogix category
+    CORALOGIX_CATEGORY = 'CORALOGIX'
+
+    # Sync time update interval
+    SYNC_TIME_UPDATE_INTERVAL = 5 #minutes
+
 end

data/lib/coralogix_logger.rb

@@ -61,6 +61,9 @@ module Coralogix
         # @param sub_system     -   sub system name
         # @return [boolean] return a true or false.
         def self.configure private_key, app_name, sub_system
+            private_key = private_key.strip.empty? ? FAILED_PRIVATE_KEY : private_key
+            app_name = app_name.strip.empty? ? NO_APP_NAME : app_name
+            sub_system = sub_system.strip.empty? ? NO_SUB_SYSTEM : sub_system
             LoggerManager.configure(:privateKey => private_key, :applicationName => app_name, :subsystemName => sub_system) unless LoggerManager.configured
         end
 
@@ -72,7 +75,7 @@ module Coralogix
         # @param className   -   log class name
         # @param methodName  -   log method name
         # @param threadId    -   log thread id
-        def log severity, message, category: @category, className: "", methodName: "", threadId: ""
+        def log severity, message, category: @category, className: "", methodName: "", threadId: Thread.current.object_id.to_s
             LoggerManager.add_logline message, severity, category, :className => className, :methodName => methodName, :threadId => threadId
         end 
 
@@ -81,7 +84,7 @@ module Coralogix
         # For instance, for info severity it will create a method:
         # def info message, category: @category, className: "", methodName: "", threadId: ""
         SEVERITIES.keys.each do |severity|
-            define_method("#{severity}") do |message, category: @category, className: "", methodName: "", threadId: ""|
+            define_method("#{severity}") do |message, category: @category, className: "", methodName: "", threadId: Thread.current.object_id.to_s|
                 LoggerManager.add_logline message, SEVERITIES["#{__method__}".to_sym], category, :className => className, :methodName => methodName, :threadId => threadId
             end  
         end

data/lib/httpsender.rb

@@ -6,13 +6,13 @@ require 'openssl'
 require 'benchmark'
 require 'date'
 require 'time'
-
 module Coralogix
     # @private
     module CoralogixHTTPSender
         TICKS_IN_SECOND = 10**7
         @initialized = false
-        
+        @mutex = Mutex.new
+
         def CoralogixHTTPSender.disable_proxy value
             @disable_proxy = value
         end
@@ -33,7 +33,9 @@ module Coralogix
                 @http.keep_alive_timeout = 10
                 @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
                 @http.read_timeout = HTTP_TIMEOUT # seconds
+                
                 @req = Net::HTTP::Post.new(@uri.path, 'Content-Type' => 'application/json')
+                #@req_get = Net::HTTP::Get.new URI(CORALOGIX_TIME_DELTA_URL)
                 @initialized = true
             rescue Exception => e  
                     DebugLogger.error e.message  
@@ -73,29 +75,31 @@ module Coralogix
         #
         # @return [float]    -   time delta
         def CoralogixHTTPSender.get_time_sync
-            self.initialize unless @initialized
-            begin
-                DebugLogger.info "Syncing time with coralogix server"
-                res = @http.get(CORALOGIX_TIME_DELTA_URL)
-                
-                if res.is_a?(Net::HTTPSuccess) && !res.body.to_s.empty?
-                    #Get server ticks from 1970
-                    server_ticks = res.body.to_i.to_s # Relative to 1970
-                    #Take the first 13 digits
-                    server_ticks = server_ticks[0..12]
-                    #Convert the ticks to utc time
-                    server_time = Time.parse(Time.at(server_ticks.to_i / 1000.to_f).strftime('%H:%M:%S.%L')).utc
-                    local_time = Time.now.utc
+            @mutex.synchronize do
+                self.initialize unless @initialized
+                begin
+                    DebugLogger.info "Syncing time with coralogix server"
+                    res = @http.get(CORALOGIX_TIME_DELTA_URL)
                     
-                    time_delta = (server_time - local_time) * 1000.0
-                    DebugLogger.info "Updating time delta to: #{time_delta}"
-                    return true, time_delta
+                    if res.is_a?(Net::HTTPSuccess) && !res.body.to_s.empty?
+                        #Get server ticks from 1970
+                        server_ticks = res.body.to_i.to_s # Relative to 1970
+                        #Take the first 13 digits
+                        server_ticks = server_ticks[0..12]
+                        #Convert the ticks to utc time
+                        server_time = Time.parse(Time.at(server_ticks.to_i / 1000.to_f).strftime('%H:%M:%S.%L')).utc
+                        local_time = Time.now.utc
+                        
+                        time_delta = (server_time - local_time) * 1000.0
+                        DebugLogger.info "Updating time delta to: #{time_delta}"
+                        return true, time_delta
+                    end
+                    return false, 0
+                rescue Exception => e  
+                    DebugLogger.error e.message  
+                    DebugLogger.error e.backtrace.inspect  
+                    return false, 0
                 end
-                return false, 0
-            rescue Exception => e  
-                DebugLogger.error e.message  
-                DebugLogger.error e.backtrace.inspect  
-                return false, 0
             end
         end
     end

data/lib/manager.rb

@@ -15,7 +15,7 @@ module Coralogix
         def self.initialize
             @buffer = []
             @buffer_size = 0
-            @bulk_template = {:privateKey => FAILED_PRIVATE_KEY, :applicationName => FAILED_APP_NAME, :subsystemName => FAILED_SUB_SYSTEM}
+            @bulk_template = {:privateKey => FAILED_PRIVATE_KEY, :applicationName => NO_APP_NAME, :subsystemName => NO_SUB_SYSTEM}
             @mutex = Mutex.new
             @time_delta_last_update = 0
             @time_delta = 0
@@ -32,12 +32,27 @@ module Coralogix
         def self.configure **args
             begin
                 @bulk_template = args.merge({:computerName => `hostname`.strip})
-                configured = true
-            rescue
-                return false
+                DebugLogger.info "Successfully configured Coralogix logger."
+                @configured = true                
+                self.update_time_delta_interval
+                self.add_logline "The Application Name #{@bulk_template[:applicationName]} and Subsystem Name #{@bulk_template[:subsystemName]} from the Ruby SDK, version #{self.version?} has started to send data.", Severity::INFO, CORALOGIX_CATEGORY 
+            rescue Exception => e  
+                DebugLogger.error e.message  
+                DebugLogger.error e.backtrace.inspect
+                @configured = false
             end
+            return @configured
         end
 
+        def self.version?
+            begin
+                Gem.loaded_specs['coralogix_logger'].version.to_s
+            rescue Exception => e  
+                DebugLogger.error e.message  
+                DebugLogger.error e.backtrace.inspect
+                return '0.0.0'
+            end
+        end
         # Add a log line to our buffer.
         #
         # @param message    -   The logs message. This is a must parameter.
@@ -55,10 +70,8 @@ module Coralogix
                         #Combine a logentry from the must parameters together with the optional one.
                         new_entry = {:text => message, :timestamp => Time.now.utc.to_f * 1000 + @time_delta, :severity => severity, :category => category}.merge(args)
                         @buffer << new_entry
-                        #Updte the buffer size to reflect the new size.
+                        #Update the buffer size to reflect the new size.
                         @buffer_size+=new_entry.to_json.bytesize
-                    else
-                        DebugLogger.warn "Buffer is full. Ignoring current message."
                     end
                 end
             rescue Exception => e  
@@ -77,12 +90,17 @@ module Coralogix
                 @mutex.synchronize do
                     # Total buffer size
                     size = @buffer.size
+                    return unless size > 0
 
                     # If the size is bigger than the maximum allowed chunk size then split it by half.
                     # Keep splitting it until the size is less than MAX_LOG_CHUNK_SIZE
-                    while @buffer.take(size).join(",").bytesize > MAX_LOG_CHUNK_SIZE
+                    while (@buffer.take(size).join(",").bytesize > MAX_LOG_CHUNK_SIZE) || (size == 0) 
                         size=size/2;
                     end
+                    
+                    # We must take at leat one value. If the first message is bigger than MAX_LOG_CHUNK_SIZE
+                    # we need to take it anyway.
+                    size = size > 0 ? size : 1
 
                     DebugLogger.info "Checking buffer size. Total log entries is: #{size}"
                     @bulk_template[:logEntries] = @buffer.shift(size)
@@ -90,6 +108,9 @@ module Coralogix
                     # Extract from the buffer size the total amount of the logs we removed from the buffer
                     @buffer_size-= (@bulk_template[:logEntries].to_json.bytesize - 2 - size-1)
 
+                    # Make sure we are always positive
+                    @buffer_size = @buffer_size >= 0 ? @buffer_size : 0
+
                     DebugLogger.info "Bufer size after removal is: #{@buffer.join(",").bytesize}"
                 end
                 CoralogixHTTPSender.send_request(@bulk_template) unless @bulk_template[:logEntries].empty?
@@ -103,7 +124,7 @@ module Coralogix
         def self.update_time_delta_interval
             begin
                 #If more than 5 seconds passed from the last sync update
-                if ((DateTime.now.strftime('%Q').to_i - @time_delta_last_update) / 1000) >= 300 #5 minuts
+                if ((DateTime.now.strftime('%Q').to_i - @time_delta_last_update) / 1000) >= (60 * SYNC_TIME_UPDATE_INTERVAL) #5 minuts
                     res, _time_delta = CoralogixHTTPSender.get_time_sync
                     if res
                         @time_delta = _time_delta

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coralogix_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Royee Goldberg