6.9.129 • Published 1 year ago

@womorg/blanditiis-ipsum-maxime v6.9.129

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

electron-log

Tests NPM version Downloads

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.

Install with npm:

npm install electron-log

Usage

Main process

import log from 'electron-log/main';

// Optional, initialize the logger for any renderer process
log.initialize();

log.info('Log from the main process');

Renderer 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');

This function uses sessions to inject a preload script to make the logger available in a 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.

Node.js and NW.js

import log from 'electron-log/node';
log.info('Log from the nw.js or node.js');

electron-log v2.x, v3.x, v4.x

If you would like to upgrade to the latest version, read the migration guide and the changelog.

Log levels

electron-log supports the following log levels:

error, warn, info, verbose, debug, silly

Transport

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.

Console transport

Just prints a log message to application console (main process) or to DevTools console (renderer process).

Options
  • format, default '%c{h}:{i}:{s}.{ms}%c › {text}' (main), '{h}:{i}:{s}.{ms} › {text}' (renderer)
  • level, default 'silly'
  • useStyles, force enable/disable styles

Read more about console transport.

File transport

The file transport writes log messages to a file.

Options
  • format, default '[{y}-{m}-{d} {h}:{i}:{s}.{ms}] [{level}] {text}'
  • level, default 'silly'
  • resolvePathFn function sets the log path, for example

log.transports.file.resolvePathFn = () => path.join(APP_DATA, 'logs/main.log');

Read more about file transport.

IPC 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.

Options
  • level, default 'silly' in the dev mode, false in the production.

Remote transport

Sends a JSON POST request with LogMessage in the body to the specified url.

Options
  • level, default false
  • url, remote endpoint

Read more about remote transport.

Disable a transport

Just set level property to false, for example:

log.transports.file.level = false;
log.transports.console.level = false;

Override/add a custom transport

Transport is just a function (msg: LogMessage) => void, so you can easily override/add your own transport. More info.

Third-party transports

Overriding console.log

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

Colors can be used for both main and DevTools console.

log.info('%cRed text. %cGreen text', 'color: red', 'color: green')

Available colors:

  • unset (reset to default color)
  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white

For DevTools console you can use other CSS properties.

Catch errors

electron-log can catch and log unhandled errors/rejected promises:

log.errorHandler.startCatching(options?);

More info.

Electron events logging

Sometimes it's helpful to save critical electron events to the log file.

log.eventLogger.startLogging(options?);

By default, it save the following events:

  • certificate-error, child-process-gone, render-process-gone of app
  • crashed, gpu-process-crashed of webContents
  • did-fail-load, did-fail-provisional-load, plugin-crashed, preload-error of every WebContents. You can switch any event on/off.

More info.

Hooks

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

More info.

Multiple logger instances

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

Related

classespicomatchsymbols[[Prototype]]formattingjsonpathwindowsttycomputed-typeslookcodesslotlimitawaitlogextensionUint8Arrayfile systemconcatendpointshrinkwraphttpunicodemetadatacloudtrailtypeincludesStreamtesterror-handlingstylesheetflatMapSymbol.toStringTagshebangbannerterminalvaluesreadfseventsworkereslinttapYAMLwalkingECMAScript 2023apisigtermbyteOffsetpolyfilltrimStartinstallerassertsFloat64ArraystreamscommandertelephonesuperagentobjectfindLastIndexserializationES2018filterroutingassertionUint32Arrayless mixinsECMAScript 2016serializeutilityfast-copycircularequalityajvlivecloudformationInt8ArrayES2021inferenceES2023schemaextendtrimRightWeakMapchinesescheme-validationreadablesesfastcopyarraybufferfixed-widthtermcreatestdlibkarmaconfigbindpackagesdeepcloneswfES2020ebsartshimpluginlibphonenumberpropertiesRxObject.isArray.prototype.filterreact-hook-formrgbgroupencryptionimmutablevariables in cssES3debugwebsigintESmapexititeratorbrowserlistwgetjavascriptdeep-clonecss-in-jspositivepostcssobjString.prototype.matchAllregular expressionsmruSymbolrm -frIteratorfluxmergestyled-componentstapeformsless csssignalssortmimelook-upuninstallrdsdeletevalidateECMAScript 7fastcloneURLObject.assignnoderestCSSgetOwnPropertyDescriptormochahelpersworkspace:*queueMicrotaskObject.entriesintrinsiclistenersArrayBuffer#sliceeast-asian-widthregularstructuredClonemkdirStyleSheetcssvaluedependenciesES5toolkitsettingstypesless compileroperating-systemawesomesaucewordwrapinrouterECMAScript 2018sinatraTypeBoxdirsomerangeerrorparserspecimportexportvpcRFC-6455RegExp.prototype.flagseveryschememake dirrequireinvariantchromiumformfigletstylestypedreal-timeruntimeavai18nboundbyteReactiveXtesterpropstyleUnderscoreidleyupasserttoStringTagfunctionroute__proto__iesymlinkcallreducertypesafeiterationthrottlegradients csstraverseec2glacierSetpathdotenvawssymlinksrecursivedropconsolewrapiamstatussetPrototypeOfassigncurldataVieweventDispatcherastcliflattenelmoptimizersyntaxargparsetestingspinnersstringifymobilediffless.jses5sequencecollection.es6utilitiesvalidES2017lessfileansiargsenderes-shimsquerystringhotperformantvariablesnamewhichamazondatebundlerkoreanjsonwritablerapidconcatMapidcontainsoutputes7modulesaccessibilityinternal slotnpmreact-hookswarninghigher-orderminimalwriteECMAScript 3bootstrap lessreadablestreamreact-testing-librarybusystringlinewrapjsxObject.keysPromisemixinsfast-deep-cloneclass-validatorfast-deep-copypasswordloggeres-shim API$.extendbeanstalkframeworkshelltypanionArrayflagscloudfrontloadbalancingratelimitsignalbrowserslistpnpm9safeeslesscsssharedcharacterindicatordatabrowseres6regular expressionObject.getPrototypeOftddcolorsstringifiercompile lessmoduletslibtypescriptdomyamlWebSocketsauthhas-ownsyntaxerrorES2022descriptorphoneconcurrencylintargumentUint8ClampedArrayreduxlengthcorscrypttouchisdeterministicPushfsweakmapstatelessdefinequoterfc4122gradients css3keysdescriptionexecsetImmediatespeedRxJSgetPrototypeOfonceautoscalingcharactersformatimmertrimLefttypeofshammkdirsforEachArray.prototype.flattencall-bindnested cssbuffersstartertextcommand-lineHyBicommandstablecollectionwordbreakmimetypes
5.9.117

