Security News
38% of CISOs Fear They’re Not Moving Fast Enough on AI
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
@open-draft/logger
Advanced tools
Environment-agnostic, ESM-friendly logger for simple needs.
I've been using debug
for quite some time but wanted to migrate my projects to better ESM support. Alas, debug
doesn't ship as ESM so I went and wrote this little logger just for my needs. You will likely see it printing useful data in Mock Service Worker and beyond.
npm install @open-draft/logger
This package has the same API for both browser and Node.js and can run in those environments out of the box.
// app.js
import { Logger } from '@open-draft/logger'
const logger = new Logger('parser')
logger.info('starting parsing...')
logger.warning('found legacy document format')
logger.success('parsed 120 documents!')
Logging is disabled by default. To enable logging, provide the DEBUG
environment variable:
DEBUG=1 node ./app.js
You can also use
true
instead of1
. You can also use a specific logger's name to enable logger filtering.
Logger
new Logger(name)
name
string
the name of the logger.Creates a new instance of the logger. Each message printed by the logger will be prefixed with the given name
. You can have multiple loggers with different names for different areas of your system.
const logger = new Logger('parser')
You can nest loggers via
logger.extend()
.
logger.debug(message, ...positionals)
message
string
positionals
unknown[]
Prints a debug message.
logger.debug('no duplicates found, skipping...')
12:34:56:789 [parser] no duplicates found, skipping...
logger.info(message, ...positionals)
message
string
positionals
unknown[]
Prints an info message.
logger.info('new parse request')
12:34:56:789 [parser] new parse request
logger.success(message, ...positionals)
message
string
positionals
unknown[]
Prints a success message.
logger.success('prased 123 documents!')
12:34:56:789 ✔ [parser] prased 123 documents!
logger.warning(message, ...positionals)
message
string
positionals
unknown[]
Prints a warning. In Node.js, prints it to process.stderr
.
logger.warning('found legacy document format')
12:34:56:789 ⚠ [parser] found legacy document format
logger.error(message, ...positionals)
message
string
positionals
unknown[]
Prints an error. In Node.js, prints it to process.stderr
.
logger.error('failed to parse document')
12:34:56:789 ✖ [parser] failed to parse document
logger.extend(prefix)
prefix
string
Additional prefix to append to the logger's name.Creates a new logger out of the current one.
const logger = new Logger('parser')
function parseRequest(request) {
const requestLogger = logger.extend(`${request.method} ${request.url}`)
requestLogger.info('start parsing...')
}
12:34:56:789 [parser] [GET https://example.com] start parsing...
logger.only(callback)
Executes a given callback only when the logging is activated. Useful for computing additional information for logs.
logger.only(() => {
const documentSize = getSizeBytes(document)
logger.debug(`document size: ${documentSize}`)
})
You can nest
logger.*
methods in the callback tologger.only()
.
You can specify the log levels to print using the LOG_LEVEL
environment variable.
There are the following log levels:
debug
info
success
warning
error
Providing no log level will print all the messages.
Here's an example of how to print only warnings:
// app.js
import { Logger } from '@open-draft/logger'
const logger = new Logger('parser')
logger.info('some info')
logger.warning('some warning')
logger.error('some error')
LOG_LEVEL=warning node ./app.js
12:34:56:789 ⚠ [parser] some warning
You can only print a specific logger by providing its name as the DEBUG
environment variable.
// app.js
import { Logger } from '@open-draft/logger'
const appLogger = new Logger('app')
const parserLogger = new Logger('parser')
appLogger.info('starting app...')
parserLogger.info('creating a new parser...')
DEBUG=app node ./app.js
12:34:56:789 [app] starting app...
FAQs
Environment-agnostic, ESM-friendly logger for simple needs.
We found that @open-draft/logger demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.