Fix typos and correct grammar errors

Author: calio

lib/resty/logger/socket.lua

@@ -1,4 +1,4 @@
--- Copyright (C) 2013-2014 Jiale Zhi (calio), Cloudflare Inc.
+-- Copyright (C) 2013-2014 Jiale Zhi (calio), CloudFlare Inc.
 --require "luacov"
 
 local concat                = table.concat
@@ -32,10 +32,10 @@ if not ngx.config or not ngx.config.ngx_lua_version
 
     is_exiting = function() return false end
 
-    ngx_log(CRIT, "lua-resty-logger-socket working with ngx_lua module < 0.9.3"
-            .. " has a serious issue that some log messages may be lost when"
-            .. " nginx reloads. We strongly recommend you update your ngx_lua"
-            .. " module to at least 0.9.3")
+    ngx_log(CRIT, "We strongly recommend you to update your ngx_lua module to "
+            .. "0.9.3 or above. lua-resty-logger-socket will lose some log "
+            .. "messages when Nginx reloads if it works with ngx_lua module "
+            .. "below 0.9.3")
 else
     is_exiting = ngx.worker.exiting
 end
@@ -59,7 +59,7 @@ local buffer_size           = 0
 local send_buffer           = ""
 -- 1st level buffer, it stores incoming logs
 local log_buffer_data       = new_tab(20000, 0)
--- number of log lines in current buffer, starts from 0
+-- number of log lines in current 1st level buffer, starts from 0
 local log_buffer_index      = 0
 
 local last_error
@@ -95,7 +95,7 @@ local function _do_connect()
         sock:settimeout(timeout)
     end
 
-    -- host/port and path config have already been checked in init()
+    -- "host"/"port" and "path" have already been checked in init()
     if host and port then
         ok, err =  sock:connect(host, port)
     elseif path then
@@ -114,9 +114,9 @@ local function _connect()
 
     if connecting then
         if debug then
-            ngx_log(DEBUG, "previous connect not finished")
+            ngx_log(DEBUG, "previous connection not finished")
         end
-        return nil, "previous connect not finished"
+        return nil, "previous connection not finished"
     end
 
     connected = false
@@ -133,10 +133,10 @@ local function _connect()
         end
 
         if debug then
-            ngx_log(DEBUG, "retry to connect to the log server: ", err)
+            ngx_log(DEBUG, "reconnect to the log server: ", err)
         end
 
-        -- ngx.sleep use seconds to count time
+        -- ngx.sleep time is in seconds
         if not exiting then
             ngx_sleep(retry_interval / 1000)
         end
@@ -163,8 +163,8 @@ local function _prepare_stream_buffer()
         log_buffer_data = new_tab(20000, 0)
         counter = 0
         if debug then
-            ngx_log(DEBUG, "log buffer max reuse(" .. max_buffer_reuse
-                    .. ") reached, create new log_buffer_data")
+            ngx_log(DEBUG, "log buffer reuse limit (" .. max_buffer_reuse
+                    .. ") reached, create a new \"log_buffer_data\"")
         end
     end
 end
@@ -178,7 +178,7 @@ local function _do_flush()
 
     local bytes, err = sock:send(packet)
     if not bytes then
-        -- sock:send always close current connection on error
+        -- "sock:send" always closes current connection on error
         return nil, err
     end
 
@@ -206,7 +206,7 @@ end
 local function _flush_lock()
     if not flushing then
         if debug then
-            ngx_log(DEBUG, "flush lock accquired")
+            ngx_log(DEBUG, "flush lock acquired")
         end
         flushing = true
         return true
@@ -235,7 +235,7 @@ local function _flush()
 
     if not _need_flush() then
         if debug then
-            ngx_log(DEBUG, "do not need to flush:", log_buffer_index)
+            ngx_log(DEBUG, "no need to flush:", log_buffer_index)
         end
         _flush_unlock()
         return true
@@ -260,10 +260,10 @@ local function _flush()
         end
 
         if debug then
-            ngx_log(DEBUG, "retry to send log message to the log server: ", err)
+            ngx_log(DEBUG, "resend log messages to the log server: ", err)
         end
 
-        -- ngx.sleep use seconds to count time
+        -- ngx.sleep time is in seconds
         if not exiting then
             ngx_sleep(retry_interval / 1000)
         end
@@ -274,7 +274,7 @@ local function _flush()
     _flush_unlock()
 
     if not bytes then
-        local err_msg = "try to send log message to the log server "
+        local err_msg = "try to send log messages to the log server "
                         .. "failed after " .. max_retry_times .. " retries: "
                         .. err
         _write_error(err_msg)
@@ -326,7 +326,7 @@ function _M.init(user_config)
         elseif k == "max_retry_times" then
             max_retry_times = v
         elseif k == "retry_interval" then
-            -- ngx.sleep uses seconds to count sleep time
+            -- ngx.sleep time is in seconds
             retry_interval = v
         elseif k == "pool_size" then
             pool_size = v
@@ -336,12 +336,13 @@ function _M.init(user_config)
     end
 
     if not (host and port) and not path then
-        return nil, "no logging server configured. Need host/port or path."
+        return nil, "no logging server configured. \"host\"/\"port\" or "
+                .. "\"path\" is required."
     end
 
 
     if (flush_limit >= drop_limit) then
-        return nil, "flush_limit should < drop_limit"
+        return nil, "\"flush_limit\" should be < \"drop_limit\""
     end
 
     flushing = false
@@ -375,14 +376,14 @@ function _M.log(msg)
 
     local msg_len = #msg
 
-    -- return result of _flush_buffer is not checked, because it writes
+    -- response of "_flush_buffer" is not checked, because it writes
     -- error buffer
     if (is_exiting()) then
         exiting = true
         _write_buffer(msg)
         _flush_buffer()
         if (debug) then
-            ngx_log(DEBUG, "worker exiting")
+            ngx_log(DEBUG, "Nginx worker is exiting")
         end
         bytes = 0
     elseif (msg_len + buffer_size < flush_limit) then
@@ -395,10 +396,11 @@ function _M.log(msg)
     else
         _flush_buffer()
         if (debug) then
-            ngx_log(DEBUG, "logger buffer is full, this log would be dropped")
+            ngx_log(DEBUG, "logger buffer is full, this log message will be "
+                    .. "dropped")
         end
         bytes = 0
-        --- this message does not fit in buffer, drop it
+        --- this log message doesn't fit in buffer, drop it
     end
 
     if last_error then

t/bug.t

@@ -89,19 +89,19 @@ GET /t?a=1&b=2
 --- tcp_reply:
 --- tcp_no_close
 --- grep_error_log chop
-retry to send log message to the log server: timeout
+resend log messages to the log server: timeout
 --- response_body
 foo
 foo
 foo
 --- grep_error_log_out
-retry to send log message to the log server: timeout
-retry to send log message to the log server: timeout
-retry to send log message to the log server: timeout
+resend log messages to the log server: timeout
+resend log messages to the log server: timeout
+resend log messages to the log server: timeout
 
 
 
-=== TEST 2: insert new log message to buffer in the middle of last send (it's difficult to control the time sequence here, so this is skipped now)
+=== TEST 2: insert new log messages to buffer in the middle of last send (it's difficult to control the time sequence here, so this is skipped now)
 --- http_config eval: $::HttpConfig
 --- config
     log_subrequest on;

t/sanity.t

@@ -147,7 +147,7 @@ foo
 
 
 
-=== TEST 4: buffer log message, no flush
+=== TEST 4: buffer log messages, no flush
 --- http_config eval: $::HttpConfig
 --- config
     location /t {
@@ -208,7 +208,7 @@ foo
 
 
 
-=== TEST 6: log subrequest
+=== TEST 6: log subrequests
 --- http_config eval: $::HttpConfig
 --- config
     log_subrequest on;
@@ -262,7 +262,7 @@ foo
 
 
 
-=== TEST 7: log subrequest, small flush_limit, flush twice
+=== TEST 7: log subrequests, small flush_limit, flush twice
 --- http_config eval: $::HttpConfig
 --- config
     log_subrequest on;
@@ -314,7 +314,7 @@ foo
 
 
 
-=== TEST 8: do not log subrequest
+=== TEST 8: do not log subrequests
 --- http_config eval: $::HttpConfig
 --- config
     location /t {
@@ -426,7 +426,7 @@ foo
 --- request
 GET /t?a=1&b=2
 --- error_log
-no logging server configured. Need host/port or path.
+no logging server configured. "host"/"port" or "path" is required.
 --- response_body
 foo
 
@@ -462,7 +462,7 @@ foo
 --- request
 GET /t?a=1&b=2
 --- error_log
-flush_limit should < drop_limit
+"flush_limit" should be < "drop_limit"
 --- response_body
 foo
 
@@ -509,7 +509,7 @@ GET /t?a=1&b=2
 --- tcp_query_len: 6
 --- tcp_reply:
 --- error_log
-logger buffer is full, this log would be dropped
+logger buffer is full, this log message will be dropped
 --- response_body
 foo
 
@@ -642,7 +642,7 @@ GET /t?a=1&b=2
 --- tcp_listen: 29999
 --- tcp_reply:
 --- error_log
-log buffer max reuse(1) reached, create new log_buffer_data
+log buffer reuse limit (1) reached, create a new "log_buffer_data"
 --- tcp_query: 111222333444555
 --- tcp_query_len: 15
 --- response_body

t/timeout.t

@@ -89,7 +89,7 @@ GET /t?a=1&b=2
 --- wait: 0.1
 --- error_log
 tcp socket connect timed out
-try to connect to the log server
+reconnect to the log server
 --- response_body
 foo
 
@@ -125,7 +125,7 @@ GET /t?a=1&b=2
 --- tcp_reply:
 --- error_log
 lua tcp socket write timed out
-retry to send log message to the log server: timeout
+resend log messages to the log server: timeout
 --- response_body
 foo
 
@@ -225,8 +225,8 @@ GET /main
 --- wait: 0.2
 --- error_log
 lua tcp socket connect timed out
-retry to connect to the log server: timeout
-log error:try to send log message to the log server failed after 1 retries: try to connect to the log server failed after 1 retries: timeout
+reconnect to the log server: timeout
+log error:try to send log messages to the log server failed after 1 retries: try to connect to the log server failed after 1 retries: timeout
 --- response_body
 foo
 bar