bahmutov / all-logs

Utility method to capture all server console logs including DEBUG=... module logs and util.debuglog

@bahmutov/all-logs

Goal

This module captures:

• console.{log, warn, error} messages
• all messages via debug module
• all messages via util.debuglog

Use

npm install --save @bahmutov/all-logs

Then load this module before your CLI / server code. I suggest just requiring it before your normal module. For example, if normally you start your server like:

{
  "scripts": {
    "start": "node ./lib/server.js"
  }
}

Then you change it to simply be:

{
  "scripts": {
    "start": "node -r @bahmutov/all-logs ./lib/server.js"
  }
}

Note: when debug module is used in dependencies

This module tries to discover debug module in the current module's dependencies, and in all its immediate production dependencies. If it is possible to proxy (older versions of debug module are not compatible), then their logs will be intercepted and you will see debug logs from both your application and its immediate dependencies.

Message format

Each message object has type, namespace and the message text. It also contains a timestamp as ISO string. See src/index.d.ts for the exact interface definition.

Middleware

To expose captured log messages, use the included middleware

• for Express servers use middleware/express.js

if (global.messages) {
  require('@bahmutov/all-logs/middleware/express')(app)
}

• for plain Node http server use middleware/http.js

const http = require('http')
const logs = require('@bahmutov/all-logs/middleware/http')
http.createServer((req, res) => {
  if (logs(req, res) === true) {
    return
  }
  // your normal handler
})

Which adds GET|POST /__messages__ endpoint

See more

• Read "Capture all the logs"
• This module can be used very well with @bahmutov/cy-api command for Cypress end-to-end API testing

Development

Renovate

We are using RenovateBot to keep dependencies up to date. Find the settings in renovate.json file. Note that we ignore module debug since we are testing this module with older versions in subfolders.

Small print

Author: Gleb Bahmutov <[email protected]> © 2019

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2019 Gleb Bahmutov <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

all-logs's Issues

Add console.info support

another namespace

remove debuglog namespace and PID

When we capture util.debuglog message it contains the namespace and PID like this

VERBOSE 999: this is verbose debug = 42

We should skip the namespace and PID

Remove namespace and timing from 'debug' module logs

both the timestamps and "+ms"

need middleware for plain HTTP server

like this one

const http = require('http')
http
  .createServer((req, res) => {

Add TS types

At least global messages

Can we capture util.debugLog

Starting with Node v0.11 (so basically forever) there is https://nodejs.org/api/util.html#util_util_debuglog_section

const util = require('util');
const debuglog = util.debuglog('foo');

debuglog('hello from foo [%d]', 123);

that works via NODE_DEBUG=foo and even supports wildcards

NODE_DEBUG=foo node .
FOO 3245: hello from foo [123]

Can we capture these logs just like we did with debug module logs?

Proxy log messages from debug v2

Currently, we correctly proxy debug v3 and v4, and it would be nice to support debug v2

Why: Express v4 is still on debug@2 https://github.com/expressjs/express/blob/master/package.json

There is difference in logs depending on Node version

For example, Node 8 has lots of util debug logs

while Node 12 has no util debug logs, and the query object has weird text

Organize messages

For each message store:

• source: console, util, debug that corresponds to the console logs, util.debuglog and debug module source
• namespace. This is different per source
  • for source: console it will be "log", "warn", "error"
  • for util and debug it will be the namespace
• message - fully formatted string

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Preset name not found within published preset config (monorepo:babel6). Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• fix(deps): update dependency strip-ansi to v7

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency ramda to v0.29.1
• chore(deps): update cypress/base docker tag to v20
• chore(deps): update dependency husky to v9
• chore(deps): update dependency lint-staged to v15
• chore(deps): update dependency mocha to v10
• chore(deps): update dependency prettier to v3
• chore(deps): update dependency semantic-release to v23
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

circleci

.circleci/config.yml

• cypress/base 12.22.8

npm

package.json

• strip-ansi 5.2.0
• common-tags 1.8.2
• execa-wrap 1.4.0
• husky 3.1.0
• lint-staged 9.5.0
• mocha 6.2.3
• mocha-banner 1.1.2
• prettier 1.19.1
• ramda 0.29.0
• semantic-release 15.14.0
• snap-shot-it 7.9.10
• stop-only 3.3.1

test-debug-v2/package.json

---

• Check this box to trigger a request for Renovate to run again on this repository

add timestamp to each message

So when we view the messages we can show the timings