expresser

<!DOCTYPE html> <html> <head> <title>logger.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="public/stylesheets/normalize.css" /> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div class="container"> <div class="page"> <div class="header"> <h1>logger.coffee</h1> <div class="toc"> <h3>Table of Contents</h3> <ol> <li> <a class="source" href="index.html"> index.coffee </a> </li> <li> <a class="source" href="app.html"> app.coffee </a> </li> <li> <a class="source" href="cron.html"> cron.coffee </a> </li> <li> <a class="source" href="database.html"> database.coffee </a> </li> <li> <a class="source" href="downloader.html"> downloader.coffee </a> </li> <li> <a class="source" href="events.html"> events.coffee </a> </li> <li> <a class="source" href="firewall.html"> firewall.coffee </a> </li> <li> <a class="source" href="imaging.html"> imaging.coffee </a> </li> <li> <a class="source" href="logger.html"> logger.coffee </a> </li> <li> <a class="source" href="mailer.html"> mailer.coffee </a> </li> <li> <a class="source" href="settings.html"> settings.coffee </a> </li> <li> <a class="source" href="sockets.html"> sockets.coffee </a> </li> <li> <a class="source" href="utils.html"> utils.coffee </a> </li> </ol> </div> </div> <h2 id="expresser-logger">EXPRESSER LOGGER</h2> Handles server logging using local files, Logentries or Loggly. Multiple services can be enabled at the same time.  <div class='highlight'><pre>class Logger events = require "./events.coffee" fs = require "fs" lodash = require "lodash" moment = require "moment" path = require "path" settings = require "./settings.coffee" utils = require "./utils.coffee"</pre></div> Local logging objects will be set on <code>init</code>. <div class='highlight'><pre> bufferDispatcher = null localBuffer = null flushing = false</pre></div> Remote logging providers will be set on <code>init</code>. <div class='highlight'><pre> logentries = null loggly = null loggerLogentries = null loggerLoggly = null</pre></div> The <code>serverIP</code> will be set on init, but only if <code>settings.logger.sendIP</code> is true. <div class='highlight'><pre> serverIP = null</pre></div> Timer used for automatic logs cleaning. <div class='highlight'><pre> timerCleanLocal = null</pre></div> @property [Method] Custom method to call when logs are sent to logging server or flushed to disk. <div class='highlight'><pre> onLogSuccess: null</pre></div> @property [Method] Custom method to call when errors are triggered by the logging transport. <div class='highlight'><pre> onLogError: null</pre></div> @property [Array] Holds a list of current active logging services. @private <div class='highlight'><pre> activeServices = []</pre></div> Holds a copy of emails sent for critical logs. <div class='highlight'><pre> criticalEmailCache: {}</pre></div> <h1 id="constructor-init-and-stop">CONSTRUCTOR, INIT AND STOP</h1> <hr> Logger constructor. <div class='highlight'><pre> constructor: -> @setEvents() if settings.events.enabled</pre></div> Bind event listeners. <div class='highlight'><pre> setEvents: => events.on "logger.debug", @debug events.on "logger.info", @info events.on "logger.warn", @warn events.on "logger.error", @error events.on "logger.critical", @critical</pre></div> Init the Logger module. Verify which services are set, and add the necessary transports. IP address and timestamp will be appended to logs depending on the settings. @param [Object] options Logger init options. <div class='highlight'><pre> init: (options) => bufferDispatcher = null localBuffer = null logentries = null loggly = null serverIP = null activeServices = []</pre></div> Get a valid server IP to be appended to logs. <div class='highlight'><pre> if settings.logger.sendIP serverIP = utils.getServerIP true</pre></div> Define server IP. <div class='highlight'><pre> if serverIP? ipInfo = "IP #{serverIP}" else ipInfo = "No server IP set."</pre></div> Init transports. <div class='highlight'><pre> @initLocal() @initLogentries() @initLoggly()</pre></div> Check if uncaught exceptions should be logged. If so, try logging unhandled exceptions using the logger, otherwise log to the console. <div class='highlight'><pre> if settings.logger.uncaughtException @debug "Logger.init", "Catching unhandled exceptions." process.on "uncaughtException", (err) => try @error "Unhandled exception!", err catch ex console.error "Unhandled exception!", err</pre></div> Start logging! <div class='highlight'><pre> if not localBuffer? and not logentries? and not loggly? @warn "Logger.init", "No transports enabled.", "Logger module will only log to the console!" else @info "Logger.init", activeServices.join(), ipInfo</pre></div> Init the Local transport. Check if logs should be saved locally. If so, create the logs buffer and a timer to flush logs to disk every X milliseconds. <div class='highlight'><pre> initLocal: => if settings.logger.local.enabled if fs.existsSync? folderExists = fs.existsSync settings.path.logsDir else folderExists = path.existsSync settings.path.logsDir</pre></div> Create logs folder, if it doesn’t exist. <div class='highlight'><pre> if not folderExists fs.mkdirSync settings.path.logsDir if settings.general.debug console.log "Logger.initLocal", "Created #{settings.path.logsDir} folder."</pre></div> Set local buffer. <div class='highlight'><pre> localBuffer = {info: [], warn: [], error: []} bufferDispatcher = setInterval @flushLocal, settings.logger.local.bufferInterval activeServices.push "Local"</pre></div> Check the maxAge of local logs. <div class='highlight'><pre> if settings.logger.local.maxAge? and settings.logger.local.maxAge > 0 if timerCleanLocal? clearInterval timerCleanLocal timerCleanLocal = setInterval @cleanLocal, 86400 else @stopLocal()</pre></div> Init the Logentries transport. Check if Logentries should be used, and create the Logentries objects. <div class='highlight'><pre> initLogentries: => if settings.logger.logentries.enabled and settings.logger.logentries.token? and settings.logger.logentries.token isnt "" logentries = require "node-logentries" loggerLogentries = logentries.logger {token: settings.logger.logentries.token, timestamp: settings.logger.sendTimestamp} loggerLogentries.on("log", @onLogSuccess) if lodash.isFunction @onLogSuccess loggerLogentries.on("error", @onLogError) if lodash.isFunction @onLogError activeServices.push "Logentries" else @stopLogentries()</pre></div> Init the Loggly transport. Check if Loggly should be used, and create the Loggly objects. <div class='highlight'><pre> initLoggly: => if settings.logger.loggly.enabled and settings.logger.loggly.subdomain? and settings.logger.loggly.token? and settings.logger.loggly.token isnt "" loggly = require "loggly" loggerLoggly = loggly.createClient {token: settings.logger.loggly.token, subdomain: settings.logger.loggly.subdomain, json: false} activeServices.push "Loggly" else @stopLoggly()</pre></div> Disable and remove Local transport from the list of active services. <div class='highlight'><pre> stopLocal: => @flushLocal() clearInterval bufferDispatcher if bufferDispatcher? bufferDispatcher = null localBuffer = null i = activeServices.indexOf "Local" activeServices.splice(i, 1) if i >= 0</pre></div> Disable and remove Logentries transport from the list of active services. <div class='highlight'><pre> stopLogentries: => logentries = null loggerLogentries = null i = activeServices.indexOf "Logentries" activeServices.splice(i, 1) if i >= 0</pre></div> Disable and remove Loggly transport from the list of active services. <div class='highlight'><pre> stopLoggly: => loggly = null loggerLoggly = null i = activeServices.indexOf "Loggly" activeServices.splice(i, 1) if i >= 0</pre></div> <h2 id="log-methods">LOG METHODS</h2> Generic log method. @param [String] logType The log type (for example: warning, error, info, security, etc). @param [String] logFunc Optional, the logging function name to be passed to the console and Logentries. @param [Array] args Array of arguments to be stringified and logged. <div class='highlight'><pre> log: (logType, logFunc, args) => if not args? and logFunc? args = logFunc logFunc = "info"</pre></div> Get message out of the arguments. <div class='highlight'><pre> msg = @getMessage args</pre></div> Log to different transports. <div class='highlight'><pre> if settings.logger.local.enabled and localBuffer? @logLocal logType, msg if settings.logger.logentries.enabled and loggerLogentries? loggerLogentries.log logFunc, msg if settings.logger.loggly.enabled and loggerLoggly? loggerLoggly.log msg, @logglyCallback</pre></div> Log to the console depending on <code>console</code> setting. <div class='highlight'><pre> if settings.logger.console args.unshift moment().format "HH:mm:ss.SS" if settings.logger.errorLogTypes.indexOf(logType) >= 0 console.error.apply this, args else console.log.apply this, args</pre></div> Log to the active transports as <code>debug</code>, only if the debug flag is enabled. All arguments are transformed to readable strings. <div class='highlight'><pre> debug: => return if not settings.general.debug args = Array.prototype.slice.call arguments args.unshift "DEBUG" @log "debug", "info", args</pre></div> Log to the active transports as <code>log</code>. All arguments are transformed to readable strings. <div class='highlight'><pre> info: => args = Array.prototype.slice.call arguments args.unshift "INFO" @log "info", "info", args</pre></div> Log to the active transports as <code>warn</code>. All arguments are transformed to readable strings. <div class='highlight'><pre> warn: => args = Array.prototype.slice.call arguments args.unshift "WARN" @log "warn", "warning", args</pre></div> Log to the active transports as <code>error</code>. All arguments are transformed to readable strings. <div class='highlight'><pre> error: => args = Array.prototype.slice.call arguments args.unshift "ERROR" @log "error", "err", args</pre></div> Log to the active transports as <code>critical</code>. All arguments are transformed to readable strings. <div class='highlight'><pre> critical: => args = Array.prototype.slice.call arguments args.unshift "CRITICAL" @log "critical", "err", args</pre></div> If the <code>criticalEmailTo</code> is set, dispatch a mail send event. <div class='highlight'><pre> if settings.logger.criticalEmailTo? and settings.logger.criticalEmailTo isnt "" body = args.join ", " maxAge = moment().subtract("m", settings.logger.criticalEmailExpireMinutes).unix()</pre></div> Do not proceed if this critical email was sent recently. <div class='highlight'><pre> return if @criticalEmailCache[body]? and @criticalEmailCache[body] > maxAge</pre></div> Set mail options. <div class='highlight'><pre> mailOptions = subject: "CRITICAL: #{args[1]}" body: body to: settings.logger.criticalEmailTo logError: false</pre></div> Emit mail send message. <div class='highlight'><pre> events.emit "mailer.send", mailOptions, (err) -> console.error "Logger.critical", "Can't send email!", err if err?</pre></div> Save to critical email cache. <div class='highlight'><pre> @criticalEmailCache[body] = moment().unix()</pre></div> <h2 id="local-logging">LOCAL LOGGING</h2> Log locally. The path is defined on <code>Settings.Path.logsDir</code>. @param [String] logType The log type (info, warn, error, debug, etc). @param [String] message Message to be logged. @private <div class='highlight'><pre> logLocal: (logType, message) -> now = moment() message = now.format("HH:mm:ss.SSS") + " - " + message localBuffer[logType] = [] if not localBuffer[logType]? localBuffer[logType].push message</pre></div> Flush all local buffered log messages to disk. This is usually called by the <code>bufferDispatcher</code> timer. <div class='highlight'><pre> flushLocal: -> return if flushing</pre></div> Set flushing and current date. <div class='highlight'><pre> flushing = true now = moment() date = now.format "YYYYMMDD"</pre></div> Flush all buffered logs to disk. Please note that messages from the last seconds of the previous day can be saved to the current day depending on how long it takes for the bufferDispatcher to run. Default is every 10 seconds, so messages from 23:59:50 onwards could be saved on the next day. <div class='highlight'><pre> for key, logs of localBuffer if logs.length > 0 writeData = logs.join("\n") filePath = path.join settings.path.logsDir, "#{date}.#{key}.log" successMsg = "#{logs.length} records logged to disk."</pre></div> Reset this local buffer. <div class='highlight'><pre> localBuffer[key] = []</pre></div> Only use <code>appendFile</code> on new versions of Node. <div class='highlight'><pre> if fs.appendFile? fs.appendFile filePath, writeData, (err) => flushing = false if err? console.error "Logger.flushLocal", err @onLogError err if @onLogError? else @onLogSuccess successMsg if @onLogSuccess? else fs.open filePath, "a", 666, (err1, fd) => if err1? flushing = false console.error "Logger.flushLocal.open", err1 @onLogError err1 if @onLogError? else fs.write fd, writeData, null, settings.general.encoding, (err2) => flushing = false if err2? console.error "Logger.flushLocal.write", err2 @onLogError err2 if @onLogError? else @onLogSuccess successMsg if @onLogSuccess? fs.closeSync fd</pre></div> Delete old log files from disk. The maximum date is defined on the settings. <div class='highlight'><pre> cleanLocal: -> maxDate = moment().subtract "d", settings.logger.local.maxAge fs.readdir settings.path.logsDir, (err, files) -> if err? console.error "Logger.cleanLocal", err else for f in files date = moment f.split(".")[1], "yyyyMMdd" if date.isBefore maxDate fs.unlink path.join(settings.path.logsDir, f), (err) -> console.error "Logger.cleanLocal", err if err?</pre></div> <h2 id="helper-methods">HELPER METHODS</h2> Returns a human readable message out of the arguments. @return [String] The human readable, parsed JSON message. @private <div class='highlight'><pre> getMessage: -> separated = [] args = arguments args = args[0] if args.length is 1</pre></div> Parse all arguments and stringify objects. Please note that fields defined on the <code>Settings.logger.removeFields</code> won’t be added to the message. <div class='highlight'><pre> for a in args if settings.logger.removeFields.indexOf(a) < 0 if lodash.isArray a for b in a separated.push b if settings.logger.removeFields.indexOf(b) < 0 else if lodash.isObject a try separated.push JSON.stringify a catch ex separated.push a else separated.push a</pre></div> Append IP address, if <code>serverIP</code> is set. <div class='highlight'><pre> separated.push "IP #{serverIP}" if serverIP?</pre></div> Return single string log message. <div class='highlight'><pre> return separated.join " | "</pre></div> Wrapper callback for <code>onLogSuccess</code> and <code>onLogError</code> to be used by Loggly. @param [String] err The Loggly error. @param [String] result The Loggly logging result. @private <div class='highlight'><pre> logglyCallback: (err, result) => if err? and @onLogError? @onLogError err else if @onLogSuccess? @onLogSuccess result</pre></div> <h2 id="singleton-implementation">Singleton implementation</h2> <div class='highlight'><pre>Logger.getInstance = -> @instance = new Logger() if not @instance? return @instance module.exports = exports = Logger.getInstance()</pre></div> <div class="fleur">h</div> </div> </div> </body> </html>