Security News
Internet Archive Hacked, 31 Million Record Compromised
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
electron-log
Advanced tools
The electron-log package is a logging library specifically designed for Electron applications. It allows you to log messages to various outputs such as the console, files, and remote servers. It is highly configurable and supports different log levels, making it a versatile tool for debugging and monitoring Electron apps.
Console Logging
Logs messages to the console. This is useful for debugging during development.
const log = require('electron-log');
log.info('Hello, console!');
File Logging
Logs messages to a file. This is useful for keeping a persistent log that can be reviewed later.
const log = require('electron-log');
log.transports.file.file = '/path/to/log.txt';
log.info('Hello, file!');
Remote Logging
Logs messages to a remote server. This is useful for centralized logging and monitoring.
const log = require('electron-log');
log.transports.remote.url = 'https://your-log-server.com/log';
log.info('Hello, remote server!');
Custom Transports
Allows you to define custom transports for logging. This is useful for extending the logging functionality to meet specific needs.
const log = require('electron-log');
log.transports.custom = (msg) => {
// Custom transport logic
console.log('Custom transport:', msg);
};
log.info('Hello, custom transport!');
Log Levels
Supports different log levels (error, warn, info, verbose, debug, silly). This is useful for controlling the verbosity of the logs.
const log = require('electron-log');
log.level = 'warn';
log.info('This will not be logged');
log.warn('This will be logged');
Winston is a versatile logging library for Node.js that supports multiple transports, log levels, and formats. It is highly configurable and can be used in a variety of applications, not just Electron.
Bunyan is a simple and fast JSON logging library for Node.js. It is designed for high-performance logging and supports various transports and log levels. It is particularly useful for applications that require structured logging.
Log4js is a logging library inspired by the Java log4j library. It supports multiple appenders (transports), log levels, and configurations. It is a mature and widely-used library in the Node.js ecosystem.
New v5 beta is ready and I would be grateful for any feedbacks.
Simple logging module Electron/Node.js/NW.js application. No dependencies. No complicated configuration.
By default, it writes logs to the following locations:
~/.config/{app name}/logs/main.log
~/Library/Logs/{app name}/main.log
%USERPROFILE%\AppData\Roaming\{app name}\logs\main.log
Currently, electron-log v5 is in a beta phase. It requires Electron 13+ or Node.js 14+. Feel free to use electron-log v4 for older runtime. v4 supports Node.js 0.10+ and almost any Electron build.
Install with npm:
npm install electron-log@beta
import log from 'electron-log';
// Optional, initialize the logger for any renderer processses
log.initialize({ preload: true });
log.info('Log from the main process');
If a bundler is used, you can just import the module:
import log from 'electron-log/renderer';
log.info('Log from the renderer process');
Without a bundler, you can use a global variable __electronLog
. It contains
only log functions like info
, warn
and so on.
There are a few other options how a logger can be initialized for a renderer process. Read more.
If you would like to upgrade to the latest version, read the migration guide and the changelog.
electron-log supports the following log levels:
error, warn, info, verbose, debug, silly
Transport is a simple function which does some work with log message. By default, two transports are active: console and file.
You can set transport options or use methods using:
log.transports.console.format = '{h}:{i}:{s} {text}';
log.transports.file.getFile();
Each transport has level
and
transforms
options.
Just prints a log message to application console (main process) or to DevTools console (renderer process).
'%c{h}:{i}:{s}.{ms}%c › {text}'
(main),
'{h}:{i}:{s}.{ms} › {text}'
(renderer)Read more about console transport.
The file transport writes log messages to a file.
'[{y}-{m}-{d} {h}:{i}:{s}.{ms}] [{level}] {text}'
log.transports.file.resolvePathFn = () => path.join(APP_DATA, 'logs/main.log');
Read more about file transport.
It displays log messages from main process in the renderer's DevTools console.
By default, it's disabled for a production build. You can enable in the
production mode by setting the level
property.
false
in the production.Sends a JSON POST request with LogMessage
in the body to the specified url.
Read more about remote transport.
Just set level property to false, for example:
log.transports.file.level = false;
log.transports.console.level = false;
Transport is just a function (msg: LogMessage) => void
, so you can
easily override/add your own transport.
More info.
Sometimes it's helpful to use electron-log instead of default console
. It's
pretty easy:
console.log = log.log;
If you would like to override other functions like error
, warn
and so on:
Object.assign(console, log.functions);
Colors can be used for both main and DevTools console.
log.info('%cRed text. %cGreen text', 'color: red', 'color: green')
Available colors:
For DevTools console you can use other CSS properties.
electron-log can catch and log unhandled errors/rejected promises:
log.errorHandler.startCatching(options?)
;
In some situations, you may want to get more control over logging. Hook is a function which is called on each transport call.
(message: LogMessage, transport: Transport, transportName) => LogMessage
You can create multiple logger instances with different settings:
import log from 'electron-log';
const anotherLogger = log.create('anotherInstance');
import log from 'electron-log';
const userLog = log.scope('user');
userLog.info('message with user scope');
// Prints 12:12:21.962 (user) › message with user scope
FAQs
Just a simple logging module for your Electron application
The npm package electron-log receives a total of 111,686 weekly downloads. As such, electron-log popularity was classified as popular.
We found that electron-log demonstrated a healthy version release cadence and project activity because the last version was released less than 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
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
Security News
TC39 is meeting in Tokyo this week and they have approved nearly a dozen proposals to advance to the next stages.
Security News
Our threat research team breaks down two malicious npm packages designed to exploit developer trust, steal your data, and destroy data on your machine.