systeminformation/CHANGELOG.md
Sebastian Hildebrandt 1be3dc335e updated docs
2016-11-04 12:19:59 +01:00

7.5 KiB

Changelog

Major (breaking) Changes - Version 3

  • works only with [node.js][nodejs-url] v4.0.0 and above (using now internal ES6 promise function, arrow functions, ...)
  • Promises. As you can see above, you can now also use it in a promise oriented way. But callbacks are still supported.
  • cpuCurrentspeed: now returns an object with current minimal, maximal and average CPU frequencies of all cores.
  • mem: now supports also newer versions of free (Version 3.3.10 and above); extended information avaliable (potentially available memory)
  • fsStats: added information sum bytes read + write (tx) and sum transfer rate/sec (tx_sec)
  • networkInterfaces: now providing one more detail: internal - true if this is an internal interface like "lo"
  • networkConnections: instead of only counting sockets, you now get an array of objects with connection details for each socket (protocol, local and peer address, state)
  • users: now provides an array of objects with users online including detailed session information (login date/time, ip address, terminal, command)
  • inetLatency: now you can provide a host against which you want to test latency (default is 8.8.8.8)
  • getDynamicData: changed order of parameters (callback - if provided - is now the last one): getDynamicData(srv, network, callback)
  • getAllData: changed order of parameters (callback - if provided - is now the last one): getAllData(srv, network, callback)

New Functions

  • dockerContainerProcesses: returns processes for a specific docker container (new in version 3.8)
  • versions: returns object of versions - kernel, ssl, node, npm, ...(new in version 3.6)
  • graphics: returns arrays of graphics controllers and displays (new in version 3.5)
  • networkInterfaceDefault: returns default network interface (new in version 3.4)
  • processes: now returns also a process list with all process details (new in version 3.3)
  • battery: retrieves battery status and charging level (new in version 3.2)
  • dockerContainers: returns a list of all docker containers (new in version 3.1)
  • dockerContainerStats: returns statistics for a specific docker container (new in version 3.1)
  • dockerAll: returns a list of all docker containers including their stats (new in version 3.1)
  • disksIO: returns overall diskIO and IOPS values for all mounted volumes (new in version 3.0)

Bug Fixes

  • bugfix disksIO - on OSX read and write got mixed up
  • several bug fixes (like assess errors in cpuCurrentspeed, potentially incorrect results in users, ...)
  • testet on even more platforms and linux distributions

Be aware, that the new version 3.x is NOT fully backward compatible to version 2.x ...

Major (breaking) Changes - Version 2

There had been a lot of changes in version 2 of systeminformation! Here is a quick overview (for those who come from version 1):

New Functions

  • version: returns systeminformation version (semver) of this library
  • system: hardware info (manufacturer, product/model name, version, serial, uuid)
  • networkConnections: number of active connections
  • inetLatency: latency in ms to external resource (internet)
  • getStaticData: returns on json object with static data at once (OS, CPU, Network Interfaces - they should not change until restarted)
  • getDynamicData: returns on json object with all dynamic data at once (e.g. for monitoring agents)
  • getAllData: returns on json object with all data (static and dynamic) at once

Renamed Functions (now all camelCase)

  • osinfo: renamed to osInfo
  • cpu_currentspeed: renamed to cpuCurrentspeed
  • cpu_temperature: renamed to cpuTemperature
  • fs_size: renamed to fsSize
  • fs_speed: renamed to fsStats
  • network_interfaces: renamed to networkInterfaces
  • network_speed: renamed to networkStats
  • network_connections: renamed to networkConnections
  • currentload: renamed to currentLoad
  • fullload: renamed to fullLoad
  • processload: renamed to processLoad
  • checksite: renamed to inetChecksite

Function Changes

  • cpu_temperature/cpuTemperature: -1 is new default (and indicates that non sensors are installed)
  • cpu_temperature/cpuTemperature: new result max which returns max temperature of all cores
  • cpu_currentspeed/cpuCurrentspeed: now in GHz
  • cpu: splitted manufacturer (e.g. Intel) and brand (e.g. Core 2 Duo)
  • network_speed/networkStats: now better support for OS X (also support for operstate)
  • network_speed/networkStats: overall received and transferred bytes (rx, tx)
  • mem: now better support for OS X (also support for swaptotal, swapused, swapfree)
  • fs_size/fsSize: use-values now in % (0 - 100% instead of 0 - 1)
  • fs_speed/fsStats: now also full support for OS X
  • checksite/inetChecksite: new result structure - see command reference
  • checksite/inetChecksite: ms (former response_ms): -1 if not ok

Other changes

  • no more external dependencies: request is not longer needed
  • where possible results are now integer or float values (instead of strings) because it is easier to calculate with numbers ;-)

Version history

Version Date Comment
3.8.1 2016-11-04 updated docs
3.8.0 2016-11-04 added dockerContainerProcesses
3.7.1 2016-11-03 code refactoring
3.7.0 2016-11-02 extended docker stats, and no longer relying on curl
3.6.0 2016-09-14 added versions (kernel, ssl, node, npm, pm2, ...)
3.5.1 2016-09-14 bugfix graphics info
3.5.0 2016-09-14 added graphics info (controller, display)
3.4.4 2016-09-02 tiny fixes system.model, getDefaultNetworkInterface
3.4.3 2016-09-02 tiny bug fix fsStats, disksIO OSX
3.4.2 2016-09-01 improved default network interface
3.4.1 2016-08-30 updated docs
3.4.0 2016-08-30 rewritten processes current cpu usage
3.3.0 2016-08-24 process list added to processes
3.2.1 2016-08-19 updated docs, improvement system
3.2.0 2016-08-19 added battery information
3.1.1 2016-08-18 improved system and os detection (vm, ...), bugfix disksIO
3.1.0 2016-08-18 added Docker stats
3.0.1 2016-08-17 Bug-Fix disksIO, users, updated docs
3.0.0 2016-08-03 new major version 3.0
2.0.5 2016-03-02 changed .gitignore
2.0.4 2016-02-22 tiny correction - removed double quotes CPU brand, ...
2.0.3 2016-02-22 optimized cpuCurrentspeed
2.0.2 2016-02-22 added CoreOS identification
2.0.1 2016-01-07 minor patch
2.0.0 2016-01-07 new major version 2.0
1.0.7 2015-11-27 fixed: si.network_speed()
1.0.6 2015-09-17 fixed: si.users()
1.0.5 2015-09-14 updated dependencies
1.0.4 2015-07-18 updated docs
1.0.3 2015-07-18 bugfix cpu cores
1.0.2 2015-07-18 bugfix cpu_currentspeed, cpu_temperature
1.0.1 2015-07-18 documentation update
1.0.0 2015-07-18 bug-fixes, version bump, published as npm component
0.0.3 2014-04-14 bug-fix (cpu_speed)
0.0.2 2014-03-14 Optimization FS-Speed & CPU current speed
0.0.1 2014-03-13 initial release