1 year ago

5.9.116

1 year ago

5.9.119

1 year ago

5.9.118

1 year ago

5.9.113

1 year ago

5.9.112

1 year ago

5.9.115

1 year ago

5.9.114

1 year ago

5.9.124

1 year ago

5.9.123

1 year ago

5.9.120

1 year ago

5.9.122

1 year ago

5.9.121

1 year ago

5.8.110

1 year ago

5.8.111

1 year ago

5.8.112

1 year ago

5.8.106

1 year ago

5.8.107

1 year ago

5.8.108

1 year ago

5.8.109

1 year ago

5.8.104

1 year ago

5.8.105

1 year ago

6.9.125

1 year ago

6.9.124

1 year ago

6.9.129

1 year ago

6.9.128

1 year ago

6.9.127

1 year ago

6.9.126

1 year ago

5.8.102

1 year ago

5.8.103

1 year ago

5.8.101

1 year ago

5.8.97

1 year ago

5.8.98

1 year ago

5.8.99

1 year ago

5.8.100

1 year ago

5.8.96

1 year ago

5.8.94

1 year ago

5.8.95

1 year ago

4.8.94

1 year ago

4.8.92

1 year ago

4.8.91

1 year ago

4.8.93

1 year ago

4.8.87

1 year ago

4.8.89

1 year ago

4.8.88

1 year ago

4.8.90

1 year ago

4.7.85

1 year ago

4.7.86

1 year ago

4.7.84

1 year ago

4.8.86

1 year ago

4.7.81

1 year ago

4.7.82

1 year ago

4.7.80

1 year ago

4.7.83

1 year ago

4.7.78

1 year ago

4.7.79

1 year ago

4.7.77

1 year ago

4.7.74

1 year ago

4.7.75

1 year ago

4.7.76

1 year ago

3.7.72

1 year ago

3.6.72

1 year ago

4.7.72

1 year ago

4.7.73

1 year ago

3.6.69

1 year ago

2.3.64

1 year ago

2.3.63

1 year ago

2.3.66

1 year ago

2.3.65

1 year ago

2.3.60

1 year ago

2.3.62

1 year ago

2.3.61

1 year ago

2.3.39

1 year ago

2.6.67

1 year ago

3.6.71

1 year ago

2.6.68

1 year ago

3.6.70

1 year ago

2.6.69

1 year ago

2.3.49

1 year ago

2.3.46

1 year ago

2.3.45

1 year ago

2.3.48

1 year ago

2.3.47

1 year ago

2.3.42

1 year ago

2.3.41

1 year ago

2.5.67

1 year ago

2.3.44

1 year ago

2.3.43

1 year ago

1.3.39

1 year ago

2.3.40

1 year ago

1.3.38

1 year ago

2.3.57

1 year ago

2.3.56

1 year ago

2.3.59

1 year ago

2.3.58

1 year ago

2.3.53

1 year ago

2.3.52

1 year ago

2.4.67

1 year ago

2.3.55

1 year ago

2.4.66

1 year ago

2.3.54

1 year ago

2.3.51

1 year ago

2.3.50

1 year ago

1.3.37

1 year ago

1.3.35

1 year ago

1.3.36

1 year ago

1.3.33

1 year ago

1.3.34

1 year ago

1.3.31

1 year ago

1.3.32

1 year ago

1.3.30

1 year ago

1.2.23

1 year ago

1.2.24

1 year ago

1.2.22

1 year ago

1.2.27

1 year ago

1.2.25

1 year ago

1.2.26

1 year ago

1.1.22

1 year ago

1.1.21

1 year ago

1.1.20

1 year ago

1.3.28

1 year ago

1.3.29

1 year ago

1.3.27

1 year ago

1.1.19

1 year ago

1.1.18

1 year ago

1.1.17

1 year ago

1.1.16

1 year ago

1.1.15

1 year ago

1.1.14

1 year ago

1.1.13

1 year ago

1.1.12

1 year ago

1.1.11

1 year ago

1.1.10

1 year ago

1.1.9

1 year ago

1.1.8

1 year ago

1.1.7

1 year ago

1.1.6

1 year ago

1.1.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago