anthrax3 / systeminformation

System Information Library for Node.JS

systeminformation

Simple system and OS information library for node.js

Quick Start

Lightweight collection of 35+ functions to retrieve detailed hardware, system and OS information (Linux, macOS, partial Windows and FreeBSD support) - no npm dependencies.

Installation

$ npm install systeminformation --save

Usage

All functions (except version and time) are implemented as asynchronous functions. Here a small example how to use them:

const si = require('systeminformation');

// callback style
si.cpu(function(data) {
	console.log('CPU-Information:');
	console.log(data);
});

// promises style - new in version 3
si.cpu()
	.then(data => console.log(data))
	.catch(error => console.error(error));

// full async / await example (node >= 7.6)
async function cpu() {
  try {
    const data = await si.cpu();
    console.log(data)
  } catch (e) {
    console.log(e)
  }
}

News and Changes

Latest Activity

(last 7 major and minor version releases)

• Version 3.40.0: extended versions() (php, redis, mongodb)
• Version 3.39.0: added versions().mysql and versions().nginx, starting SunOS support
• Version 3.38.0: added battery.acconnected
• Version 3.37.0: extended FreeBSD support networkStats()
• Version 3.36.0: extended FreeBSD support networkConnections()
• Version 3.35.0: extended FreeBSD support processLoad()
• Version 3.34.0: first partial FreeBSD support
• ...

You can find all changes here: detailed changelog

Core concept

Node.js comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still work in progress. Version 3 comes with further improvements. First it requires now node.js version 4.0 and above. Another big change is, that all functions now return promises. You can use them like before with callbacks OR with promises (see example in this documentation). I am sure, there is for sure room for improvement. I was only able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra) and some Windows and FreeBSD machines. Since version 2 nearly all functionality is available for OS X/Darwin platforms. In Version 3 I started to add windows and (partial) FreeBSD support - see docs.

If you have comments, suggestions & reports, please feel free to contact me!

I also created a nice little command line tool called mmon (micro-monitor) for Linux and macOS, also available via github and npm

Reference

Function Reference and OS Support

1. General

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.version()	: string	X	X	X	X	lib version (no callback/promise)
si.time()	{...}	X	X	X	X	(no callback/promise)
	current	X	X	X	X	local time
	uptime	X	X	X	X	uptime
	timezone	X	X	X	X	e.g. GMT+0200
	timezoneName	X	X	X	X	e.g. CEST

2. System (HW)

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.system(cb)	{...}	X	X	X	X	hardware information
	manufacturer	X	X	X	X	e.g. 'MSI'
	model	X	X	X	X	model/product e.g. 'MS-7823'
	version	X	X	X	X	version e.g. '1.0'
	serial	X	X	X	X	serial number
	uuid	X	X	X	X	UUID
	sku	X	X		X	SKU number
si.bios(cb)	{...}	X	X	X	X	hardware information
	vendor	X	X	X	X	e.g. 'AMI'
	version	X	X		X	version
	releaseDate	X	X		X	release date
	revision	X	X		X	revision
si.baseboard(cb)	{...}	X	X	X	X	hardware information
	manufacturer	X	X	X	X	e.g. 'ASUS'
	model	X	X	X	X	model / product name
	version	X	X	X	X	version
	serial	X	X	X	X	serial number
	assetTag	X	X	X	X	asset tag

3. CPU, Memory, Disks, Battery, Graphics

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.cpu(cb)	{...}	X	X	X	X	CPU information
	manufacturer	X	X	X	X	e.g. 'Intel(R)'
	brand	X	X	X	X	e.g. 'Core(TM)2 Duo'
	speed	X	X	X	X	in GHz e.g. '3.40'
	speedmin	X		X	X	in GHz e.g. '0.80'
	speedmax	X	X	X	X	in GHz e.g. '3.90'
	cores	X	X	X	X	# cores
	vendor	X	X	X	X	vendor ID
	family	X	X	X	X	processor family
	Model	X	X	X	X	processor model
	stepping	X	X	X	X	processor stepping
	revision	X		X	X	revision
	voltage		X			voltage
	cache	X	X	X	X	cache in bytes (object)
	cache.l1d	X	X	X	X	L1D (data) size
	cache.l1i	X	X	X	X	L1I (instruction) size
	cache.l2	X	X	X	X	L2 size
	cache.l3	X	X	X	X	L3 size
si.cpuFlags(cb)	: string	X	X	X	X	CPU flags
si.cpuCache(cb)	{...}	X	X	X	X	CPU cache sizes
	l1d	X	X	X	X	L1D size
	l1i	X	X	X	X	L1I size
	l2	X	X	X	X	L2 size
	l3	X	X	X	X	L3 size
si.cpuCurrentspeed(cb)	{...}	X	X	X	X	current CPU speed (in GHz)
	avg	X	X	X	X	avg CPU speed (all cores)
	min	X	X	X	X	min CPU speed (all cores)
	max	X	X	X	X	max CPU speed (all cores)
si.cpuTemperature(cb)	{...}	X	X	X*	X	CPU temperature (if supported)
	main	X	X	X	X	main temperature (avg)
	cores	X	X	X	X	array of temperatures
	max	X	X	X	X	max temperature
si.mem(cb)	{...}	X	X	X	X	Memory information (in bytes)
	total	X	X	X	X	total memory in bytes
	free	X	X	X	X	not used in bytes
	used	X	X	X	X	used (incl. buffers/cache)
	active	X	X	X	X	used actively (excl. buffers/cache)
	buffcache	X	X	X		used by buffers+cache
	available	X	X	X	X	potentially available (total - active)
	swaptotal	X	X	X	X
	swapused	X	X	X	X
	swapfree	X	X	X	X
si.memLayout(cb)	[{...}]	X	X	X	X	Memory Layout (array)
	[0].size	X	X	X	X	size in bytes
	[0].bank	X	X		X	memory bank
	[0].type	X	X	X	X	memory type
	[0].clockSpeed	X	X	X	X	clock speed
	[0].formFactor	X	X		X	form factor
	[0].manufacturer	X	X	X	X	manufacturer
	[0].partNum	X	X	X	X	part number
	[0].serialNum	X	X	X	X	serial number
	[0].voltageConfigured	X	X		X	voltage conf.
	[0].voltageMin	X	X		X	voltage min
	[0].voltageMax	X	X		X	voltage max
si.diskLayout(cb)	[{...}]	X		X	X	physical disk layout (array)
	[0].type	X		X	X	HD, SSD
	[0].name	X		X	X	disk name
	[0].vendor	X			X	vendor/producer
	[0].firmwareRevision	X		X	X	firmware revision
	[0].serialNum	X		X	X	serial number
	[0].interfaceType				X
	[0].size	X		X	X	size in bytes
	[0].totalCylinders				X	total cylinders
	[0].totalHeads				X	total heads
	[0].totalTracks				X	total tracks
	[0].tracksPerCylinder				X	tracks per cylinder
	[0].sectorsPerTrack				X	sectors per track
	[0].totalSectors				X	total sectors
	[0].bytesPerSector				X	bytes per sector
si.battery(cb)	{...}	X	X	X	X	battery information
	hasbattery	X	X	X	X	indicates presence of battery
	cyclecount	X		X		numbers of recharges
	ischarging	X	X	X	X	indicates if battery is charging
	maxcapacity	X		X	X	max capacity of battery
	currentcapacity	X		X	X	current capacity of battery
	percent	X	X	X	X	charging level in percent
	acconnected	X	X	X	X	AC connected
