Comparing version 1.0.3 to 1.0.4
{ | ||
"name": "nodereport", | ||
"main": "nodereport.node", | ||
"version": "1.0.3", | ||
"main": "build/Release/nodereport.node", | ||
"version": "1.0.4", | ||
"description": "Diagnostic NodeReport", | ||
"homepage": "https://github.com/nodejs/nodereport#readme", | ||
"homepage": "https://github.com/nodejs/nodereport", | ||
"repository": { | ||
@@ -17,10 +17,6 @@ "type": "git", | ||
}, | ||
"author": "Richard Chamberlain", | ||
"license": "MIT", | ||
"scripts": { | ||
"test": "node test/autorun.js" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/nodejs/nodereport/issues" | ||
} | ||
} |
@@ -10,45 +10,36 @@ # nodereport | ||
reports can be triggered on unhandled exceptions, fatal errors, signals | ||
and calls to a Javascript API. The module supports Node.js v4 and v6 on | ||
Linux, MacOS and Windows. | ||
and calls to a Javascript API. | ||
Usage: | ||
npm install nodereport | ||
npm install nodejs/nodereport | ||
var nodereport = require('nodereport'); | ||
By default, this will allow a NodeReport to be triggered via an API | ||
call from a JavaScript application. | ||
call from a JavaScript application. The filename of the NodeReport is | ||
returned. The default filename includes the date, time, PID and a | ||
sequence number. Alternatively a filename can be specified on the API call. | ||
var nodereport = require('nodereport'); | ||
nodereport.triggerReport(); | ||
Content of the NodeReport consists of a header section containing the event | ||
type, date, time, PID and Node version, sections containing Javascript and | ||
native stack traces, a section containing V8 heap information, a section | ||
containing libuv handle information and an OS platform information section | ||
showing CPU and memory usage and system limits. An example NodeReport can be | ||
triggered using the Node.js REPL: | ||
var filename = nodereport.triggerReport(); | ||
C:\test>node | ||
> nodereport = require('nodereport') | ||
> nodereport.triggerReport() | ||
Writing Node.js report to file: NodeReport.20161020.091102.8480.001.txt | ||
Node.js report completed | ||
> | ||
nodereport.triggerReport("myReportName"); | ||
When a NodeReport is triggered, start and end messages are issued to stderr | ||
and the filename of the report is returned to the caller. The default filename | ||
includes the date, time, PID and a sequence number. Alternatively, a filename | ||
can be specified as a parameter on the triggerReport() call. | ||
Content of the NodeReport in the initial implementation consists of a | ||
header section containing the event type, date, time, PID and Node version, | ||
sections containing Javascript and native stack traces, a section containing | ||
V8 heap information, a section containing libuv handle information and an OS | ||
platform information section showing CPU and memory usage and system limits. | ||
The following messages are issued to stderr when a NodeReport is triggered: | ||
nodereport.triggerReport("myReportName"); | ||
Writing Node.js error report to file: NodeReport.201605113.145311.26249.001.txt | ||
Node.js error report completed | ||
A NodeReport can also be triggered automatically on unhandled exceptions, fatal | ||
error events (for example out of memory errors), and signals (Linux/OSX only). | ||
Triggering on these events can be enabled using the following API call: | ||
A NodeReport can also be triggered on unhandled exception and fatal error | ||
events, and/or signals (Linux/OSX only). These and other options can be | ||
enabled or disabled using the following APIs: | ||
nodereport.setEvents("exception+fatalerror+signal+apicall"); | ||
Additional configuration is available using the following APIs: | ||
nodereport.setSignal("SIGUSR2|SIGQUIT"); | ||
@@ -69,5 +60,4 @@ nodereport.setFileName("stdout|stderr|<filename>"); | ||
To see examples of NodeReports generated from these events you can run the | ||
demonstration applications provided. These are Node.js applications which | ||
will prompt you to access via a browser to trigger the required event. | ||
Sample programs for triggering NodeReports are provided in the | ||
node_modules/nodereport/demo directory: | ||
@@ -74,0 +64,0 @@ api.js - NodeReport triggered by Javascript API call |
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Shell access
Supply chain riskThis module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
0
5
60077
139
3
66