Class: Le::Host::HTTP

Inherits:
Object
  • Object
show all
Includes:
InstanceMethods
Defined in:
lib/le/host/http.rb

Constant Summary collapse

LIBRARY_IDENTIFIER = 
'###R01### - Library initialised'
API_SERVER = 
'api.logentries.com'
API_PORT = 
10000
API_SSL_PORT = 
20000
API_CERT = 
'-----BEGIN CERTIFICATE-----
MIIFSjCCBDKgAwIBAgIDCQpNMA0GCSqGSIb3DQEBBQUAMGExCzAJBgNVBAYTAlVT
MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMR0wGwYDVQQLExREb21haW4gVmFsaWRh
dGVkIFNTTDEbMBkGA1UEAxMSR2VvVHJ1c3QgRFYgU1NMIENBMB4XDTE0MDQxNTEz
NTcxNVoXDTE2MDkxMzA0MTMzMFowgcExKTAnBgNVBAUTIEhpL1RHbXlmUEpJYTFy
b0NQdlJ1U1NNRVdLOFp0NUtmMRMwEQYDVQQLEwpHVDAzOTM4NjcwMTEwLwYDVQQL
EyhTZWUgd3d3Lmdlb3RydXN0LmNvbS9yZXNvdXJjZXMvY3BzIChjKTEyMS8wLQYD
VQQLEyZEb21haW4gQ29udHJvbCBWYWxpZGF0ZWQgLSBRdWlja1NTTChSKTEbMBkG
A1UEAxMSYXBpLmxvZ2VudHJpZXMuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKCAQEAwGsgjVb/pn7Go1jqNQVFsN+VEMRFpu7bJ5i+Lv/gY9zXBDGULr3d
j9/hB/pa49nLUpy9GsaFru2AjNoveoVoe5ng2QhZRlUn77hxkoZsaiD+rrH/D/Yp
LP3b/pNQg+nNTC81uwbhlxjIoeMSaPGjr1SFjZ1StCprZKFRu3IV+2/wZ+STUz/L
aA3r6J86DRptasbzYMkDyWlUzN3nhYUcPUNrd4jSk+soSDEuDpHMahgRdQBo6Dht
EKCSY+vB5ZIgEydI7mra8ygRjXotvc0zeb8Jvo8ZhyLDwvxjgo9F6Li3h/tfAjRR
4ngV7yg9o8MgXN852GMHpUxzqhygLeyqSQIDAQABo4IBqDCCAaQwHwYDVR0jBBgw
FoAUjPTZkwpHvACgSs5LdW6gtrCyfvwwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQW
MBQGCCsGAQUFBwMBBggrBgEFBQcDAjAdBgNVHREEFjAUghJhcGkubG9nZW50cmll
cy5jb20wQQYDVR0fBDowODA2oDSgMoYwaHR0cDovL2d0c3NsZHYtY3JsLmdlb3Ry
dXN0LmNvbS9jcmxzL2d0c3NsZHYuY3JsMB0GA1UdDgQWBBRowYR/aaGeiRRQxbaV
1PI8hS4m9jAMBgNVHRMBAf8EAjAAMHUGCCsGAQUFBwEBBGkwZzAsBggrBgEFBQcw
AYYgaHR0cDovL2d0c3NsZHYtb2NzcC5nZW90cnVzdC5jb20wNwYIKwYBBQUHMAKG
K2h0dHA6Ly9ndHNzbGR2LWFpYS5nZW90cnVzdC5jb20vZ3Rzc2xkdi5jcnQwTAYD
VR0gBEUwQzBBBgpghkgBhvhFAQc2MDMwMQYIKwYBBQUHAgEWJWh0dHA6Ly93d3cu
Z2VvdHJ1c3QuY29tL3Jlc291cmNlcy9jcHMwDQYJKoZIhvcNAQEFBQADggEBAAzx
g9JKztRmpItki8XQoGHEbopDIDMmn4Q7s9k7L9nT5gn5XCXdIHnsSe8+/2N7tW4E
iHEEWC5G6Q16FdXBwKjW2LrBKaP7FCRcqXJSI+cfiuk0uywkGBTXpqBVClQRzypd
9vZONyFFlLGUwUC1DFVxe7T77Dv+pOPuJ7qSfcVUnVtzpLMMWJsDG6NHpy0JhsS9
wVYQgpYWRRZ7bJyfRCJxzIdYF3qy/P9NWyZSlDUuv11s1GSFO2pNd34p59GacVAL
BJE6y5eOPTSbtkmBW/ukaVYdI5NLXNer3IaK3fetV3LvYGOaX8hR45FI1pvyKYvf
S5ol3bQmY1mv78XKkOk=
-----END CERTIFICATE-----'
SHUTDOWN_COMMAND =

magic command string for async worker to shutdown

"DIE!DIE!"
SHUTDOWN_MAX_WAIT =

max seconds to wait for queue to clear on shutdown

10
SHUTDOWN_WAIT_STEP =

sleep duration (seconds) while waiting to shutdown

0.2

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from InstanceMethods

#format_message, #formatter

Constructor Details

#initialize(token, local, debug, ssl) ⇒ HTTP

Returns a new instance of HTTP.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/le/host/http.rb', line 52

def initialize(token, local, debug, ssl)
  if local
    device = if local.class <= TrueClass
      if defined?(Rails)
        Rails.root.join("log","#{Rails.env}.log")
      else
        STDOUT
      end
    else
      local
    end
    @logger_console = Logger.new(device)
  end
  @token = token
  @local = !!local
  @debug = debug
  @ssl = ssl
  @queue = Queue.new
	# Add identifer msg to queue to be sent first
  @queue << "#{@token}#{LIBRARY_IDENTIFIER}\n"
  @started = false
  @thread = nil

  if @debug
    self.init_debug
  end
  at_exit { shutdown! }
end

Instance Attribute Details

#conn ⇒ Object

Returns the value of attribute conn.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def conn
  @conn
end

#debug ⇒ Object

Returns the value of attribute debug.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def debug
  @debug
end

#local ⇒ Object

Returns the value of attribute local.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def local
  @local
end

#queue ⇒ Object

Returns the value of attribute queue.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def queue
  @queue
end

#ssl ⇒ Object

Returns the value of attribute ssl.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def ssl
  @ssl
end

#started ⇒ Object

Returns the value of attribute started.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def started
  @started
end

#thread ⇒ Object

Returns the value of attribute thread.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def thread
  @thread
end

#token ⇒ Object

Returns the value of attribute token.



50
51
52
 
# File 'lib/le/host/http.rb', line 50

def token
  @token
end

Instance Method Details

#check_async_thread ⇒ Object 



120
121
122
123
124
 
# File 'lib/le/host/http.rb', line 120

def check_async_thread
  if not(@thread && @thread.alive?)
    @thread = Thread.new { run() }
  end
end

#close ⇒ Object 



126
127
128
129
 
# File 'lib/le/host/http.rb', line 126

def close
  dbg "LE: Closing asynchronous socket writer"
  @started = false
end

#closeConnection ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/le/host/http.rb', line 171

def closeConnection
  begin
    if @conn.respond_to?(:sysclose)
      @conn.sysclose
    elsif @conn.respond_to?(:close)
      @conn.close
    end
  rescue
    dbg "LE: couldn't close connection, close with exception - #{ $! }"
  ensure
    @conn = nil
  end
end

#dbg(message) ⇒ Object 



89
90
91
92
93
 
# File 'lib/le/host/http.rb', line 89

def dbg(message)
  if @debug
    @debug_logger.add(Logger::Severity::DEBUG, message)
  end
end

#init_debug ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/le/host/http.rb', line 81

def init_debug
  filePath = "logentriesGem.log"
  if File.exist?('log/')
    filePath = "log/logentriesGem.log"
  end
  @debug_logger = Logger.new(filePath)
end

#openConnection ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/le/host/http.rb', line 131

def openConnection
  dbg "LE: Reopening connection to Logentries API server"
  port = @ssl ? API_SSL_PORT : API_PORT
  socket = TCPSocket.new(API_SERVER, port)
  if @ssl
    ssl_context = OpenSSL::SSL::SSLContext.new()
    ssl_context.cert = OpenSSL::X509::Certificate.new(API_CERT)
    ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
    ssl_socket.sync_close = true
    ssl_socket.connect
    @conn = ssl_socket
  else
    @conn = socket
  end
  dbg "LE: Connection established"
end

#reopenConnection ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/le/host/http.rb', line 148

def reopenConnection
  closeConnection
  root_delay = 0.1
  loop do
    begin
      openConnection
      break
    rescue TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, EOFError
      dbg "LE: Unable to connect to Logentries due to timeout(#{ $! })"
    rescue
      dbg "LE: Got exception in reopenConnection - #{ $! }"
      raise
    end
    root_delay *= 2
    if root_delay >= 10
      root_delay = 10
    end
    wait_for = (root_delay + rand(root_delay)).to_i
    dbg "LE: Waiting for #{ wait_for }ms"
    sleep(wait_for)
  end
end

#run ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/le/host/http.rb', line 185

def run
  reopenConnection

  loop do
    data = @queue.pop
    break if data == SHUTDOWN_COMMAND
    loop do
      begin
        @conn.write(data)
      rescue TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEOUT, EOFError
        dbg "LE: Connection timeout(#{ $! }), try to reopen connection"
        reopenConnection
        next
      rescue
        dbg("LE: Got exception in run loop - #{ $! }")
        raise
      end

      break
    end
  end

  dbg "LE: Closing Asyncrhonous socket writer"

  closeConnection
end

#start_async_thread ⇒ Object 



114
115
116
117
118
 
# File 'lib/le/host/http.rb', line 114

def start_async_thread
  @thread = Thread.new { run() }
  dbg "LE: Asynchronous socket writer started"
  @started = true
end

#write(message) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/le/host/http.rb', line 95

def write(message)
  if @local
    @logger_console.add(Logger::Severity::UNKNOWN, message)
  end

  if message.scan(/\n/).empty?
    @queue << "#{ @token } #{ message }\n"
  else
    @queue << "#{ message.gsub(/^/, "\1#{ @token } [#{ random_message_id }] ") }\n"
  end


  if @started
    check_async_thread
  else
    start_async_thread
  end
end