si.graphics(cb)	{...}	X		X	X	arrays of graphics controllers and displays
	controllers[]	X		X	X	graphics controllers array
	...[0].model	X		X	X	graphics controller model
	...[0].vendor	X		X	X	e.g. ATI
	...[0].bus	X		X	X	on which bus (e.g. PCIe)
	...[0].vram	X		X	X	VRAM size (in MB)
	...[0].vramDynamic	X		X	X	true if dynamicly allocated ram
	displays[]	X		X	X	monitor/display Array
	...[0].model	X		X	X	monitor/display Model
	...[0].main	X		X		true if main monitor
	...[0].builtin	X		X		true if built in monitor
	...[0].connection	X		X		e.g. DisplayPort or HDMI
	...[0].resolutionx	X		X	X	pixel horizontal
	...[0].resolutiony	X		X	X	pixel vertical
	...[0].pixeldepth	X		X	X	color depth in bits
	...[0].sizex	X		X		size in mm horizontal
	...[0].sizey	X		X		size in mm vertical

4. Operating System

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.osInfo(cb)	{...}	X	X	X	X	OS information
	platform	X	X	X	X	'Linux', 'Darwin', 'Windows'
	distro	X	X	X	X
	release	X	X	X	X
	codename			X
	kernel	X	X	X	X	kernel release - same as os.release()
	arch	X	X	X	X	same as os.arch()
	hostname	X	X	X	X	same as os.hostname()
	logofile	X	X	X	X	e.g. 'apple', 'debian', 'fedora', ...
si.versions(cb)	{...}	X	X	X	X	version information (kernel, ssl, node, ...)
si.shell(cb)	: string	X	X	X		standard shell
si.users(cb)	[{...}]	X	X	X	X	array of users online
	[0].user	X	X	X	X	user name
	[0].tty	X	X	X	X	terminal
	[0].date	X	X	X	X	login date
	[0].time	X	X	X	X	login time
	[0].ip	X	X	X		ip address (remote login)
	[0].command	X	X	X		last command or shell

5. File System

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.fsSize(cb)	[{...}]	X	X	X	X	returns array of mounted file systems
	[0].fs	X	X	X	X	name of file system
	[0].type	X	X	X	X	type of file system
	[0].size	X	X	X	X	sizes in bytes
	[0].used	X	X	X	X	used in bytes
	[0].use	X	X	X	X	used in %
	[0].mount	X	X	X	X	mount point
si.blockDevices(cb)	[{...}]	X		X	X	returns array of disks, partitions, raids and roms
	[0].name	X		X	X	name
	[0].type	X		X	X	type
	[0].fstype	X		X	X	file system type (e.g. ext4)
	[0].mount	X		X	X	mount point
	[0].size	X		X	X	size in bytes
	[0].physical	X		X	X	physical type (HDD, SSD, CD/DVD)
	[0].uuid	X		X	X	UUID
	[0].label	X		X	X	label
	[0].model	X		X		model
	[0].serial	X			X	serial
	[0].removable	X		X	X	serial
	[0].protocol	X		X		protocol (SATA, PCI-Express, ...)
si.fsStats(cb)	{...}	X		X		current transfer stats
	rx	X		X		bytes read since startup
	wx	X		X		bytes written since startup
	tx	X		X		total bytes read + written since startup
	rx_sec	X		X		bytes read / second (* see notes)
	wx_sec	X		X		bytes written / second (* see notes)
	tx_sec	X		X		total bytes reads + written / second
	ms	X		X		interval length (for per second values)
si.disksIO(cb)	{...}	X		X		current transfer stats
	rIO	X		X		read IOs on all mounted drives
	wIO	X		X		write IOs on all mounted drives
	tIO	X		X		write IOs on all mounted drives
	rIO_sec	X		X		read IO per sec (* see notes)
	wIO_sec	X		X		write IO per sec (* see notes)
	tIO_sec	X		X		total IO per sec (* see notes)
	ms	X		X		interval length (for per second values)

6. Network related functions

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.networkInterfaces(cb)	[{...}]	X	X	X	X	array of network interfaces
	[0].iface	X	X	X	X	interface name
	[0].ip4	X	X	X	X	ip4 address
	[0].ip6	X	X	X	X	ip6 address
	[0].mac	X	X	X	X	MAC address
	[0].internal	X	X	X	X	true if internal interface
si.networkInterfaceDefault(cb)	: string	X	X	X	X	get name of default network interface
si.networkStats(iface,cb)	{...}	X	X	X	X	current network stats of given interface iface parameter is optional defaults to first external network interface
	iface	X	X	X	X	interface
	operstate	X	X	X	X	up / down
	rx	X	X	X	X	received bytes overall
	tx	X	X	X	X	transferred bytes overall
	rx_sec	X	X	X	X	received bytes / second (* see notes)
	tx_sec	X	X	X	X	transferred bytes per second (* see notes)
	ms	X	X	X	X	interval length (for per second values)
si.networkConnections(cb)	[{...}]	X	X	X	X	current network network connections returns an array of all connections
	[0].protocol	X	X	X	X	tcp or udp
	[0].localaddress	X	X	X	X	local address
	[0].localport	X	X	X	X	local port
	[0].peeraddress	X	X	X	X	peer address
	[0].peerport	X	X	X	X	peer port
	[0].state	X	X	X	X	like ESTABLISHED, TIME_WAIT, ...
si.inetChecksite(url, cb)	{...}	X	X	X	X	response-time (ms) to fetch given URL
	url	X	X	X	X	given url
	ok	X	X	X	X	status code OK (2xx, 3xx)
	status	X	X	X	X	status code
	ms	X	X	X	X	response time in ms
si.inetLatency(host, cb)	: number	X	X	X	X	response-time (ms) to external resource host parameter is optional (default 8.8.8.8)

7. Current Load, Processes & Services

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.currentLoad(cb)	{...}	X		X	X	CPU-Load
	avgload	X		X	X	average load
	currentload	X		X	X	CPU load in %
	currentload_user	X		X	X	CPU load user in %
	currentload_system	X		X	X	CPU load system in %
	currentload_nice	X		X	X	CPU load nice in %
	currentload_idle	X		X	X	CPU load idle in %
	currentload_irq	X		X	X	CPU load system in %
	raw_currentload...	X		X	X	CPU load raw values (ticks)
	cpus[]	X		X	X	current loads per CPU in % + raw ticks
si.fullLoad(cb)	: integer	X		X	X	CPU full load since bootup in %
si.processes(cb)	{...}	X	X	X	X	# running processes
	all	X	X	X	X	# of all processes
	running	X	X	X	X	# of all processes running
	blocked	X	X	X	X	# of all processes blocked
	sleeping	X	X	X	X	# of all processes sleeping
	unknown				X	# of all processes unknown status
	list[]	X	X	X	X	list of all processes incl. details
	...[0].pid	X	X	X	X	process PID
	...[0].name	X	X	X	X	process name
	...[0].pcpu	X	X	X	X	process % CPU usage
	...[0].pcpuu	X	X		X	process % CPU usage (user)
	...[0].pcpus	X	X		X	process % CPU usage (system)
	...[0].pmem	X	X	X	X	process memory %
	...[0].priority	X	X	X	X	process priotity
	...[0].mem_vsz	X	X	X	X	process virtual memory size
	...[0].mem_rss	X	X	X	X	process mem resident set size
	...[0].nice	X	X	X		process nice value
	...[0].started	X	X	X	X	process start time
	...[0].state	X	X	X	X	process state (e.g. sleeping)
	...[0].tty	X	X	X		tty from which process was started
	...[0].user	X	X	X		user who started process
	...[0].command	X	X	X	X	process starting command
si.processLoad('apache2',cb)	{...}	X	X	X		detailed information about given process
	proc	X	X	X		process name
	pid	X	X	X		PID
	cpu	X	X	X		process % CPU
	mem	X	X	X		process % MEM
si.services('mysql, apache2', cb)	[{...}]	X	X	X	X	pass comma separated string of services
	[0].name	X	X	X	X	name of service
	[0].running	X	X	X	X	true / false
	[0].pcpu	X	X	X		process % CPU
	[0].pmem	X	X	X		process % MEM

8. Docker

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.dockerContainers(all, cb)	[{...}]	X	X	X	X	returns array of active/all docker containers
	[0].id	X	X	X	X	ID of container
	[0].name	X	X	X	X	name of container
	[0].image	X	X	X	X	name of image
	[0].imageID	X	X	X	X	ID of image
	[0].command	X	X	X	X	command
	[0].created	X	X	X	X	creation time
	[0].state	X	X	X	X	created, running, exited
	[0].ports	X	X	X	X	array of ports
	[0].mounts	X	X	X	X	array of mounts
si.dockerContainerStats(id, cb)	{...}	X	X	X	X	statistics for a specific container
	id	X	X	X	X	Container ID
	mem_usage	X	X	X	X	memory usage in bytes
	mem_limit	X	X	X	X	memory limit (max mem) in bytes
	mem_percent	X	X	X	X	memory usage in percent
	cpu_percent	X	X	X	X	cpu usage in percent
	pids	X	X	X	X	number of processes
	netIO.rx	X	X	X	X	received bytes via network
	netIO.wx	X	X	X	X	sent bytes via network
	blockIO.r	X	X	X	X	bytes read from BlockIO
	blockIO.w	X	X	X	X	bytes written to BlockIO
	cpu_stats	X	X	X	X	detailed cpu stats
	percpu_stats	X	X	X	X	detailed per cpu stats
	memory_stats	X	X	X	X	detailed memory stats
	networks	X	X	X	X	detailed network stats per interface
si.dockerContainerProcesses(id, cb)	[{...}]	X	X	X	X	array of processes inside a container
	[0].pid_host	X	X	X	X	process ID (host)
	[0].ppid	X	X	X	X	parent process ID
	[0].pgid	X	X	X	X	process group ID
	[0].user	X	X	X	X	effective user name
	[0].ruser	X	X	X	X	real user name
	[0].group	X	X	X	X	effective group name
	[0].rgroup	X	X	X	X	real group name
	[0].stat	X	X	X	X	process state
	[0].time	X	X	X	X	accumulated CPU time
	[0].elapsed	X	X	X	X	elapsed running time
	[0].nice	X	X	X	X	nice value
	[0].rss	X	X	X	X	resident set size
	[0].vsz	X	X	X	X	virtual size in Kbytes
	[0].command	X	X	X	X	command and arguments
si.dockerAll(cb)	{...}	X	X	X	X	list of all containers including their stats and processes in one single array

9. "Get All at once" - functions

Function	Result object	Linux	FreeBSD	macOS	Win	Comments
si.getStaticData(cb)	{...}	X	X	X	X	all static data at once
si.getDynamicData(srv,iface,cb)	{...}	X	X	X	X	all dynamic data at once
si.getAllData(srv,iface,cb)	{...}	X	X	X	X	all data at once

cb: Asynchronous Function Calls (callback)

Remember: all functions (except version and time) are implemented as asynchronous functions! There are now three ways to consume them:

Callback Style

const si = require('systeminformation');

si.networkStats('eth1', function(data) {
	console.log('Network Interface Stats (eth1):');
	console.log('- is up: ' + data.operstate);
	console.log('- RX bytes overall: ' + data.rx);
	console.log('- TX bytes overall: ' + data.tx);
	console.log('- RX bytes/sec: ' + data.rx_sec);
	console.log('- TX bytes/sec: ' + data.tx_sec);
})

Promises

Promises Style is new in version 3.0.

When omitting callback parameter (cb), then you can use all function in a promise oriented way. All functions (exept of version and time) are returning a promise, that you can consume:

const si = require('systeminformation');

si.networkStats('eth1')
	.then(data => {
		console.log('Network Interface Stats (eth1):');
		console.log('- is up: ' + data.operstate);
		console.log('- RX bytes overall: ' + data.rx);
		console.log('- TX bytes overall: ' + data.tx);
		console.log('- RX bytes/sec: ' + data.rx_sec);
		console.log('- TX bytes/sec: ' + data.tx_sec);
	})
	.catch(error => console.error(error));

Async / Await

Using async / await (available since node v7.6)

Since node v7.6 you can also use the async / await pattern. The above example would then look like this:

const si = require('systeminformation');

async function network() {
    try {
        const data = await si.networkStats('eth1');
        console.log(`Network Interface Stats (eth1):
        - is up: ${data.operstate}
        - RX bytes overall: ${data.rx}
        - TX bytes overall: ${data.tx}
        - RX bytes/sec: ${data.rx_sec}
        - TX bytes/sec: ${data.tx_sec}`)
    } catch (e) {
        console.log(e)
    }
}

Known Issues

macOS - Temperature Sensor

To be able to measure temperature on macOS I created a litte additional package. Due to some difficulties in NPM with optionalDependencies I unfortunately was getting unexpected warnings on other platforms. So I decided to drop this optional dependencies for macOS - so by default, you will not get correct values.

But if you need to detect macOS temperature just run the following additional installation command:

$ npm install osx-temperature-sensor --save

systeminformation will then detect this additional library and return the temperature when calling systeminformations standard function cpuTemperature()

Windows Temperature, Battery, ...

wmic - which is used to determine temperature and battery sometimes needs to be run with admin privileges. So if you do not get any values, try to run it again with according privileges. If you still do not get any values, your system might not support this feature. In some cases we also discovered that wmic returned incorrect temperature values.

Linux Temperature

In some cases you need to install the linux sensors package to be able to measure temperature e.g. on DEBIAN based systems by running sudo apt-get install lm-sensors

*: Additional Notes

In fsStats, disksIO and networkStats the results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the second call of the function. It is determined by calculating the difference of transferred bytes / IOs divided by the time between two calls of the function.

The first time you are calling one of this functions, you will get -1 for transfer rates. The second time, you should then get statistics based on the time between the two calls …

So basically, if you e.g. need a values for network stats every second, your code should look like this:

const si = require('systeminformation');

setInterval(function() {
	si.networkStats().then(data => {
	    console.log(data);
	})
}, 1000)

Beginning with the second call, you get network transfer values per second.

Finding new issues

I am happy to discuss any comments and suggestions. Please feel free to contact me if you see any possibility of improvement!

Comments

If you have ideas or comments, please do not hesitate to contact me.

Happy monitoring!

Sincerely,

Sebastian Hildebrandt, +innovations

Credits

Written by Sebastian Hildebrandt sebhildebrandt

Contributers

• Guillaume Legrain glegrain
• Riccardo Novaglia richy24
• Quentin Busuttil Buzut
• lapsio lapsio
• csy csy
• Tiago Roldão tiagoroldao
• dragonjet dragonjet
• Adam Reis adamreisnz
• Jimi M ItsJimi
• Git² GitSquared

OSX Temperature: credits here are going to:

• Massimiliano Marcon mmarcon for his work on smc-code
• Sébastien Lavoie lavoiesl for his work on osx-cpu-temp code.

Copyright Information

Linux is a registered trademark of Linus Torvalds. Apple, macOS, OS X are registered trademarks of Apple Inc., Windows is a registered trademark of Microsoft Corporation. Node.js is a trademark of Joyent Inc., Intel is a trademark of Intel Corporation, AMD is a trademark of Advanced Micro Devices Inc., Raspberry Pi is a trademark of the Raspberry Pi Foundation, Debian is a trademark of the Debian Project, Ubuntu is a trademark of Canonical Ltd., FreeBSD is a registered trademark of The FreeBSD Foundation, Docker is a trademark of Docker, Inc.

All other trademarks are the property of their respective owners.

License

The MIT License (MIT)

Copyright © 2014-2018 Sebastian Hildebrandt, +innovations.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Further details see LICENSE file.