le 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c28e499c3453e636efe4c437f2ad4c0ab1b0fc0
-  data.tar.gz: b276ef975d89403e9d8d59803ec23abe64354e61
+  metadata.gz: 8106a0e740c344c588e5bfb06acb2d55af4d5437
+  data.tar.gz: 2b9b1ca54e831725a66901b1b08f5b88892dbcd5
 SHA512:
-  metadata.gz: f0b91de7609636128de8d0074c5148c783159b96d7d201ecea101941109ddd3bbaf54e8fb1166b55fd3b50f613ac1b7833416c568b0f62e19029b138bd204f31
-  data.tar.gz: e78ba124558eb27feb271ef5d15b6db53e73c46e717c44467d5abe4186961b345e8c2640c05be2365ff86279e52e70d775a4ad8c7cb66cbf1d7872dcc9b5431f
+  metadata.gz: a013042da9ae780192a3f2808eff3343f0a5072cf2831b79432b1375098903eef6fee9a5da6d27e644ecbcaaa27b036e5e2a79b0bae1334c876623276c295c17
+  data.tar.gz: d5346caa17e4911bbac88de74352dff4eb82781bec50f6410f48cc452824cd1935188c39427132b92fa61184e42c9450cd6203577d202982eb089a5600c8ef03

data/LE.gemspec

@@ -5,7 +5,7 @@ require 'le'
 
 Gem::Specification.new do |gem|
   gem.name	= "le"
-  gem.version	= "2.4.0"
+  gem.version	= "2.5.0"
   gem.date	= Time.now
   gem.summary	= "Logentries plugin"
   gem.licenses    = ["MIT"]

data/README.md

@@ -41,7 +41,8 @@ Then from the cmd line run the following command:
 This will install the gem on your local environment.
 
 The next step is to configure the default rails logger to use the logentries
-logger.
+logger.  
+
 
 In your environment configuration file ( for production : `config/environments/production.rb`), add the following:
 
@@ -74,4 +75,42 @@ You can also specify the default level of the logger by adding a :
 
 For the `LOGENTRIES_TOKEN` argument, paste the token for the logfile you created earlier in the Logentries UI.
 
+
+Step for setting up DataHub 
+---------------------------
+
+**datahub_endpoint - User Defined Array**
+
+datahub_endpoint = Array ["127.0.0.1", "10000"]  
+datahub_endpoint is a user defined variable array for a datahub_endpoint
+The 1st parameter is a String which is the DataHub Instance's IP Address.  Entering ANY value in this field will disable your Token-based
+logging, set your Token to "" and will direct all log events to your specified DataHub IP Address.
+
+The 2nd parameter is a String which is the DataHub Port value, default is 10000 but this can be changed on your DataHub Machine.
+This port number must be set, on your DataHub Machine's leproxy settings your /etc/leproxy/leproxyLocal.config file.  It's default is 10000
+NOTE: if datahub_endpoint has been assigned an IP address and SSL = true, your server will fail gracefully.
+When using Datahub do not enable SSL = true  
+
+
+**host_id**
+
+host_id = "abc1234"  
+Enter_host_id inside the quotation marks.  Leaving this empty leave the host_id empty and thus not appear in your log events.
+
+
+**custom_host_name - User Defined Array**
+
+custom_host = Array[ true, "mikes_app_server"]         
+The 1st parameter is a Boolean value to use the custom host name.
+The 2nd parameter is a String which is the custom_host_name you'd like to assign.  
+
+If the 2nd parameter is left as in custom_host = Array[ true, ""] the code will attempt to get your host machine's name using the socket.gethostname method.
+
+
+
+Using the above user defined variable settings, you can now also specify the several of the optional arguments for the logger constructor by adding:
+
+    Rails.logger = Le.new(token, :ssl=>ssl, :datahub_endpoint=>datahub_endpoint, :host_id=>host_id, :custom_host=>custom_host)
+
+
 Now, simply use `Rails.logger.info("message")` inside your code to send logs to Logentries

data/lib/le.rb

@@ -6,15 +6,26 @@ module Le
 
   def self.new(token, options={})
 
-    self.checkParams(token)
+    opt_local     = options[:local]                     || false
+    opt_debug     = options[:debug]                     || false
+    opt_ssl       = options[:ssl]                       || false
+    opt_tag       = options[:tag]                       || false
+    opt_log_level = options[:log_level]                 || Logger::DEBUG
 
-    opt_local     = options[:local]     || false
-    opt_debug     = options[:debug]     || false
-    opt_ssl       = options[:ssl]       || false
-    opt_tag       = options[:tag]       || false
-    opt_log_level = options[:log_level] || Logger::DEBUG
+    opt_datahub_enabled = options[:datahub_enabled]     || false
+    opt_datahub_endpoint = options[:datahub_endpoint]   || ['', 10000]
+    opt_datahub_ip = options[:datahub_ip]               || ''
+    opt_datahub_port    = options[:datahub_port]        || 10000
+    opt_host_id = options[:host_id] || ''
+    opt_host_name_enabled = options[:host_name_enabled] || false
+    opt_host_name = options[:host_name]                 || ''
+    opt_custom_host = options[:custom_host]             || [false, '']
+  
 
-    host = Le::Host.new(token, opt_local, opt_debug, opt_ssl)
+    self.checkParams(token, opt_datahub_enabled)
+
+
+    host = Le::Host.new(token, opt_local, opt_debug, opt_ssl, opt_datahub_endpoint, opt_host_id, opt_custom_host)
 
     if defined?(ActiveSupport::TaggedLogging) &&  opt_tag
       logger = ActiveSupport::TaggedLogging.new(Logger.new(host))
@@ -31,10 +42,16 @@ module Le
     logger
   end
 
-  def self.checkParams(token)
+  def self.checkParams(token, opt_datahub_enabled)
     # Check if the key is valid UUID format
-    if (token =~ /\A(urn:uuid:)?[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i) == nil
-       puts "\nLE: It appears the LOGENTRIES_TOKEN you entered is invalid!\n"
-    end
+
+    if (!opt_datahub_enabled)  # test Token only when DataHub is not enabled
+      if (token =~ /\A(urn:uuid:)?[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i) == nil
+         puts "\nLE: It appears the LOGENTRIES_TOKEN you entered is invalid!\n"
+      else
+        (token="")
+     end
+   end 
   end
+
 end

data/lib/le/host.rb

@@ -1,8 +1,10 @@
 module Le
   module Host
 
-    def self.new(token, local, debug, ssl)
-      Le::Host::HTTP.new(token, local, debug, ssl)
+#!    def self.new(token, local, debug, ssl, datahub_enabled, datahub_ip, datahub_port, host_id, host_name_enabled, host_name)
+    def self.new(token, local, debug, ssl, datahub_endpoint, host_id, custom_host)
+
+      Le::Host::HTTP.new(token, local, debug, ssl, datahub_endpoint, host_id, custom_host)
     end
 
     module InstanceMethods

data/lib/le/host/http.rb

@@ -7,7 +7,9 @@ module Le
   module Host
     class HTTP
       LIBRARY_IDENTIFIER = '###R01### - Library initialised'
+#      API_SERVER = 'api.logentries.com'
       API_SERVER = 'api.logentries.com'
+
       API_PORT = 10000
       API_SSL_PORT = 20000
       API_CERT = '-----BEGIN CERTIFICATE-----
@@ -47,25 +49,79 @@ S5ol3bQmY1mv78XKkOk=
 
 
       include Le::Host::InstanceMethods
-      attr_accessor :token, :queue, :started, :thread, :conn, :local, :debug, :ssl
+#!      attr_accessor :token, :queue, :started, :thread, :conn, :local, :debug, :ssl, :datahub_enabled, :dathub_ip, :datahub_port, :host_id, :custom_host, :host_name_enabled, :host_name
+      attr_accessor :token, :queue, :started, :thread, :conn, :local, :debug, :ssl, :datahub_enabled, :datahub_ip, :datahub_port, :datahub_endpoint, :host_id, :host_name_enabled, :host_name, :custom_host
+
 
-      def initialize(token, local, debug, ssl)
-        if local
-          device = if local.class <= TrueClass
-            if defined?(Rails)
-              Rails.root.join("log","#{Rails.env}.log")
+      def initialize(token, local, debug, ssl, datahub_endpoint, host_id, custom_host)
+          if local
+            device = if local.class <= TrueClass
+              if defined?(Rails)
+                Rails.root.join("log","#{Rails.env}.log")
+              else
+                STDOUT
+              end
             else
-              STDOUT
-            end
-          else
             local
-          end
+            end
           @logger_console = Logger.new(device)
+          end
+        
+          @local = !!local
+          @debug= debug  
+          @ssl = ssl
+
+        @datahub_endpoint = datahub_endpoint
+        if !@datahub_endpoint[0].empty?           
+          @datahub_enabled=true
+          @datahub_ip="#{@datahub_endpoint[0]}"
+          @datahub_port=@datahub_endpoint[1]
+        else
+          @datahub_enabled=false  
+        end
+
+
+        if (@datahub_enabled && @ssl)
+          puts ("\n\nYou Cannot have DataHub and SSL enabled at the same time.  Please set SSL value to false in your environment.rb file or used Token-Based logging by leaving the Datahub IP address blank. Exiting application. \n\n")
+          exit 
         end
-        @token = token
-        @local = !!local
-        @debug = debug
-        @ssl = ssl
+
+
+ #check if DataHub is enabled... if datahub is not enabled, set the token to the token's parameter.  If DH is enabled, make the token empty.
+        if (!datahub_enabled)
+           @token = token
+        else
+          @token = ''
+
+ #! NOTE THIS @datahub_port conditional MAY NEED TO BE CHANGED IF SSL CAN'T WORK WITH DH        
+          @datahub_port = @datahub_port.empty? ?  API_SSL_PORT : datahub_port
+          @datahub_ip = datahub_ip
+        end
+
+        @host_name_enabled=custom_host[0];
+        @host_name= custom_host[1];
+         
+
+# Check if host_id is empty -- if not assign, if so, make it an empty string.
+       if !host_id.empty?
+          @host_id = host_id
+          @host_id = "host_id=#{host_id}"
+        else  
+          @host_id=''
+        end
+
+
+
+#assign host_name, if no host name is given and host_name_enabled = true... assign a host_name based on the machine name.
+       if @host_name_enabled
+          if host_name.empty?
+            @host_name=Socket.gethostname
+          end
+
+          @host_name="host_name=#{@host_name}"
+        end
+
+
         @queue = Queue.new
 	# Add identifer msg to queue to be sent first
         @queue << "#{@token}#{LIBRARY_IDENTIFIER}\n"
@@ -93,14 +149,23 @@ S5ol3bQmY1mv78XKkOk=
       end
 
       def write(message)
+
+        if !host_id.empty? 
+          message = "#{message} #{ host_id }"
+        end
+
+        if host_name_enabled
+          message="#{message} #{ host_name }"
+        end
+
         if @local
           @logger_console.add(Logger::Severity::UNKNOWN, message)
         end
 
         if message.scan(/\n/).empty?
-          @queue << "#{ @token } #{ message }\n"
+          @queue << "#{ @token } #{ message } \n" 
         else
-          @queue << "#{ message.gsub(/^/, "\1#{ @token } [#{ random_message_id }] ") }\n"
+          @queue << "#{ message.gsub(/^/, "\1#{ @token } [#{ random_message_id }]") }\n"
         end
 
 
@@ -130,8 +195,17 @@ S5ol3bQmY1mv78XKkOk=
 
       def openConnection
         dbg "LE: Reopening connection to Logentries API server"
-        port = @ssl ? API_SSL_PORT : API_PORT
-        socket = TCPSocket.new(API_SERVER, port)
+  
+
+        if !@datahub_enabled
+          port = @ssl ? API_SSL_PORT: API_PORT
+          socket = TCPSocket.new(API_SERVER, port)      
+        else  
+          port = @datahub_port
+          socket = TCPSocket.new(@datahub_ip, port)
+        end
+
+         
         if @ssl
           ssl_context = OpenSSL::SSL::SSLContext.new()
           ssl_context.cert = OpenSSL::X509::Certificate.new(API_CERT)
@@ -191,7 +265,7 @@ S5ol3bQmY1mv78XKkOk=
           loop do
             begin
               @conn.write(data)
-            rescue TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, EOFError
+            rescue TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEOUT, EOFError
               dbg "LE: Connection timeout(#{ $! }), try to reopen connection"
               reopenConnection
               next

data/test/host_spec.rb

@@ -6,8 +6,13 @@ describe Le::Host do
   let(:local)   { false }
   let(:debug)   { false }
   let(:ssl)     { false }
-  let(:host)    { Le::Host.new(token, local, debug, ssl) }
 
+  let(:datahub_endpoint) { ["", 10000] }
+  let(:host_id) { ""}
+  let(:custom_host)	{ [false, ""]}
+
+  #let(:host)    { Le::Host.new(token, local, debug, ssl) }
+  let(:host)	{ Le::Host.new(token, local, debug, ssl, datahub_endpoint, host_id, custom_host)}
   specify { host.must_be_instance_of Le::Host::HTTP }
 
 end

data/test/http_spec.rb

@@ -7,7 +7,15 @@ describe Le::Host::HTTP do
   let(:local)              { false }
   let(:debug)              { false }
   let(:ssl)                { false }
-  let(:host)               { Le::Host::HTTP.new(token, local, debug, ssl) }
+
+  let(:datahub_endpoint)  { ["", 10000]}
+  let(:host_id)           {""}
+  let(:custom_host)       {[false, ""]}
+  
+
+#  let(:host)               { Le::Host::HTTP.new(token, local, debug, ssl) }
+  let(:host)               { Le::Host::HTTP.new(token, local, debug, ssl, datahub_endpoint, host_id, custom_host) }
+
   let(:logger_console)     { host.instance_variable_get(:@logger_console) }
   let(:logger_console_dev) { logger_console.instance_variable_get(:@logdev).dev }
 
@@ -15,5 +23,7 @@ describe Le::Host::HTTP do
   specify { host.local.must_equal false }
   specify { host.debug.must_equal false }
   specify { host.ssl.must_equal false }
+  specify {host_id.must_equal ""}
+  specify {custom_host.must_equal [false, ""]}  
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: le
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Mark Lacomber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler