sails.log()
Log a message or some data at the "debug" log level using Sails' built-in logger.
sails.log(...);
Usage
This function's usage is purposely very similar to Node's console.log(), but with a handful of extra features—namely support for multiple log levels with colorized, prefixed console output.
Note that standard console.log() conventions from Node.js apply:
- takes an unlimited number of arguments, separated by commas
- printf-style parameterization (à la
util.format()) - objects, dates, arrays, and most other data types are pretty-printed using the built-in logic in
util.inspect()(e.g. you see{ pet: { name: 'Hamlet' } }instead of[object Object].) - if you log an object with a custom
inspect()method, that method will run automatically, and the string that it returns will be written to the console.
Example
var sum = +req.param('x') + +req.param('y');
sails.log();
sails.log('Hey %s, did you know that the sum of %d and %d is %d?', req.param('name'), +req.param('x'), +req.param('y'), sum);
sails.log('Bet you didn\'t know robots could do math, huh?');
sails.log();
sails.log('Anyways, here is a dictionary containing all the parameters I received in this request:', req.allParams());
sails.log('Until next time!');
return res.ok();
Notes
- For a deeper conceptual exploration of logging in Sails, see concepts/logging.
- Remember that, in addition to being exposed as an alternative to calling
console.logdirectly, the built-in logger in Sails is called internally by the framework. The Sails logger can be configured, or completely overridden, using built-in log configuration settings (sails.config.log).- Keep in mind that, like any part of Sails,
sails.logis completely optional. Most—but not all—Sails apps take advantage of the built-in logger: some users prefer to stick withconsole.log(), while othersrequire()more feature-rich libraries like Winston. If you aren't sure what your app needs yet, start with the built-in logger and go from there.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.