No special API, Timber works directly with your logger of choice: ```js // console console.log("My log message") console.info("My log message") console.warn("My log message") console.error("My log message") // winston winston.info("My log message") winston.warn("My log message") // ... // bunyan logger.info("My log message") logger.warn("My log message") // ... ``` ---
Log structured data without sacrificing readability: ```js // console console.warn("Payment rejected", { event: { payment_rejected: { customer_id: "abcd1234", amount: 100, reason: "Card expired" } } }); // winston winston.warn("Payment rejected", { event: { payment_rejected: { customer_id: "abcd1234", amount: 100, reason: "Card expired" } } }); // bunyan logger.warn({ event: { payment_rejected: { customer_id: "abcd1234", amount: 100, reason: "Card expired" } } }, "Payment rejected"); ``` ---
[Context](https://timber.io/docs/concepts/metadata-context-and-events) for node is coming soon! Because node does not have a concept of local storage, we're working to implement [continuation local storage](https://github.com/othiym23/node-continuation-local-storage). This will enable shared join data across your logs, allowing you to relate them. Star / watch this repo to be notified when this goes live!
If you're using express, you can use the timber middleware to automatically log all http request/response events ```js const express = require('express') const timber = require('timber') // first we create a writeable stream that your logs will get sent to const transport = new timber.transports.HTTPS('your-timber-api-key'); // attach the stream to stdout timber.install(transport); // create our express app const app = express() // attach the timber middleware app.use(timber.middlewares.express()) app.get('/', function (req, res) { res.send('hello, world!') }) // Output: // => Started GET "/" @metadata {"level": "error", "context": {...}} // => Outgoing HTTP response 200 in 2ms @metadata {"level": "error", "context": {...}} ``` The express middleware accepts a single argument for configuration options. To learn more about the available options, [visit the express integration docs](https://timber.io/docs/languages/node/integrations/express#configuration) ---
If you're using [winston](https://github.com/winstonjs/winston), you can use the winston transport to send all of winston's logs to timber.io ```js const winston = require('winston') const timber = require('timber') const transport = new timber.transports.HTTPS('your-api-key') timber.install(transport) winston.remove(winston.transports.Console) winston.add(winston.transports.Console, { formatter: timber.formatters.Winston }) winston.log('info', 'Sample log message') // Output: // => Sample log message @metadata {"level": "info", ... } ``` When you pass a metadata object to winston, timber will automatically augment your log line with it: ```js winston.log('info', 'Log message with metadata', { user: 'username' }) // Output: // => Log message with metadata @metadata {"level": "info", meta: { user: 'username' }, ... } ``` You can augment your log with a custom event by providing an `event` key at the root of your metadata object: ```js winston.log('info', 'Log message with event', { event: custom_event_name: { ... } }) // Output: // => Log message with event @metadata {"level": "info", event: { custom_event_name: { ... } }, ... } ``` Adding custom context is just as easily done by adding the `context` key to the root of your metadata object: ```js winston.log('info', 'Log message with event', { context: { ... } }) // Output: // => Log message with event @metadata {"level": "info", context: { ... }, ... } ``` If you're using the timber express middleware, you'll most likely want to configure it to use winston as the logger. This can be done by setting the `logger` config attribute to `winston`: ```js timber.config.logger = winston ``` ---
If you're using [bunyan](https://github.com/trentm/node-bunyan), you can use the bunyan transport to send all of bunyan's logs to timber.io ```js const bunyan = require('bunyan') const timber = require('timber') const winston = require('winston') const timber = require('timber') const transport = new timber.transports.HTTPS('your-api-key') timber.install(transport) const log = bunyan.createLogger({ name: 'Timber Logger' }) log.info('Sample log message') // Output: // => Sample log message @metadata {"level": "info", ... } ``` If you want to augment your log with custom metadata, simply add an object as the first argument: ```js log.info({ user: 'username' }, 'Log message with metadata') // Output: // => Log message with metadata @metadata {"level": "info", meta: { user: 'username' }}, ... } ``` You can augment your log with a custom event by providing an `event` key at the root of your metadata object: ```js log.info({ event: { custom_event_name: { ... } } }, 'Log message with event') // Output: // => Log message with event @metadata {"level": "info", event: { custom_event_name: { ... } }, ... } ``` Adding custom context is just as easily done by adding the `context` key to the root of your metadata object: ```js log.info({ context: { ... } }, 'Log message with event') // Output: // => Log message with event @metadata {"level": "info", context: { ... }, ... } ``` If you're using the timber express middleware, you'll most likely want to configure it to use bunyan as the logger. This can be done by setting the `logger` config attribute to the bunyan logger you created: ```js timber.config.logger = log ``` ---
By default, Timber makes attaching to `stdout` and `stderr` very easy through the convenient `timber.install(transport)` function. However, it's possible to attach the transport to _any_ [writeable stream](https://nodejs.org/api/stream.html#stream_writable_streams) using the `timber.attach()` function! ```js const transport = timber.transports.HTTPS('timber-api-key') // This is what the install() command is doing: timber.attach([transport], process.stdout) timber.attach([transport], process.stderr) // => This sends all logs from stdout directly to Timber // You can attach multiple unique transport streams to each stream: const file_transport = fs.createWriteStream("./output.log", {flags: "a"}) timber.attach([transport, file_transport], process.stdout) // => This sends all logs from stdout to Timber, stdout, and a custom log file ``` ---