├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── assets └── dashboard-screenshot.png ├── index.js ├── package.json └── test └── index.test.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | package-lock.json 61 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | sudo: false 3 | node_js: 4 | - "4" 5 | - "6" 6 | - "7" 7 | - "node" 8 | env: 9 | - CC=gcc-4.8 CXX=g++-4.8 10 | addons: 11 | apt: 12 | sources: 13 | - ubuntu-toolchain-r-test 14 | packages: 15 | - gcc-4.8 16 | - g++-4.8 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2017 nearform 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # stats 2 | 3 | [![Build Status](https://travis-ci.org/nearform/stats.svg?branch=master)](https://travis-ci.org/nearform/stats) 4 | 5 | Collect stats about your node.js process. 6 | 7 | ## Intro to the nearform stats tooling 8 | 9 | Created with the purpose to make creating visualisations about your process easy. At nearform, we achieve this using the modules [stats](http://github.com/nearform/stats) [stats-to-elasticsearch](http://github.com/nearform/stats-to-elasticsearch) and [create-stats-dashboard](http://github.com/nearform/create-stats-dashboard). This makes it very easy to collect process stats in elasticsearch and visualise them in a dashboard in kibana, similar to that below: 10 | 11 | a kibana stats dashboard screenshot 12 | 13 | Once your dashboard is setup with create-stats-dashboard, all you should need to do is require the stats-to-elasticsearch module and point it at the dashboard to get cool (and useful) visualisations! 14 | 15 | ## Installation 16 | 17 | ``` 18 | npm install --save @nearform/stats 19 | ``` 20 | 21 | ### Usage 22 | 23 | This module exports a function which instantiates an event emitter which emits a single event, `stats`. This event emitter has two functions which can be used to start and stop probing for statistics, `start()` and `stop()`. Listen to the `stats` event to get useful process statistics. 24 | 25 | ### Example: 26 | ```js 27 | const StatsProducer = require('@nearform/stats') 28 | const statsProducer = new StatsProducer() 29 | statsProducer.start() 30 | statsProducer.on('stats', function (stats) { 31 | // so something with these stats 32 | }) 33 | 34 | // some time later... 35 | statsProducer.stop() 36 | ``` 37 | 38 | ### API 39 | 40 | `StatsProducer(opts)` 41 | 42 | Returns an event emitter which emits a `stats` event containing useful stats. 43 | 44 | - opts: an `object` which can contain the following properties to set for generating statistics 45 | - sampleInterval: a `number` representing the amount of seconds to take a sample when running. Defaults to 5 seconds. 46 | - eventLoopSampleInterval: the interval at which the eventLoop should be sampled, defaults to 500. 47 | - eventLoopLimit: the maximum amount of delay that is tolerated before overLimit is detected as true, defaults to 50. 48 | - tags: an array of user defined strings to tag your stats with 49 | 50 | The StatsProducer event emitter which is returned has the following methods. 51 | 52 | `statsProducer.start()` - starts the stats producer listening and producing stats. 53 | 54 | `statsProducer.stop()` - stops producing stats. 55 | 56 | ### Stat object 57 | 58 | The stat object which is emitted has the following properties: 59 | 60 | - `tags`: the array of user defined strings defined in the constructor to tag your stats with 61 | - `id`: A uuid generated at start up for this stats producer 62 | - `timestamp`: The time the stats were generated 63 | - `process`: an object with the following properties extracted from the global process object. See the official node documentation for more information on these properties. 64 | - `cpuUsage`: This is a function on the process object which is invoked to fill in the value. 65 | - `memoryUsage`: This is a function on the process object which is invoked to fill in the value. 66 | - `uptime`: This is a function on the process object which is invoked to fill in the value. 67 | - `title` 68 | - `pid` 69 | - `release` 70 | - `versions` 71 | - `argv` 72 | - `execArgv` 73 | - `execPath` 74 | - `system`: an object with the following properties extracted from the os module. See the official node documentation for more information on these properties. 75 | - `cpus`: This is a function on the os module which is invoked at initialisation to fill in the value. This is not expected to change. 76 | - `uptime`: This is a function on the os module which is invoked to fill in the value. 77 | - `freemem`: This is a function on the os module which is invoked to fill in the value. 78 | - `loadavg`: This is a function on the os module which is invoked to fill in the value. 79 | - `platform` 80 | - `arch` 81 | - `eventLoop`: this is an object which contains the following properties extracted from benchmarking the eventloop. 82 | - `delay`: The delay in milliseconds (and fractions) from the expected eventloop run. It might be negative (in older nodes). 83 | - `limit`: The maximum amount of delay that is tolerated before overLimit becomes true. 84 | - `overlimit`: true if the delay > limit. 85 | - `gcRuns`: an array with objects added after every gc run. see [here](http://npm.im/gc-profiler) to see the format of the objects added 86 | 87 | ## Useful links 88 | 89 | - [stats](http://github.com/nearform/stats) - makes generating the stats to be visualised a breeze! 90 | - [stats-to-elasticsearch](http://github.com/nearform/stats-to-elasticsearch) - makes sending the stats to es a breeze! 91 | - [create-stats-dashboard](http://github.com/nearform/create-stats-dashboard) - makes creating your kibana dashboard a breeze! 92 | 93 | ### License 94 | 95 | Apache 2.0 96 | -------------------------------------------------------------------------------- /assets/dashboard-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nearform/stats/fbd64f60634d0437503915493196240e6deffce5/assets/dashboard-screenshot.png -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | const inherits = require('util').inherits 4 | const EventEmitter = require('events').EventEmitter 5 | const process = require('process') 6 | const os = require('os') 7 | const reInterval = require('reinterval') 8 | const loopbench = require('loopbench') 9 | const gcProfiler = require('gc-profiler') 10 | const hyperid = require('hyperid')() 11 | 12 | const net = require('net') 13 | const ChildProcess = require('child_process').ChildProcess 14 | const Timer = process.binding('timer_wrap').Timer 15 | const FSEvent = process.binding('fs_event_wrap').FSEvent 16 | 17 | function loadAvg (loadAvg) { 18 | return { 19 | '1m': loadAvg[0], 20 | '5m': loadAvg[1], 21 | '15m': loadAvg[2] 22 | } 23 | } 24 | 25 | function StatsProducer (optsArg) { 26 | if (!(this instanceof StatsProducer)) { 27 | return new StatsProducer(optsArg) 28 | } 29 | const opts = optsArg || {} 30 | this._opts = { 31 | loopbench: { 32 | sampleInterval: opts.eventLoopSampleInterval || 500, 33 | limit: opts.eventLoopLimit || 50 34 | }, 35 | sampleInterval: opts.sampleInterval || 5, 36 | tags: opts.tags || [] 37 | } 38 | this._probing = false 39 | this._loopbench = undefined 40 | this._gcProfiler = gcProfiler 41 | this._gcs = [] 42 | this._statsEmitterID = hyperid() 43 | 44 | this._emitInterval = reInterval(() => this.emit('stats', this._regenerateStats()), this._opts.sampleInterval * 1000) 45 | this._emitInterval.clear() 46 | 47 | const handlesInfo = this._getHandlesInfo() 48 | this.stats = { 49 | timestamp: new Date(), 50 | id: this._statsEmitterID, 51 | tags: this._opts.tags, 52 | process: { 53 | title: process.title, 54 | pid: process.pid, 55 | release: process.release, 56 | versions: process.versions, 57 | argv: process.argv, 58 | execArgv: process.execArgv, 59 | execPath: process.execPath, 60 | cpuUsage: this._getCpuUsage(), 61 | memoryUsage: process.memoryUsage(), 62 | // mainModule: process.mainModule, 63 | uptime: process.uptime(), 64 | handles: handlesInfo.handles, 65 | openServers: handlesInfo.openServers 66 | }, 67 | system: { 68 | cpus: os.cpus(), 69 | uptime: os.uptime(), 70 | freemem: os.freemem(), 71 | loadavg: loadAvg(os.loadavg()), 72 | hostname: os.hostname(), 73 | platform: process.platform, 74 | arch: process.arch 75 | }, 76 | eventLoop: {}, 77 | gcRuns: [] 78 | } 79 | } 80 | 81 | inherits(StatsProducer, EventEmitter) 82 | 83 | StatsProducer.prototype.start = function () { 84 | if (this._probing) return 85 | 86 | this._probing = true 87 | 88 | this._loopbench = loopbench(this._opts.loopbench) 89 | 90 | this._gcProfiler.on('gc', (stats) => this._gcs.push(stats)) 91 | 92 | this._emitInterval.reschedule(this._opts.sampleInterval * 1000) 93 | } 94 | 95 | StatsProducer.prototype.stop = function () { 96 | if (!this._probing) return 97 | 98 | // emit final stats 99 | this.emit('stats', this._regenerateStats()) 100 | 101 | this._probing = false 102 | 103 | this._loopbench.stop() 104 | this._loopbench.removeAllListeners() 105 | this._loopbench = undefined 106 | 107 | this._gcProfiler.removeAllListeners() 108 | 109 | this._emitInterval.clear() 110 | } 111 | 112 | StatsProducer.prototype._regenerateStats = function () { 113 | // update meta 114 | this.stats.timestamp = new Date() 115 | 116 | this.stats.process.uptime = process.uptime() 117 | this.stats.process.cpuUsage = this._getCpuUsage() 118 | this.stats.process.memoryUsage = process.memoryUsage() 119 | const handlesInfo = this._getHandlesInfo() 120 | this.stats.process.handles = handlesInfo.handles 121 | this.stats.process.openServers = handlesInfo.openServers 122 | this.stats.system.uptime = os.uptime() 123 | this.stats.system.freemem = os.freemem() 124 | this.stats.system.loadavg = loadAvg(os.loadavg()) 125 | 126 | this.stats.eventLoop = { 127 | delay: this._loopbench.delay, 128 | limit: this._loopbench.limit, 129 | overLimit: this._loopbench.overLimit 130 | } 131 | 132 | this.stats.gcRuns = this._gcs.splice(0) 133 | 134 | return this.stats 135 | } 136 | 137 | StatsProducer.prototype._getHandlesInfo = function () { 138 | const handles = { 139 | sockets: 0, 140 | servers: 0, 141 | timers: 0, 142 | childProcesses: 0, 143 | fsWatchers: 0, 144 | other: 0 145 | } 146 | const openServers = [] 147 | 148 | for (let handle of process._getActiveHandles()) { 149 | if (handle instanceof Timer) { 150 | const timerList = handle._list || handle 151 | let t = timerList._idleNext 152 | while (t !== timerList) { 153 | handles.timers++ 154 | t = t._idleNext 155 | } 156 | } else if (handle instanceof net.Socket) { 157 | handles.sockets++ 158 | } else if (handle instanceof net.Server) { 159 | handles.servers++ 160 | openServers.push(handle.address()) 161 | } else if (handle instanceof ChildProcess) { 162 | handles.childProcesses++ 163 | } else if (handle instanceof EventEmitter && typeof handle.start === 'function' && typeof handle.close === 'function' && handle._handle instanceof FSEvent) { 164 | handles.fsWatchers++ 165 | } else { 166 | handles.other++ 167 | } 168 | } 169 | 170 | return {handles, openServers} 171 | } 172 | 173 | StatsProducer.prototype._getCpuUsage = function () { 174 | if (process.cpuUsage) return process.cpuUsage() 175 | else return 0 176 | } 177 | 178 | module.exports = StatsProducer 179 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@nearform/stats", 3 | "version": "1.0.1", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "precommit": "npm test", 8 | "prepush": "npm test", 9 | "pretest": "standard", 10 | "test": "tape ./test/*.test.js | tap-spec" 11 | }, 12 | "keywords": [ 13 | "Probe", 14 | "stats", 15 | "process", 16 | "profile", 17 | "gc", 18 | "event-loop" 19 | ], 20 | "author": "Glen Keane", 21 | "license": "Apache-2.0", 22 | "dependencies": { 23 | "gc-profiler": "^1.4.0", 24 | "hyperid": "^1.2.0", 25 | "loopbench": "^1.2.0", 26 | "reinterval": "^1.1.0" 27 | }, 28 | "devDependencies": { 29 | "husky": "^0.14.2", 30 | "standard": "^10.0.2", 31 | "tap-spec": "^4.1.1", 32 | "tape": "^4.7.0" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /test/index.test.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | const test = require('tape') 4 | const StatsProducer = require('../') 5 | 6 | test('stats producer initialises with defaults as expected', (t) => { 7 | const statsProducer = new StatsProducer() 8 | 9 | t.false(statsProducer._probing) 10 | 11 | t.equal(statsProducer._opts.loopbench.sampleInterval, 500, 'Stats producer should initialise with the correct defaults') 12 | t.equal(statsProducer._opts.loopbench.limit, 50, 'Stats producer should initialise with the correct defaults') 13 | t.equal(statsProducer._opts.sampleInterval, 5, 'Stats producer should initialise with the correct defaults') 14 | t.deepEqual(statsProducer._opts.tags, [], 'Stats producer should initialise with the correct defaults') 15 | t.end() 16 | }) 17 | 18 | test('stats producer runs as expected with defaults', {timeout: 20000}, (t) => { 19 | const statsProducer = new StatsProducer() 20 | 21 | t.false(statsProducer._probing) 22 | 23 | statsProducer.start() 24 | 25 | t.true(statsProducer._probing) 26 | 27 | let numberOfGeneratedStats = 0 28 | statsProducer.on('stats', (stats) => { 29 | t.ok(stats.timestamp) 30 | t.ok(stats.process) 31 | t.ok(stats.system) 32 | t.ok(stats.eventLoop) 33 | 34 | numberOfGeneratedStats++ 35 | }) 36 | 37 | setTimeout(() => { 38 | t.true(statsProducer._probing, 'should be running') 39 | statsProducer.stop() 40 | t.false(statsProducer._probing, 'should no longer be running') 41 | }, 11000) 42 | 43 | setTimeout(() => { 44 | t.true(numberOfGeneratedStats === 3, 'stats producer only runs an expected amount of times') 45 | t.end() 46 | }, 16000) 47 | }) 48 | 49 | test('stats producer runs as expected with with overwritten defaults', {timeout: 5000}, (t) => { 50 | const statsProducer = new StatsProducer({sampleInterval: 1, tags: ['some', 'tags']}) 51 | 52 | t.false(statsProducer._probing) 53 | 54 | statsProducer.start() 55 | 56 | t.true(statsProducer._probing) 57 | 58 | let numberOfGeneratedStats = 0 59 | statsProducer.on('stats', (stats) => { 60 | t.ok(stats.timestamp) 61 | t.ok(stats.process) 62 | t.ok(stats.system) 63 | t.ok(stats.eventLoop) 64 | t.deepEqual(stats.tags, ['some', 'tags']) 65 | 66 | numberOfGeneratedStats++ 67 | }) 68 | 69 | setTimeout(() => { 70 | t.true(statsProducer._probing, 'should be running') 71 | statsProducer.stop() 72 | t.false(statsProducer._probing, 'should no longer be running') 73 | }, 3500) 74 | 75 | setTimeout(() => { 76 | t.true(numberOfGeneratedStats === 4, 'stats producer only runs an expected amount of times') 77 | t.end() 78 | }, 4000) 79 | }) 80 | 81 | test('stats producer shouldn\'t emit anything if never started', {timeout: 5000}, (t) => { 82 | const statsProducer = new StatsProducer({sampleInterval: 1}) 83 | t.false(statsProducer._probing) 84 | setTimeout(() => { 85 | t.false(statsProducer._probing) 86 | t.end() 87 | }, 4000) 88 | }) 89 | --------------------------------------------------------------------------------