Simple logging module Electron/Node.js/NW.js application.
No dependencies. No complicated configuration.
By default, it writes logs to the following locations:
on Linux:~/.config/{app name}/logs/main.log
on macOS:~/Library/Logs/{app name}/main.log
on Windows:%USERPROFILE%\AppData\Roaming\{app name}\logs\main.log
Installation
Starts from v5, electron-log 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.
import log from 'electron-log/main';// Initialize the logger to be available in renderer processlog.initialize();log.info('Log from the main process');
Renderer process
If a bundler is used, you can import the module in a renderer code:
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 ways how a logger can be initialized for a renderer
process. Read more.
Preload script
To use the logger inside a preload script, use the
electron-log/renderer import.
There's also the electron-log/preload entrypoint, but it's used only as a
bridge between the main and renderer processes and doesn't export a logger. In
most cases, you don't need this preload entrypoint.
Node.js and NW.js
import log from 'electron-log/node';log.info('Log from the nw.js or node.js');
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.
In the renderer process, this transport does the opposite: it sends the data
to the main process via IPC. Then, the data is written to the console and
the filesystem.
Options
level, default 'silly' in the dev mode, false in the production.
Remote transport (main process only)
Sends a JSON POST request with LogMessage in the body to the specified url.
You can create multiple logger instances with different settings:
import log from 'electron-log/main';const anotherLogger = log.create({ logId: 'anotherInstance' });
Be aware that you need to configure each instance (e.g. log file path)
separately.
Logging scopes
import log from 'electron-log/main';const userLog = log.scope('user');userLog.info('message with user scope');// Prints 12:12:21.962 (user) › message with user scope
By default, scope labels are padded in logs. To disable it, set log.scope.labelPadding = false.
Buffering
It's like a transaction, you may add some logs to the buffer and then decide
whether to write these logs or not. It allows adding verbose logs only
when some operations failed.
import log from 'electron-log/main';log.buffering.begin();try { log.info('First silly message'); // do somethings complex log.info('Second silly message'); // do something else // Finished fine, we don't need these logs anymore log.buffering.reject();} catch (e) { log.buffering.commit(); log.warn(e);}
Related
electron-cfg -
Settings for your Electron application.