mirror of
https://github.com/OneUptime/oneuptime.git
synced 2026-04-06 00:32:12 +02:00
remove built folders from gitlab
This commit is contained in:
deityhub
5
js-sdk/.gitignore
vendored
5
js-sdk/.gitignore
vendored
@@ -1,2 +1,5 @@
|
||||
test.html
|
||||
/node_modules
|
||||
/node_modules
|
||||
|
||||
/build
|
||||
/dist
|
||||
@@ -1,13 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
"use strict";
|
||||
|
||||
var _require = require('../../package.json'),
|
||||
version = _require.version;
|
||||
|
||||
var program = require('commander');
|
||||
|
||||
program.name('fyipe').version(version, '-v, --version').description('Fyipe SDK cli');
|
||||
program.command('server-monitor [options]', 'Fyipe Monitoring shell', {
|
||||
executableFile: './server-monitor/bin/index'
|
||||
});
|
||||
program.parse(process.argv);
|
||||
@@ -1,219 +0,0 @@
|
||||
[](https://www.npmjs.com/package/fyipe-server-monitor)
|
||||
|
||||
# Fyipe Server Monitor
|
||||
|
||||
A fyipe shell package that monitor's server resources - disk, memory and CPU percentage - used.
|
||||
|
||||
## Installation
|
||||
|
||||
You can install to use on the CLI:
|
||||
|
||||
```bash
|
||||
$ npm install -g fyipe-server-monitor
|
||||
```
|
||||
|
||||
You can install to use in your project:
|
||||
|
||||
```bash
|
||||
$ cd project
|
||||
$ npm install fyipe-server-monitor
|
||||
```
|
||||
|
||||
## CLI Usage
|
||||
|
||||
You can use on the CLI:
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor
|
||||
```
|
||||
|
||||
- Run `fyipe-server-monitor`.
|
||||
- Enter your Project ID, API URL, and API key - Get these from your Fyipe Dashboard.
|
||||
- Select Server Monitor from the list of Server Monitors.
|
||||
- Server will be pinged every minute and the data stored in your project.
|
||||
|
||||
You can also use it like this:
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --project-id 5d64d59cae46131619708309 --api-url https://fyipe.com/api --api-key b02798c0-c898-11e9-9f14-4963dc67e2ab --monitor-id 5d7775e9f14a531364ba6917
|
||||
```
|
||||
|
||||
Or run as a daemon (requires `sudo` or admin privileges):
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --daemon --project-id 5d64d59cae46131619708309 --api-url https://fyipe.com/api --api-key b02798c0-c898-11e9-9f14-4963dc67e2ab --monitor-id 5d7775e9f14a531364ba6917
|
||||
```
|
||||
|
||||
You can use the following commands with the daemon: `start`, `restart`, `stop`, and `uninstall`.
|
||||
|
||||
Run to start the stopped daemon (requires `sudo` or admin privileges):
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --daemon start
|
||||
```
|
||||
|
||||
Run to restart the running daemon (requires `sudo` or admin privileges):
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --daemon restart
|
||||
```
|
||||
|
||||
Run to stop the running daemon (requires `sudo` or admin privileges):
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --daemon stop
|
||||
```
|
||||
|
||||
Run to stop and uninstall the running daemon (requires `sudo` or admin privileges):
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --daemon uninstall
|
||||
```
|
||||
|
||||
Run to check for logs and errors:
|
||||
|
||||
```bash
|
||||
$ fyipe-server-monitor --daemon logs
|
||||
$ fyipe-server-monitor --daemon errors
|
||||
```
|
||||
|
||||
A complete log of the daemon can be found in these directories:
|
||||
|
||||
```bash
|
||||
# linux logs
|
||||
/var/log/Fyipe Server Monitor/fyipeservermonitor.log
|
||||
/var/log/Fyipe Server Monitor/fyipeservermonitor_error.log
|
||||
|
||||
# mac logs
|
||||
/Library/Logs/Fyipe Server Monitor/fyipeservermonitor.log
|
||||
/Library/Logs/Fyipe Server Monitor/fyipeservermonitor_error.log
|
||||
|
||||
# windows logs
|
||||
<service_path>/fyipeservermonitor.out.log
|
||||
<service_path>/fyipeservermonitor.err.log
|
||||
```
|
||||
|
||||
NB:- In most cases, `sudo` or admin privileges are required to run the shell as a daemon.
|
||||
|
||||
### Services
|
||||
|
||||
#### Linux
|
||||
|
||||
Services created by the daemon are like other services running on Linux. It can be started/stopped using `service fyipeservermonitor start` or `service fyipeservermonitor stop` and logs are available. This file is created in /etc/init.d by default. Additionally, log files are generated in /var/log/Fyipe Server Monitor/ for general output and error logging.
|
||||
|
||||
#### Mac
|
||||
|
||||
Services created by the daemon are similar to most other services running on OSX. It can be stopped from the Activity Monitor and make logs available in the Console app. A plist file is created in /Library/LaunchDaemons by default. Additionally, two log files are generated in /Library/Logs/Fyipe Server Monitor/ for general output and error logging.
|
||||
|
||||
#### Windows
|
||||
|
||||
Services created by the daemon are similar to most other services running on Windows. It can be started/stopped from the windows service utility, via NET START or NET STOP commands, or even managed using the sc utility. A directory called daemon is created and populated with fyipeservermonitor.exe and fyipeservermonitor.xml. The XML file is a configuration for the executable. Additionally, logs are created in this directory (which are viewable in the Event log).
|
||||
|
||||
<a name="module_api"></a>
|
||||
|
||||
## Programmatic Usage
|
||||
|
||||
```javascript
|
||||
const serverMonitor = require('fyipe-server-monitor');
|
||||
|
||||
const monitor = serverMonitor({
|
||||
projectId: '5d64d59cae46131619708309',
|
||||
// (optional) If you have installed Fyipe Platform on your server,
|
||||
// this should be your API URL
|
||||
apiUrl: 'https://fyipe.com/api',
|
||||
apiKey: 'b02798c0-c898-11e9-9f14-4963dc67e2ab',
|
||||
monitorId: '5d7775e9f14a531364ba6917',
|
||||
interval: '*/5 * * * * *', // cron job interval
|
||||
timeout: 10000, // milliseconds
|
||||
});
|
||||
|
||||
monitor.start();
|
||||
```
|
||||
|
||||
## Known Issues
|
||||
|
||||
#### Windows Temperature
|
||||
|
||||
`wmic` - is used to determine temperature and 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.
|
||||
|
||||
#### Linux Temperature
|
||||
|
||||
In some cases you may need to install the linux `sensors` package to be able to measure temperature e.g. on DEBIAN based systems run `sudo apt-get install lm-sensors`.
|
||||
|
||||
See [system information](https://www.npmjs.com/package/systeminformation#known-issues) to learn more.
|
||||
|
||||
## API Documentation
|
||||
|
||||
Main API to authenticate user, start and stop server monitoring.
|
||||
|
||||
**See**
|
||||
|
||||
- module:helpers
|
||||
- module:logger
|
||||
|
||||
**Author**: HackerBay, Inc.
|
||||
|
||||
- [Fyipe Server Monitor](#fyipe-server-monitor)
|
||||
- [Installation](#installation)
|
||||
- [CLI Usage](#cli-usage)
|
||||
- [Basic Usage](#basic-usage)
|
||||
- [API Documentation](#api-documentation)
|
||||
- [module.exports(config, apiUrl, apiKey, monitorId) ⇒ <code>Object</code> ⏏](#moduleexportsconfig-apiurl-apikey-monitorid--object-)
|
||||
- [module.exports~ping(projectId, monitorId, apiUrl, apiKey, interval) ⇒ <code>Object</code>](#moduleexportspingprojectid-monitorid-apiurl-apikey-interval--object)
|
||||
- [module.exports~start(id) ⇒ <code>Object</code> \| <code>number</code>](#moduleexportsstartid--object--number)
|
||||
- [module.exports~stop() ⇒ <code>Object</code>](#moduleexportsstop--object)
|
||||
|
||||
<a name="exp_module_api--module.exports"></a>
|
||||
|
||||
### module.exports(config, apiUrl, apiKey, monitorId) ⇒ <code>Object</code> ⏏
|
||||
|
||||
Authenticate user and get list of server monitors if monitor id not provided.
|
||||
|
||||
**Kind**: Exported function
|
||||
**Returns**: <code>Object</code> - The server monitor handlers.
|
||||
|
||||
| Param | Type | Description |
|
||||
| --------- | -------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| config | <code>string</code> \| <code>Object</code> | The project id or config of the project. |
|
||||
| apiUrl | <code>string</code> | The url of the api. |
|
||||
| apiKey | <code>string</code> | The api key of the project. |
|
||||
| monitorId | <code>string</code> \| <code>function</code> | The monitor id or function to resolve monitor id of the server monitor. |
|
||||
|
||||
<a name="module_api--module.exports..ping"></a>
|
||||
|
||||
#### module.exports~ping(projectId, monitorId, apiUrl, apiKey, interval) ⇒ <code>Object</code>
|
||||
|
||||
Get system information at interval and upload to server.
|
||||
|
||||
**Kind**: inner method of [<code>module.exports</code>](#exp_module_api--module.exports)
|
||||
**Returns**: <code>Object</code> - The ping server cron job.
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
| --------- | ------------------- | --------------------------------------- | ---------------------------------------------------------- |
|
||||
| projectId | <code>string</code> | | The project id of the project. |
|
||||
| monitorId | <code>string</code> | | The monitor id of the server monitor. |
|
||||
| apiUrl | <code>string</code> | | The url of the api. |
|
||||
| apiKey | <code>string</code> | | The api key of the project. |
|
||||
| interval | <code>string</code> | <code>"\* \* \* \* \*"</code> | The interval of the cron job, must ba a valid cron format. |
|
||||
|
||||
<a name="module_api--module.exports..start"></a>
|
||||
|
||||
#### module.exports~start(id) ⇒ <code>Object</code> \| <code>number</code>
|
||||
|
||||
Start server monitor.
|
||||
|
||||
**Kind**: inner method of [<code>module.exports</code>](#exp_module_api--module.exports)
|
||||
**Returns**: <code>Object</code> \| <code>number</code> - The ping server cron job or the error code.
|
||||
|
||||
| Param | Type | Description |
|
||||
| ----- | ------------------- | ------------------------------------- |
|
||||
| id | <code>string</code> | The monitor id of the server monitor. |
|
||||
|
||||
<a name="module_api--module.exports..stop"></a>
|
||||
|
||||
#### module.exports~stop() ⇒ <code>Object</code>
|
||||
|
||||
Stop server monitor.
|
||||
|
||||
**Kind**: inner method of [<code>module.exports</code>](#exp_module_api--module.exports)
|
||||
**Returns**: <code>Object</code> - The ping server cron job.
|
||||
@@ -1,240 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* @fileoverview Main CLI that is run via the fyipe-server-monitor command.
|
||||
* @author HackerBay, Inc.
|
||||
* @module server-monitor
|
||||
* @see module:api
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
||||
|
||||
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
|
||||
|
||||
var dotenv = require('dotenv');
|
||||
|
||||
dotenv.config();
|
||||
|
||||
var program = require('commander');
|
||||
|
||||
var Promise = require('promise');
|
||||
|
||||
var _require = require('../../../../package.json'),
|
||||
version = _require.version;
|
||||
|
||||
var _require2 = require('inquirer'),
|
||||
prompt = _require2.prompt;
|
||||
|
||||
var fs = require('fs');
|
||||
|
||||
var logger = require('../lib/logger');
|
||||
|
||||
var _require3 = require('../lib/config'),
|
||||
API_URL = _require3.API_URL,
|
||||
LOG_PATH = _require3.LOG_PATH;
|
||||
|
||||
var serverMonitor = require('../lib/api');
|
||||
|
||||
program.version(version, '-v, --version').description('Fyipe Monitoring Shell');
|
||||
program.name('server-monitor');
|
||||
program.option('-p, --project-id [projectId]', "Use Project ID from project's API settings").option('-u, --api-url [apiUrl]', "Use API URL from project's API settings").option('-a, --api-key [apiKey]', "Use API Key from project's API settings").option('-m, --monitor-id [monitorId]', 'Use Monitor ID from monitor details').option('-d, --daemon [daemon]', 'Run shell as a daemon').parse(process.argv);
|
||||
/** The questions to get project id, api url, api key and monitor id. */
|
||||
|
||||
var questions = [{
|
||||
type: 'input',
|
||||
name: 'projectId',
|
||||
message: 'What is your Project ID (You can find this by going to Project Settings > API)?'
|
||||
}, {
|
||||
type: 'input',
|
||||
name: 'apiUrl',
|
||||
message: 'What is your API URL (You can find this by going to Project Settings > API)?',
|
||||
"default": API_URL
|
||||
}, {
|
||||
type: 'input',
|
||||
name: 'apiKey',
|
||||
message: 'What is your API Key (You can find this by going to Project Settings > API)?'
|
||||
}, {
|
||||
type: 'list',
|
||||
name: 'monitorId',
|
||||
message: 'What is your Monitor ID?'
|
||||
}, {
|
||||
type: 'confirm',
|
||||
name: 'daemon',
|
||||
message: 'Want to run as a daemon?'
|
||||
}];
|
||||
/**
|
||||
* Check cli params.
|
||||
* @param {Array} params - The params or questions of the cli.
|
||||
* @return {Promise} The cli params promise.
|
||||
*/
|
||||
|
||||
var checkParams = function checkParams(params) {
|
||||
var values = [];
|
||||
return new Promise(function (resolve) {
|
||||
resolve(params.reduce(function (promiseChain, param) {
|
||||
return promiseChain.then(function () {
|
||||
return getParamValue(params, param.name).then(function (value) {
|
||||
values.push(value);
|
||||
return values;
|
||||
});
|
||||
});
|
||||
}, Promise.resolve()));
|
||||
});
|
||||
};
|
||||
/**
|
||||
* Get cli param value.
|
||||
* @param {Array} params - The params of the cli.
|
||||
* @param {string} name - The name of the cli param.
|
||||
* @return {Promise} The cli param value promise.
|
||||
*/
|
||||
|
||||
|
||||
var getParamValue = function getParamValue(params, name) {
|
||||
var options = program.opts();
|
||||
return new Promise(function (resolve) {
|
||||
if (options[name] === true || options[name] === undefined) {
|
||||
if (name === 'monitorId') {
|
||||
resolve(process.env[name] || null);
|
||||
} else if (name === 'daemon') {
|
||||
resolve(options[name] === true);
|
||||
} else {
|
||||
if (process.env[name]) {
|
||||
resolve(process.env[name]);
|
||||
} else {
|
||||
if (typeof options['daemon'] === 'string') {
|
||||
resolve(null);
|
||||
} else {
|
||||
prompt(params.filter(function (param) {
|
||||
return param.name === name;
|
||||
})).then(function (values) {
|
||||
resolve(values[name]);
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
resolve(options[name]);
|
||||
}
|
||||
});
|
||||
};
|
||||
/** Init server monitor cli. */
|
||||
|
||||
|
||||
checkParams(questions).then(function (values) {
|
||||
var _values = (0, _slicedToArray2["default"])(values, 5),
|
||||
projectId = _values[0],
|
||||
apiUrl = _values[1],
|
||||
apiKey = _values[2],
|
||||
monitorId = _values[3],
|
||||
daemon = _values[4];
|
||||
|
||||
if (daemon) {
|
||||
var os = require('os').platform();
|
||||
|
||||
var Service;
|
||||
|
||||
switch (os) {
|
||||
case 'linux':
|
||||
Service = require('node-linux').Service;
|
||||
break;
|
||||
|
||||
case 'darwin':
|
||||
Service = require('node-mac').Service;
|
||||
break;
|
||||
|
||||
case 'win32':
|
||||
Service = require('node-windows').Service;
|
||||
break;
|
||||
}
|
||||
|
||||
var svc = new Service({
|
||||
name: 'Fyipe Server Monitor',
|
||||
description: 'Fyipe Monitoring Shell',
|
||||
script: require('path').join(__dirname, 'server-monitor.js'),
|
||||
env: [{
|
||||
name: 'projectId',
|
||||
value: projectId
|
||||
}, {
|
||||
name: 'apiUrl',
|
||||
value: apiUrl
|
||||
}, {
|
||||
name: 'apiKey',
|
||||
value: apiKey
|
||||
}, {
|
||||
name: 'monitorId',
|
||||
value: monitorId
|
||||
}],
|
||||
wait: 2,
|
||||
grow: 0.5
|
||||
});
|
||||
svc.on('install', function () {
|
||||
logger.info('Fyipe Server Monitor daemon installed');
|
||||
svc.start();
|
||||
});
|
||||
svc.on('alreadyinstalled', function () {
|
||||
logger.warn('Fyipe Server Monitor daemon already installed');
|
||||
});
|
||||
svc.on('start', function () {
|
||||
logger.info('Fyipe Server Monitor daemon started');
|
||||
});
|
||||
svc.on('stop', function () {
|
||||
logger.info('Fyipe Server Monitor daemon stopped');
|
||||
});
|
||||
svc.on('uninstall', function () {
|
||||
logger.info('Fyipe Server Monitor uninstalled');
|
||||
});
|
||||
|
||||
if (daemon === 'errors') {
|
||||
logger.error(fs.readFileSync(LOG_PATH[os].error, {
|
||||
encoding: 'utf8',
|
||||
flag: 'r'
|
||||
}));
|
||||
} else if (daemon === 'logs') {
|
||||
logger.info(fs.readFileSync(LOG_PATH[os].log, {
|
||||
encoding: 'utf8',
|
||||
flag: 'r'
|
||||
}));
|
||||
} else if (daemon === 'uninstall') {
|
||||
svc.uninstall();
|
||||
} else if (daemon === 'stop') {
|
||||
svc.stop();
|
||||
} else if (daemon === 'restart') {
|
||||
svc.restart();
|
||||
} else if (daemon === 'start') {
|
||||
svc.start();
|
||||
} else if (projectId && apiUrl && apiKey && monitorId && (typeof daemon === 'boolean' || daemon === 'install')) {
|
||||
svc.install();
|
||||
} else if (!monitorId) {
|
||||
logger.error('Server Monitor ID is required');
|
||||
process.exitCode = 1;
|
||||
} else {
|
||||
logger.error('Please enter a valid command (start, restart, stop, uninstall)');
|
||||
process.exitCode = 1;
|
||||
}
|
||||
} else {
|
||||
serverMonitor({
|
||||
projectId: projectId,
|
||||
apiUrl: apiUrl,
|
||||
apiKey: apiKey,
|
||||
monitorId: monitorId || function (data) {
|
||||
return new Promise(function (resolve) {
|
||||
var question = questions.filter(function (param) {
|
||||
return param.name === 'monitorId';
|
||||
});
|
||||
question[0].choices = data.map(function (monitor) {
|
||||
return "".concat(monitor.componentId.name, " / ").concat(monitor.name, " (").concat(monitor._id, ")");
|
||||
});
|
||||
prompt(question).then(function (_ref) {
|
||||
var monitorId = _ref.monitorId;
|
||||
resolve(monitorId.replace(/\/|\(|\)$/gi, '').split(' ').pop());
|
||||
});
|
||||
});
|
||||
}
|
||||
}).start();
|
||||
}
|
||||
});
|
||||
module.exports = {
|
||||
checkParams: checkParams,
|
||||
getParamValue: getParamValue
|
||||
};
|
||||
@@ -1,236 +0,0 @@
|
||||
/**
|
||||
* @fileoverview Main API to authenticate user, start and stop server monitoring.
|
||||
* @author HackerBay, Inc.
|
||||
* @module api
|
||||
* @see module:helpers
|
||||
* @see module:logger
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
||||
|
||||
var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
|
||||
|
||||
var dotenv = require('dotenv');
|
||||
|
||||
dotenv.config();
|
||||
|
||||
var Promise = require('promise');
|
||||
|
||||
var cron = require('cron');
|
||||
|
||||
var si = require('systeminformation');
|
||||
|
||||
var _require = require('./helpers'),
|
||||
get = _require.get,
|
||||
post = _require.post;
|
||||
|
||||
var logger = require('./logger');
|
||||
|
||||
var _require2 = require('./config'),
|
||||
onlineTestData = _require2.onlineTestData,
|
||||
degradedTestData = _require2.degradedTestData,
|
||||
offlineTestData = _require2.offlineTestData;
|
||||
/**
|
||||
* Get system information at interval and upload to server.
|
||||
* @param {string} projectId - The project id of the project.
|
||||
* @param {string} monitorId - The monitor id of the server monitor.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} apiKey - The api key of the project.
|
||||
* @param {string} interval - The interval of the cron job, must ba a valid cron format.
|
||||
* @return {Object} The ping server cron job.
|
||||
*/
|
||||
|
||||
|
||||
var ping = function ping(projectId, monitorId, apiUrl, apiKey) {
|
||||
var interval = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : '* * * * *';
|
||||
var simulate = arguments.length > 5 ? arguments[5] : undefined;
|
||||
var simulateData = arguments.length > 6 ? arguments[6] : undefined;
|
||||
return new cron.CronJob(interval, function () {
|
||||
if ((0, _typeof2["default"])(simulateData) !== 'object') simulateData = null;
|
||||
|
||||
switch (simulate) {
|
||||
case 'online':
|
||||
try {
|
||||
post(apiUrl, "monitor/".concat(projectId, "/log/").concat(monitorId), simulateData || onlineTestData, apiKey, function (log) {
|
||||
logger.debug(log.data);
|
||||
logger.info("".concat(monitorId, " - System Information uploaded"));
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
case 'degraded':
|
||||
try {
|
||||
post(apiUrl, "monitor/".concat(projectId, "/log/").concat(monitorId), simulateData || degradedTestData, apiKey, function (log) {
|
||||
logger.debug(log.data);
|
||||
logger.info("".concat(monitorId, " - System Information uploaded"));
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
case 'offline':
|
||||
try {
|
||||
post(apiUrl, "monitor/".concat(projectId, "/log/").concat(monitorId), simulateData || offlineTestData, apiKey, function (log) {
|
||||
logger.debug(log.data);
|
||||
logger.info("".concat(monitorId, " - System Information uploaded"));
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
default:
|
||||
Promise.all([si.currentLoad(), si.mem(), si.fsSize(), si.cpuTemperature(), si.cpu()]).then(function (data) {
|
||||
var storage = data[2] && data[2].length > 0 ? data[2].filter(function (partition) {
|
||||
return partition.size === data[2][0].size;
|
||||
}) : data[2];
|
||||
return {
|
||||
cpuLoad: data[0].currentLoad,
|
||||
avgCpuLoad: data[0].avgLoad * 100,
|
||||
cpuCores: data[4].physicalCores,
|
||||
memoryUsed: data[1].active,
|
||||
totalMemory: data[1].total,
|
||||
swapUsed: data[1].swapused,
|
||||
storageUsed: storage && storage.length > 0 ? storage.map(function (partition) {
|
||||
return partition.used;
|
||||
}).reduce(function (used, partitionUsed) {
|
||||
return used + partitionUsed;
|
||||
}) : storage.used,
|
||||
totalStorage: storage && storage.length > 0 ? storage[0].size : storage.size,
|
||||
storageUsage: storage && storage.length > 0 ? storage.map(function (partition) {
|
||||
return partition.use;
|
||||
}).reduce(function (use, partitionUse) {
|
||||
return use + partitionUse;
|
||||
}) : storage.use,
|
||||
mainTemp: data[3].main,
|
||||
maxTemp: data[3].max
|
||||
};
|
||||
}).then(function (data) {
|
||||
post(apiUrl, "monitor/".concat(projectId, "/log/").concat(monitorId), data, apiKey, function (log) {
|
||||
logger.debug(log.data);
|
||||
logger.info("".concat(monitorId, " - System Information uploaded"));
|
||||
}, function (error) {
|
||||
return logger.error(error);
|
||||
});
|
||||
})["catch"](function (error) {
|
||||
logger.error(error);
|
||||
});
|
||||
}
|
||||
}, null, false);
|
||||
};
|
||||
/**
|
||||
* Authenticate user and get list of server monitors if monitor id not provided.
|
||||
* @param {(string | Object)} config - The project id or config of the project.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} apiKey - The api key of the project.
|
||||
* @param {(string | Function)} monitorId - The monitor id or function to resolve monitor id of the server monitor.
|
||||
* @return {Object} The server monitor handlers.
|
||||
*/
|
||||
|
||||
|
||||
module.exports = function (config, apiUrl, apiKey, monitorId) {
|
||||
var pingServer,
|
||||
projectId = config,
|
||||
interval,
|
||||
timeout,
|
||||
simulate,
|
||||
simulateData;
|
||||
|
||||
if ((0, _typeof2["default"])(config) === 'object') {
|
||||
projectId = config.projectId;
|
||||
apiUrl = config.apiUrl;
|
||||
apiKey = config.apiKey;
|
||||
monitorId = config.monitorId;
|
||||
interval = config.interval;
|
||||
timeout = config.timeout;
|
||||
simulate = config.simulate;
|
||||
simulateData = config.simulateData;
|
||||
}
|
||||
|
||||
return {
|
||||
/**
|
||||
* Start server monitor.
|
||||
* @param {string} id - The monitor id of the server monitor.
|
||||
* @return {(Object | number)} The ping server cron job or the error code.
|
||||
*/
|
||||
start: function start() {
|
||||
var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : monitorId;
|
||||
var url = "monitor/".concat(projectId, "/monitor/").concat(id && typeof id === 'string' ? "".concat(id, "/") : '', "?type=server-monitor");
|
||||
return get(apiUrl, url, apiKey, function (response) {
|
||||
return new Promise(function (resolve, reject) {
|
||||
var data = response.data;
|
||||
|
||||
if (data && data !== null) {
|
||||
if (id && typeof id === 'string') {
|
||||
resolve(data._id);
|
||||
} else {
|
||||
if (data.data !== null && data.data.length > 0) {
|
||||
if (data.count === 1) {
|
||||
logger.info('Using default Server Monitor...');
|
||||
resolve(data.data[0]._id);
|
||||
} else {
|
||||
if (id && typeof id === 'function') {
|
||||
resolve(id(data.data));
|
||||
} else {
|
||||
logger.error('Server Monitor ID is required');
|
||||
reject(1);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
logger.error('No Server Monitor found');
|
||||
reject(0);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
logger.error('No Server Monitor found');
|
||||
reject(0);
|
||||
}
|
||||
});
|
||||
}).then(function (monitorId) {
|
||||
return new Promise(function (resolve, reject) {
|
||||
if (monitorId) {
|
||||
logger.info('Starting Server Monitor...');
|
||||
pingServer = ping(projectId, monitorId, apiUrl, apiKey, interval, simulate, simulateData);
|
||||
pingServer.start();
|
||||
|
||||
if (timeout) {
|
||||
setTimeout(function () {
|
||||
logger.info('Stopping Server Monitor...');
|
||||
pingServer.stop();
|
||||
}, timeout);
|
||||
}
|
||||
|
||||
resolve(pingServer);
|
||||
} else {
|
||||
logger.error('Server Monitor ID is required');
|
||||
reject(1);
|
||||
}
|
||||
});
|
||||
})["catch"](function (error) {
|
||||
if (typeof error !== 'number') logger.error(error);
|
||||
var errorCode = typeof error === 'number' ? error : 1;
|
||||
process.exitCode = errorCode;
|
||||
return error;
|
||||
});
|
||||
},
|
||||
|
||||
/** Stop server monitor.
|
||||
* @return {Object} The ping server cron job.
|
||||
*/
|
||||
stop: function stop() {
|
||||
if (pingServer) {
|
||||
logger.info('Stopping Server Monitor...');
|
||||
pingServer.stop();
|
||||
}
|
||||
|
||||
return pingServer;
|
||||
}
|
||||
};
|
||||
};
|
||||
@@ -1,72 +0,0 @@
|
||||
/**
|
||||
* @fileoverview Main application config module.
|
||||
* @author HackerBay, Inc.
|
||||
* @module config
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
var path = require('path');
|
||||
/** The api url to send server information. */
|
||||
|
||||
|
||||
var API_URL = process.env.API_URL || (process.env.NODE_ENV === 'development' ? 'http://localhost:3002' : 'https://fyipe.com/api');
|
||||
var onlineTestData = {
|
||||
cpuLoad: 10.451510774011686,
|
||||
avgCpuLoad: 27,
|
||||
cpuCores: 4,
|
||||
memoryUsed: 2513182720,
|
||||
totalMemory: 8589934592,
|
||||
swapUsed: 1800142848,
|
||||
storageUsed: 183032516608,
|
||||
totalStorage: 250685575168,
|
||||
storageUsage: 73.00999999999999,
|
||||
mainTemp: 59.5,
|
||||
maxTemp: 60
|
||||
};
|
||||
var degradedTestData = {
|
||||
cpuLoad: 11.577671931143978,
|
||||
avgCpuLoad: 27,
|
||||
cpuCores: 4,
|
||||
memoryUsed: 2829381632,
|
||||
totalMemory: 8589934592,
|
||||
swapUsed: 2446589952,
|
||||
storageUsed: 243169382400,
|
||||
totalStorage: 250685575168,
|
||||
storageUsage: 97.0017450095,
|
||||
mainTemp: 62,
|
||||
maxTemp: 63
|
||||
};
|
||||
var offlineTestData = {
|
||||
cpuLoad: 0,
|
||||
avgCpuLoad: 0,
|
||||
cpuCores: 0,
|
||||
memoryUsed: 0,
|
||||
totalMemory: 0,
|
||||
swapUsed: 0,
|
||||
storageUsed: 0,
|
||||
totalStorage: 0,
|
||||
storageUsage: 0,
|
||||
mainTemp: 0,
|
||||
maxTemp: 0
|
||||
};
|
||||
var LOG_PATH = {
|
||||
linux: {
|
||||
log: '/var/log/Fyipe Server Monitor/fyipeservermonitor.log',
|
||||
error: '/var/log/Fyipe Server Monitor/fyipeservermonitor_error.log'
|
||||
},
|
||||
darwin: {
|
||||
log: '/Library/Logs/Fyipe Server Monitor/fyipeservermonitor.log',
|
||||
error: '/Library/Logs/Fyipe Server Monitor/fyipeservermonitor_error.log'
|
||||
},
|
||||
win32: {
|
||||
log: path.join(__dirname, 'fyipeservermonitor.out.log'),
|
||||
error: path.join(__dirname, 'fyipeservermonitor.err.log')
|
||||
}
|
||||
};
|
||||
module.exports = {
|
||||
API_URL: API_URL,
|
||||
LOG_PATH: LOG_PATH,
|
||||
onlineTestData: onlineTestData,
|
||||
degradedTestData: degradedTestData,
|
||||
offlineTestData: offlineTestData
|
||||
};
|
||||
@@ -1,92 +0,0 @@
|
||||
/**
|
||||
* @fileoverview HTTP wrapper functions module.
|
||||
* @author HackerBay, Inc.
|
||||
* @module helpers
|
||||
* @see module:config
|
||||
* @see module:logger
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
var axios = require('axios');
|
||||
|
||||
var _require = require('./config'),
|
||||
API_URL = _require.API_URL;
|
||||
|
||||
var logger = require('./logger');
|
||||
/** The request headers. */
|
||||
|
||||
|
||||
var headers = {
|
||||
'Content-Type': 'application/json'
|
||||
};
|
||||
/** Handle request error.
|
||||
* @param {Object} - The error object of the request.
|
||||
* @default
|
||||
*/
|
||||
|
||||
var defaultErrorHandler = function defaultErrorHandler(error) {
|
||||
logger.debug(error.config);
|
||||
|
||||
if (error.response) {
|
||||
logger.debug(error.response.data);
|
||||
logger.debug(error.response.status);
|
||||
logger.debug(error.response.headers);
|
||||
throw error.response.data;
|
||||
} else {
|
||||
if (error.request) {
|
||||
logger.debug(error.request);
|
||||
} else {
|
||||
logger.debug('Error', error.message);
|
||||
}
|
||||
}
|
||||
|
||||
throw error;
|
||||
};
|
||||
/**
|
||||
* Get request data with axios.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} url - The endpoint of the request.
|
||||
* @param {string} key - The api key of the endpoint.
|
||||
* @param {Function} success - The request success callback.
|
||||
* @param {Function} error - The request error callback.
|
||||
* @return {Promise} The request promise.
|
||||
*/
|
||||
|
||||
|
||||
var get = function get(apiUrl, url, key, success) {
|
||||
var error = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : defaultErrorHandler;
|
||||
headers['apiKey'] = key;
|
||||
return axios({
|
||||
method: 'get',
|
||||
url: "".concat(apiUrl || API_URL, "/").concat(url),
|
||||
headers: headers
|
||||
}).then(success, error);
|
||||
};
|
||||
/**
|
||||
* Post request data with axios.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} url - The endpoint of the request.
|
||||
* @param {Object} data - The data of endpoint.
|
||||
* @param {string} key - The api key of the endpoint.
|
||||
* @param {Function} success - The request success callback.
|
||||
* @param {Function} error - The request error callback.
|
||||
* @return {Promise} The request promise.
|
||||
*/
|
||||
|
||||
|
||||
var post = function post(apiUrl, url, data, key, success) {
|
||||
var error = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : defaultErrorHandler;
|
||||
headers['apiKey'] = key;
|
||||
return axios({
|
||||
method: 'post',
|
||||
url: "".concat(apiUrl || API_URL, "/").concat(url),
|
||||
headers: headers,
|
||||
data: data
|
||||
}).then(success, error);
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
get: get,
|
||||
post: post,
|
||||
defaultErrorHandler: defaultErrorHandler
|
||||
};
|
||||
@@ -1,19 +0,0 @@
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
* @fileoverview Default message and error logger service.
|
||||
* @author HackerBay, Inc.
|
||||
* @module logger
|
||||
*/
|
||||
var pino = require('pino');
|
||||
/** The logger service. */
|
||||
|
||||
|
||||
var logger = pino({
|
||||
level: process.env.LOG_LEVEL || 'info',
|
||||
prettyPrint: {
|
||||
colorize: true,
|
||||
translateTime: true
|
||||
}
|
||||
});
|
||||
module.exports = logger;
|
||||
@@ -1,325 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Source: bin/server-monitor.js</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Source: bin/server-monitor.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* @fileoverview Main CLI that is run via the fyipe-server-monitor command.
|
||||
* @author HackerBay, Inc.
|
||||
* @module server-monitor
|
||||
* @see module:api
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
const dotenv = require('dotenv');
|
||||
dotenv.config();
|
||||
|
||||
const program = require('commander');
|
||||
const Promise = require('promise');
|
||||
const { version } = require('../package.json');
|
||||
const { prompt } = require('inquirer');
|
||||
const fs = require('fs');
|
||||
const logger = require('../lib/logger');
|
||||
const { API_URL, LOG_PATH } = require('../lib/config');
|
||||
const serverMonitor = require('../lib/api');
|
||||
|
||||
program.version(version, '-v, --version').description('Fyipe Monitoring Shell');
|
||||
|
||||
program
|
||||
.option(
|
||||
'-p, --project-id [projectId]',
|
||||
"Use Project ID from project's API settings"
|
||||
)
|
||||
.option('-u, --api-url [apiUrl]', "Use API URL from project's API settings")
|
||||
.option('-a, --api-key [apiKey]', "Use API Key from project's API settings")
|
||||
.option(
|
||||
'-m, --monitor-id [monitorId]',
|
||||
'Use Monitor ID from monitor details'
|
||||
)
|
||||
.option('-d, --daemon [daemon]', 'Run shell as a daemon')
|
||||
.parse(process.argv);
|
||||
|
||||
/** The questions to get project id, api url, api key and monitor id. */
|
||||
const questions = [
|
||||
{
|
||||
type: 'input',
|
||||
name: 'projectId',
|
||||
message:
|
||||
'What is your Project ID (You can find this by going to Project Settings > API)?',
|
||||
},
|
||||
{
|
||||
type: 'input',
|
||||
name: 'apiUrl',
|
||||
message:
|
||||
'What is your API URL (You can find this by going to Project Settings > API)?',
|
||||
default: API_URL,
|
||||
},
|
||||
{
|
||||
type: 'input',
|
||||
name: 'apiKey',
|
||||
message:
|
||||
'What is your API Key (You can find this by going to Project Settings > API)?',
|
||||
},
|
||||
{
|
||||
type: 'list',
|
||||
name: 'monitorId',
|
||||
message: 'What is your Monitor ID?',
|
||||
},
|
||||
{
|
||||
type: 'confirm',
|
||||
name: 'daemon',
|
||||
message: 'Want to run as a daemon?',
|
||||
},
|
||||
];
|
||||
|
||||
/**
|
||||
* Check cli params.
|
||||
* @param {Array} params - The params or questions of the cli.
|
||||
* @return {Promise} The cli params promise.
|
||||
*/
|
||||
const checkParams = params => {
|
||||
const values = [];
|
||||
|
||||
return new Promise(resolve => {
|
||||
resolve(
|
||||
params.reduce(
|
||||
(promiseChain, param) =>
|
||||
promiseChain.then(() =>
|
||||
getParamValue(params, param.name).then(value => {
|
||||
values.push(value);
|
||||
|
||||
return values;
|
||||
})
|
||||
),
|
||||
Promise.resolve()
|
||||
)
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Get cli param value.
|
||||
* @param {Array} params - The params of the cli.
|
||||
* @param {string} name - The name of the cli param.
|
||||
* @return {Promise} The cli param value promise.
|
||||
*/
|
||||
const getParamValue = (params, name) => {
|
||||
return new Promise(resolve => {
|
||||
if (program[name] === true || program[name] === undefined) {
|
||||
if (name === 'monitorId') {
|
||||
resolve(process.env[name] || null);
|
||||
} else if (name === 'daemon') {
|
||||
resolve(program[name] === true);
|
||||
} else {
|
||||
if (process.env[name]) {
|
||||
resolve(process.env[name]);
|
||||
} else {
|
||||
if (typeof program['daemon'] === 'string') {
|
||||
resolve(null);
|
||||
} else {
|
||||
prompt(
|
||||
params.filter(param => param.name === name)
|
||||
).then(values => {
|
||||
resolve(values[name]);
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
resolve(program[name]);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
/** Init server monitor cli. */
|
||||
checkParams(questions).then(values => {
|
||||
const [projectId, apiUrl, apiKey, monitorId, daemon] = values;
|
||||
|
||||
if (daemon) {
|
||||
const os = require('os').platform();
|
||||
|
||||
let Service;
|
||||
switch (os) {
|
||||
case 'linux':
|
||||
Service = require('node-linux').Service;
|
||||
break;
|
||||
case 'darwin':
|
||||
Service = require('node-mac').Service;
|
||||
break;
|
||||
case 'win32':
|
||||
Service = require('node-windows').Service;
|
||||
break;
|
||||
}
|
||||
|
||||
const svc = new Service({
|
||||
name: 'Fyipe Server Monitor',
|
||||
description: 'Fyipe Monitoring Shell',
|
||||
script: require('path').join(__dirname, 'server-monitor.js'),
|
||||
env: [
|
||||
{
|
||||
name: 'projectId',
|
||||
value: projectId,
|
||||
},
|
||||
{
|
||||
name: 'apiUrl',
|
||||
value: apiUrl,
|
||||
},
|
||||
{
|
||||
name: 'apiKey',
|
||||
value: apiKey,
|
||||
},
|
||||
{
|
||||
name: 'monitorId',
|
||||
value: monitorId,
|
||||
},
|
||||
],
|
||||
wait: 2,
|
||||
grow: 0.5,
|
||||
});
|
||||
|
||||
svc.on('install', function() {
|
||||
logger.info('Fyipe Server Monitor daemon installed');
|
||||
svc.start();
|
||||
});
|
||||
|
||||
svc.on('alreadyinstalled', function() {
|
||||
logger.warn('Fyipe Server Monitor daemon already installed');
|
||||
});
|
||||
|
||||
svc.on('start', function() {
|
||||
logger.info('Fyipe Server Monitor daemon started');
|
||||
});
|
||||
|
||||
svc.on('stop', function() {
|
||||
logger.info('Fyipe Server Monitor daemon stopped');
|
||||
});
|
||||
|
||||
svc.on('uninstall', function() {
|
||||
logger.info('Fyipe Server Monitor uninstalled');
|
||||
});
|
||||
|
||||
if (daemon === 'errors') {
|
||||
logger.error(
|
||||
fs.readFileSync(LOG_PATH[os].error, {
|
||||
encoding: 'utf8',
|
||||
flag: 'r',
|
||||
})
|
||||
);
|
||||
} else if (daemon === 'logs') {
|
||||
logger.info(
|
||||
fs.readFileSync(LOG_PATH[os].log, {
|
||||
encoding: 'utf8',
|
||||
flag: 'r',
|
||||
})
|
||||
);
|
||||
} else if (daemon === 'uninstall') {
|
||||
svc.uninstall();
|
||||
} else if (daemon === 'stop') {
|
||||
svc.stop();
|
||||
} else if (daemon === 'restart') {
|
||||
svc.restart();
|
||||
} else if (daemon === 'start') {
|
||||
svc.start();
|
||||
} else if (
|
||||
projectId &&
|
||||
apiUrl &&
|
||||
apiKey &&
|
||||
monitorId &&
|
||||
(typeof daemon === 'boolean' || daemon === 'install')
|
||||
) {
|
||||
svc.install();
|
||||
} else if (!monitorId) {
|
||||
logger.error('Server Monitor ID is required');
|
||||
|
||||
process.exitCode = 1;
|
||||
} else {
|
||||
logger.error(
|
||||
'Please enter a valid command (start, restart, stop, uninstall)'
|
||||
);
|
||||
|
||||
process.exitCode = 1;
|
||||
}
|
||||
} else {
|
||||
serverMonitor({
|
||||
projectId,
|
||||
apiUrl,
|
||||
apiKey,
|
||||
monitorId:
|
||||
monitorId ||
|
||||
(data => {
|
||||
return new Promise(resolve => {
|
||||
const question = questions.filter(
|
||||
param => param.name === 'monitorId'
|
||||
);
|
||||
question[0].choices = data.map(
|
||||
monitor =>
|
||||
`${monitor.componentId.name} / ${monitor.name} (${monitor._id})`
|
||||
);
|
||||
|
||||
prompt(question).then(({ monitorId }) => {
|
||||
resolve(
|
||||
monitorId
|
||||
.replace(/\/|\(|\)$/gi, '')
|
||||
.split(' ')
|
||||
.pop()
|
||||
);
|
||||
});
|
||||
});
|
||||
}),
|
||||
}).start();
|
||||
}
|
||||
});
|
||||
|
||||
module.exports = {
|
||||
checkParams,
|
||||
getParamValue,
|
||||
};
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 116 KiB |
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 118 KiB |
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 120 KiB |
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 114 KiB |
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 120 KiB |
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 117 KiB |
Binary file not shown.
@@ -1,293 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Home</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Home</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3> </h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article><p><a href="https://www.npmjs.com/package/fyipe-server-monitor"><img src="https://img.shields.io/npm/v/fyipe-server-monitor" alt="npm"></a></p>
|
||||
<h1>Fyipe Server Monitor</h1>
|
||||
<p>A fyipe shell package that monitor's server resources - disk, memory and CPU percentage - used.</p>
|
||||
<h2>Installation</h2>
|
||||
<p>You can install to use on the CLI:</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ npm install -g fyipe-server-monitor
|
||||
</code></pre>
|
||||
<p>You can install to use in your project:</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ cd project
|
||||
$ npm install fyipe-server-monitor
|
||||
</code></pre>
|
||||
<h2>CLI Usage</h2>
|
||||
<p>You can use on the CLI:</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor
|
||||
</code></pre>
|
||||
<ul>
|
||||
<li>Run <code>fyipe-server-monitor</code>.</li>
|
||||
<li>Enter your Project ID, API URL, and API key - Get these from your Fyipe Dashboard.</li>
|
||||
<li>Select Server Monitor from the list of Server Monitors.</li>
|
||||
<li>Server will be pinged every minute and the data stored in your project.</li>
|
||||
</ul>
|
||||
<p>You can also use it like this:</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --project-id 5d64d59cae46131619708309 --api-url https://fyipe.com/api --api-key b02798c0-c898-11e9-9f14-4963dc67e2ab --monitor-id 5d7775e9f14a531364ba6917
|
||||
</code></pre>
|
||||
<p>Or run as a daemon (requires <code>sudo</code> or admin privileges):</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --daemon --project-id 5d64d59cae46131619708309 --api-url https://fyipe.com/api --api-key b02798c0-c898-11e9-9f14-4963dc67e2ab --monitor-id 5d7775e9f14a531364ba6917
|
||||
</code></pre>
|
||||
<p>You can use the following commands with the daemon: <code>start</code>, <code>restart</code>, <code>stop</code>, and <code>uninstall</code>.</p>
|
||||
<p>Run to start the stopped daemon (requires <code>sudo</code> or admin privileges):</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --daemon start
|
||||
</code></pre>
|
||||
<p>Run to restart the running daemon (requires <code>sudo</code> or admin privileges):</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --daemon restart
|
||||
</code></pre>
|
||||
<p>Run to stop the running daemon (requires <code>sudo</code> or admin privileges):</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --daemon stop
|
||||
</code></pre>
|
||||
<p>Run to stop and uninstall the running daemon (requires <code>sudo</code> or admin privileges):</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --daemon uninstall
|
||||
</code></pre>
|
||||
<p>Run to check for logs and errors:</p>
|
||||
<pre class="prettyprint source lang-bash"><code>$ fyipe-server-monitor --daemon logs
|
||||
$ fyipe-server-monitor --daemon errors
|
||||
</code></pre>
|
||||
<p>A complete log of the daemon can be found in these directories:</p>
|
||||
<pre class="prettyprint source lang-bash"><code># linux logs
|
||||
/var/log/Fyipe Server Monitor/fyipeservermonitor.log
|
||||
/var/log/Fyipe Server Monitor/fyipeservermonitor_error.log
|
||||
|
||||
# mac logs
|
||||
/Library/Logs/Fyipe Server Monitor/fyipeservermonitor.log
|
||||
/Library/Logs/Fyipe Server Monitor/fyipeservermonitor_error.log
|
||||
|
||||
# windows logs
|
||||
<service_path>/fyipeservermonitor.out.log
|
||||
<service_path>/fyipeservermonitor.err.log
|
||||
</code></pre>
|
||||
<p>NB:- In most cases, <code>sudo</code> or admin privileges are required to run the shell as a daemon.</p>
|
||||
<h3>Services</h3>
|
||||
<h4>Linux</h4>
|
||||
<p>Services created by the daemon are like other services running on Linux. It can be started/stopped using <code>service fyipeservermonitor start</code> or <code>service fyipeservermonitor stop</code> and logs are available. This file is created in /etc/init.d by default. Additionally, log files are generated in /var/log/Fyipe Server Monitor/ for general output and error logging.</p>
|
||||
<h4>Mac</h4>
|
||||
<p>Services created by the daemon are similar to most other services running on OSX. It can be stopped from the Activity Monitor and make logs available in the Console app. A plist file is created in /Library/LaunchDaemons by default. Additionally, two log files are generated in /Library/Logs/Fyipe Server Monitor/ for general output and error logging.</p>
|
||||
<h4>Windows</h4>
|
||||
<p>Services created by the daemon are similar to most other services running on Windows. It can be started/stopped from the windows service utility, via NET START or NET STOP commands, or even managed using the sc utility. A directory called daemon is created and populated with fyipeservermonitor.exe and fyipeservermonitor.xml. The XML file is a configuration for the executable. Additionally, logs are created in this directory (which are viewable in the Event log).</p>
|
||||
<p><a name="module_api"></a></p>
|
||||
<h2>Programmatic Usage</h2>
|
||||
<pre class="prettyprint source lang-javascript"><code>const serverMonitor = require('fyipe-server-monitor');
|
||||
|
||||
const monitor = serverMonitor({
|
||||
projectId: '5d64d59cae46131619708309',
|
||||
// (optional) If you have installed Fyipe Platform on your server,
|
||||
// this should be your API URL
|
||||
apiUrl: 'https://fyipe.com/api',
|
||||
apiKey: 'b02798c0-c898-11e9-9f14-4963dc67e2ab',
|
||||
monitorId: '5d7775e9f14a531364ba6917',
|
||||
interval: '*/5 * * * * *', // cron job interval
|
||||
timeout: 10000, // milliseconds
|
||||
});
|
||||
|
||||
monitor.start();
|
||||
</code></pre>
|
||||
<h2>Known Issues</h2>
|
||||
<h4>Windows Temperature</h4>
|
||||
<p><code>wmic</code> - is used to determine temperature and 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.</p>
|
||||
<h4>Linux Temperature</h4>
|
||||
<p>In some cases you may need to install the linux <code>sensors</code> package to be able to measure temperature e.g. on DEBIAN based systems run <code>sudo apt-get install lm-sensors</code>.</p>
|
||||
<p>See <a href="https://www.npmjs.com/package/systeminformation#known-issues">system information</a> to learn more.</p>
|
||||
<h2>API Documentation</h2>
|
||||
<p>Main API to authenticate user, start and stop server monitoring.</p>
|
||||
<p><strong>See</strong></p>
|
||||
<ul>
|
||||
<li>module:helpers</li>
|
||||
<li>module:logger</li>
|
||||
</ul>
|
||||
<p><strong>Author</strong>: HackerBay, Inc.</p>
|
||||
<ul>
|
||||
<li><a href="#fyipe-server-monitor">Fyipe Server Monitor</a>
|
||||
<ul>
|
||||
<li><a href="#installation">Installation</a></li>
|
||||
<li><a href="#cli-usage">CLI Usage</a></li>
|
||||
<li><a href="#basic-usage">Basic Usage</a></li>
|
||||
<li><a href="#api-documentation">API Documentation</a>
|
||||
<ul>
|
||||
<li><a href="#moduleexportsconfig-apiurl-apikey-monitorid--object-">module.exports(config, apiUrl, apiKey, monitorId) ⇒ <code>Object</code> ⏏</a>
|
||||
<ul>
|
||||
<li><a href="#moduleexportspingprojectid-monitorid-apiurl-apikey-interval--object">module.exports~ping(projectId, monitorId, apiUrl, apiKey, interval) ⇒ <code>Object</code></a></li>
|
||||
<li><a href="#moduleexportsstartid--object--number">module.exports~start(id) ⇒ <code>Object</code> | <code>number</code></a></li>
|
||||
<li><a href="#moduleexportsstop--object">module.exports~stop() ⇒ <code>Object</code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p><a name="exp_module_api--module.exports"></a></p>
|
||||
<h3>module.exports(config, apiUrl, apiKey, monitorId) ⇒ <code>Object</code> ⏏</h3>
|
||||
<p>Authenticate user and get list of server monitors if monitor id not provided.</p>
|
||||
<p><strong>Kind</strong>: Exported function
|
||||
<strong>Returns</strong>: <code>Object</code> - The server monitor handlers.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>config</td>
|
||||
<td><code>string</code> | <code>Object</code></td>
|
||||
<td>The project id or config of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>apiUrl</td>
|
||||
<td><code>string</code></td>
|
||||
<td>The url of the api.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>apiKey</td>
|
||||
<td><code>string</code></td>
|
||||
<td>The api key of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>monitorId</td>
|
||||
<td><code>string</code> | <code>function</code></td>
|
||||
<td>The monitor id or function to resolve monitor id of the server monitor.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><a name="module_api--module.exports..ping"></a></p>
|
||||
<h4>module.exports~ping(projectId, monitorId, apiUrl, apiKey, interval) ⇒ <code>Object</code></h4>
|
||||
<p>Get system information at interval and upload to server.</p>
|
||||
<p><strong>Kind</strong>: inner method of <a href="#exp_module_api--module.exports"><code>module.exports</code></a>
|
||||
<strong>Returns</strong>: <code>Object</code> - The ping server cron job.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>projectId</td>
|
||||
<td><code>string</code></td>
|
||||
<td></td>
|
||||
<td>The project id of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>monitorId</td>
|
||||
<td><code>string</code></td>
|
||||
<td></td>
|
||||
<td>The monitor id of the server monitor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>apiUrl</td>
|
||||
<td><code>string</code></td>
|
||||
<td></td>
|
||||
<td>The url of the api.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>apiKey</td>
|
||||
<td><code>string</code></td>
|
||||
<td></td>
|
||||
<td>The api key of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>interval</td>
|
||||
<td><code>string</code></td>
|
||||
<td><code>"* * * * *"</code></td>
|
||||
<td>The interval of the cron job, must ba a valid cron format.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><a name="module_api--module.exports..start"></a></p>
|
||||
<h4>module.exports~start(id) ⇒ <code>Object</code> | <code>number</code></h4>
|
||||
<p>Start server monitor.</p>
|
||||
<p><strong>Kind</strong>: inner method of <a href="#exp_module_api--module.exports"><code>module.exports</code></a>
|
||||
<strong>Returns</strong>: <code>Object</code> | <code>number</code> - The ping server cron job or the error code.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td><code>string</code></td>
|
||||
<td>The monitor id of the server monitor.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><a name="module_api--module.exports..stop"></a></p>
|
||||
<h4>module.exports~stop() ⇒ <code>Object</code></h4>
|
||||
<p>Stop server monitor.</p>
|
||||
<p><strong>Kind</strong>: inner method of <a href="#exp_module_api--module.exports"><code>module.exports</code></a>
|
||||
<strong>Returns</strong>: <code>Object</code> - The ping server cron job.</p></article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,350 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Source: lib/api.js</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Source: lib/api.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>/**
|
||||
* @fileoverview Main API to authenticate user, start and stop server monitoring.
|
||||
* @author HackerBay, Inc.
|
||||
* @module api
|
||||
* @see module:helpers
|
||||
* @see module:logger
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
const dotenv = require('dotenv');
|
||||
dotenv.config();
|
||||
|
||||
const Promise = require('promise');
|
||||
const cron = require('cron');
|
||||
const si = require('systeminformation');
|
||||
const { get, post } = require('./helpers');
|
||||
const logger = require('./logger');
|
||||
const {
|
||||
onlineTestData,
|
||||
degradedTestData,
|
||||
offlineTestData,
|
||||
} = require('./config');
|
||||
|
||||
/**
|
||||
* Get system information at interval and upload to server.
|
||||
* @param {string} projectId - The project id of the project.
|
||||
* @param {string} monitorId - The monitor id of the server monitor.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} apiKey - The api key of the project.
|
||||
* @param {string} interval - The interval of the cron job, must ba a valid cron format.
|
||||
* @return {Object} The ping server cron job.
|
||||
*/
|
||||
const ping = (
|
||||
projectId,
|
||||
monitorId,
|
||||
apiUrl,
|
||||
apiKey,
|
||||
interval = '* * * * *',
|
||||
simulate,
|
||||
simulateData
|
||||
) => {
|
||||
return new cron.CronJob(
|
||||
interval,
|
||||
() => {
|
||||
if (typeof simulateData !== 'object') simulateData = null;
|
||||
|
||||
switch (simulate) {
|
||||
case 'online':
|
||||
try {
|
||||
post(
|
||||
apiUrl,
|
||||
`monitor/${projectId}/log/${monitorId}`,
|
||||
simulateData || onlineTestData,
|
||||
apiKey,
|
||||
log => {
|
||||
logger.debug(log.data);
|
||||
logger.info(
|
||||
`${monitorId} - System Information uploaded`
|
||||
);
|
||||
}
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
}
|
||||
break;
|
||||
case 'degraded':
|
||||
try {
|
||||
post(
|
||||
apiUrl,
|
||||
`monitor/${projectId}/log/${monitorId}`,
|
||||
simulateData || degradedTestData,
|
||||
apiKey,
|
||||
log => {
|
||||
logger.debug(log.data);
|
||||
logger.info(
|
||||
`${monitorId} - System Information uploaded`
|
||||
);
|
||||
}
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
}
|
||||
break;
|
||||
case 'offline':
|
||||
try {
|
||||
post(
|
||||
apiUrl,
|
||||
`monitor/${projectId}/log/${monitorId}`,
|
||||
simulateData || offlineTestData,
|
||||
apiKey,
|
||||
log => {
|
||||
logger.debug(log.data);
|
||||
logger.info(
|
||||
`${monitorId} - System Information uploaded`
|
||||
);
|
||||
}
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
Promise.all([
|
||||
si.currentLoad(),
|
||||
si.mem(),
|
||||
si.fsSize(),
|
||||
si.cpuTemperature(),
|
||||
si.cpu(),
|
||||
])
|
||||
.then(data => {
|
||||
const storage =
|
||||
data[2] && data[2].length > 0
|
||||
? data[2].filter(
|
||||
partition =>
|
||||
partition.size === data[2][0].size
|
||||
)
|
||||
: data[2];
|
||||
return {
|
||||
cpuLoad: data[0].currentload,
|
||||
avgCpuLoad: data[0].avgload * 100,
|
||||
cpuCores: data[4].physicalCores,
|
||||
memoryUsed: data[1].active,
|
||||
totalMemory: data[1].total,
|
||||
swapUsed: data[1].swapused,
|
||||
storageUsed:
|
||||
storage && storage.length > 0
|
||||
? storage
|
||||
.map(partition => partition.used)
|
||||
.reduce(
|
||||
(used, partitionUsed) =>
|
||||
used + partitionUsed
|
||||
)
|
||||
: storage.used,
|
||||
totalStorage:
|
||||
storage && storage.length > 0
|
||||
? storage[0].size
|
||||
: storage.size,
|
||||
storageUsage:
|
||||
storage && storage.length > 0
|
||||
? storage
|
||||
.map(partition => partition.use)
|
||||
.reduce(
|
||||
(use, partitionUse) =>
|
||||
use + partitionUse
|
||||
)
|
||||
: storage.use,
|
||||
mainTemp: data[3].main,
|
||||
maxTemp: data[3].max,
|
||||
};
|
||||
})
|
||||
.then(data => {
|
||||
post(
|
||||
apiUrl,
|
||||
`monitor/${projectId}/log/${monitorId}`,
|
||||
data,
|
||||
apiKey,
|
||||
log => {
|
||||
logger.debug(log.data);
|
||||
logger.info(
|
||||
`${monitorId} - System Information uploaded`
|
||||
);
|
||||
}
|
||||
);
|
||||
})
|
||||
.catch(error => {
|
||||
logger.error(error);
|
||||
});
|
||||
}
|
||||
},
|
||||
null,
|
||||
false
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Authenticate user and get list of server monitors if monitor id not provided.
|
||||
* @param {(string | Object)} config - The project id or config of the project.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} apiKey - The api key of the project.
|
||||
* @param {(string | Function)} monitorId - The monitor id or function to resolve monitor id of the server monitor.
|
||||
* @return {Object} The server monitor handlers.
|
||||
*/
|
||||
module.exports = (config, apiUrl, apiKey, monitorId) => {
|
||||
let pingServer,
|
||||
projectId = config,
|
||||
interval,
|
||||
timeout,
|
||||
simulate,
|
||||
simulateData;
|
||||
|
||||
if (typeof config === 'object') {
|
||||
projectId = config.projectId;
|
||||
apiUrl = config.apiUrl;
|
||||
apiKey = config.apiKey;
|
||||
monitorId = config.monitorId;
|
||||
interval = config.interval;
|
||||
timeout = config.timeout;
|
||||
simulate = config.simulate;
|
||||
simulateData = config.simulateData;
|
||||
}
|
||||
|
||||
return {
|
||||
/**
|
||||
* Start server monitor.
|
||||
* @param {string} id - The monitor id of the server monitor.
|
||||
* @return {(Object | number)} The ping server cron job or the error code.
|
||||
*/
|
||||
start: (id = monitorId) => {
|
||||
const url = `monitor/${projectId}/monitor/${
|
||||
id && typeof id === 'string' ? `${id}/` : ''
|
||||
}?type=server-monitor`;
|
||||
|
||||
return get(apiUrl, url, apiKey, response => {
|
||||
return new Promise((resolve, reject) => {
|
||||
const data = response.data;
|
||||
|
||||
if (data && data !== null) {
|
||||
if (id && typeof id === 'string') {
|
||||
resolve(data._id);
|
||||
} else {
|
||||
if (data.data !== null && data.data.length > 0) {
|
||||
if (data.count === 1) {
|
||||
logger.info(
|
||||
'Using default Server Monitor...'
|
||||
);
|
||||
resolve(data.data[0]._id);
|
||||
} else {
|
||||
if (id && typeof id === 'function') {
|
||||
resolve(id(data.data));
|
||||
} else {
|
||||
logger.error(
|
||||
'Server Monitor ID is required'
|
||||
);
|
||||
reject(1);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
logger.error('No Server Monitor found');
|
||||
reject(0);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
logger.error('No Server Monitor found');
|
||||
reject(0);
|
||||
}
|
||||
});
|
||||
})
|
||||
.then(monitorId => {
|
||||
return new Promise((resolve, reject) => {
|
||||
if (monitorId) {
|
||||
logger.info('Starting Server Monitor...');
|
||||
pingServer = ping(
|
||||
projectId,
|
||||
monitorId,
|
||||
apiUrl,
|
||||
apiKey,
|
||||
interval,
|
||||
simulate,
|
||||
simulateData
|
||||
);
|
||||
pingServer.start();
|
||||
|
||||
if (timeout) {
|
||||
setTimeout(() => {
|
||||
logger.info('Stopping Server Monitor...');
|
||||
pingServer.stop();
|
||||
}, timeout);
|
||||
}
|
||||
|
||||
resolve(pingServer);
|
||||
} else {
|
||||
logger.error('Server Monitor ID is required');
|
||||
reject(1);
|
||||
}
|
||||
});
|
||||
})
|
||||
.catch(error => {
|
||||
if (typeof error !== 'number') logger.error(error);
|
||||
|
||||
const errorCode = typeof error === 'number' ? error : 1;
|
||||
process.exitCode = errorCode;
|
||||
|
||||
return error;
|
||||
});
|
||||
},
|
||||
/** Stop server monitor.
|
||||
* @return {Object} The ping server cron job.
|
||||
*/
|
||||
stop: () => {
|
||||
if (pingServer) {
|
||||
logger.info('Stopping Server Monitor...');
|
||||
pingServer.stop();
|
||||
}
|
||||
|
||||
return pingServer;
|
||||
},
|
||||
};
|
||||
};
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,131 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Source: lib/config.js</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Source: lib/config.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>/**
|
||||
* @fileoverview Main application config module.
|
||||
* @author HackerBay, Inc.
|
||||
* @module config
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
const path = require('path');
|
||||
|
||||
/** The api url to send server information. */
|
||||
const API_URL =
|
||||
process.env.API_URL ||
|
||||
(process.env.NODE_ENV === 'development'
|
||||
? 'http://localhost:3002'
|
||||
: 'https://fyipe.com/api');
|
||||
|
||||
const onlineTestData = {
|
||||
cpuLoad: 10.451510774011686,
|
||||
avgCpuLoad: 27,
|
||||
cpuCores: 4,
|
||||
memoryUsed: 2513182720,
|
||||
totalMemory: 8589934592,
|
||||
swapUsed: 1800142848,
|
||||
storageUsed: 183032516608,
|
||||
totalStorage: 250685575168,
|
||||
storageUsage: 73.00999999999999,
|
||||
mainTemp: 59.5,
|
||||
maxTemp: 60,
|
||||
};
|
||||
const degradedTestData = {
|
||||
cpuLoad: 11.577671931143978,
|
||||
avgCpuLoad: 27,
|
||||
cpuCores: 4,
|
||||
memoryUsed: 2829381632,
|
||||
totalMemory: 8589934592,
|
||||
swapUsed: 2446589952,
|
||||
storageUsed: 243169382400,
|
||||
totalStorage: 250685575168,
|
||||
storageUsage: 97.0017450095,
|
||||
mainTemp: 62,
|
||||
maxTemp: 63,
|
||||
};
|
||||
const offlineTestData = {
|
||||
cpuLoad: 0,
|
||||
avgCpuLoad: 0,
|
||||
cpuCores: 0,
|
||||
memoryUsed: 0,
|
||||
totalMemory: 0,
|
||||
swapUsed: 0,
|
||||
storageUsed: 0,
|
||||
totalStorage: 0,
|
||||
storageUsage: 0,
|
||||
mainTemp: 0,
|
||||
maxTemp: 0,
|
||||
};
|
||||
|
||||
const LOG_PATH = {
|
||||
linux: {
|
||||
log: '/var/log/Fyipe Server Monitor/fyipeservermonitor.log',
|
||||
error: '/var/log/Fyipe Server Monitor/fyipeservermonitor_error.log',
|
||||
},
|
||||
darwin: {
|
||||
log: '/Library/Logs/Fyipe Server Monitor/fyipeservermonitor.log',
|
||||
error:
|
||||
'/Library/Logs/Fyipe Server Monitor/fyipeservermonitor_error.log',
|
||||
},
|
||||
win32: {
|
||||
log: path.join(__dirname, 'fyipeservermonitor.out.log'),
|
||||
error: path.join(__dirname, 'fyipeservermonitor.err.log'),
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
API_URL,
|
||||
LOG_PATH,
|
||||
onlineTestData,
|
||||
degradedTestData,
|
||||
offlineTestData,
|
||||
};
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,136 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Source: lib/helpers.js</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Source: lib/helpers.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>/**
|
||||
* @fileoverview HTTP wrapper functions module.
|
||||
* @author HackerBay, Inc.
|
||||
* @module helpers
|
||||
* @see module:config
|
||||
* @see module:logger
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
const axios = require('axios');
|
||||
const { API_URL } = require('./config');
|
||||
const logger = require('./logger');
|
||||
|
||||
/** The request headers. */
|
||||
const headers = {
|
||||
'Content-Type': 'application/json',
|
||||
};
|
||||
|
||||
/** Handle request error.
|
||||
* @param {Object} - The error object of the request.
|
||||
* @default
|
||||
*/
|
||||
const defaultErrorHandler = error => {
|
||||
logger.debug(error.config);
|
||||
if (error.response) {
|
||||
logger.debug(error.response.data);
|
||||
logger.debug(error.response.status);
|
||||
logger.debug(error.response.headers);
|
||||
throw error.response.data;
|
||||
} else {
|
||||
if (error.request) {
|
||||
logger.debug(error.request);
|
||||
} else {
|
||||
logger.debug('Error', error.message);
|
||||
}
|
||||
}
|
||||
throw error;
|
||||
};
|
||||
|
||||
/**
|
||||
* Get request data with axios.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} url - The endpoint of the request.
|
||||
* @param {string} key - The api key of the endpoint.
|
||||
* @param {Function} success - The request success callback.
|
||||
* @param {Function} error - The request error callback.
|
||||
* @return {Promise} The request promise.
|
||||
*/
|
||||
const get = (apiUrl, url, key, success, error = defaultErrorHandler) => {
|
||||
headers['apiKey'] = key;
|
||||
|
||||
return axios({
|
||||
method: 'get',
|
||||
url: `${apiUrl || API_URL}/${url}`,
|
||||
headers,
|
||||
}).then(success, error);
|
||||
};
|
||||
|
||||
/**
|
||||
* Post request data with axios.
|
||||
* @param {string} apiUrl - The url of the api.
|
||||
* @param {string} url - The endpoint of the request.
|
||||
* @param {Object} data - The data of endpoint.
|
||||
* @param {string} key - The api key of the endpoint.
|
||||
* @param {Function} success - The request success callback.
|
||||
* @param {Function} error - The request error callback.
|
||||
* @return {Promise} The request promise.
|
||||
*/
|
||||
const post = (apiUrl, url, data, key, success, error = defaultErrorHandler) => {
|
||||
headers['apiKey'] = key;
|
||||
|
||||
return axios({
|
||||
method: 'post',
|
||||
url: `${apiUrl || API_URL}/${url}`,
|
||||
headers,
|
||||
data,
|
||||
}).then(success, error);
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
get,
|
||||
post,
|
||||
defaultErrorHandler,
|
||||
};
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,66 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Source: lib/logger.js</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Source: lib/logger.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>/**
|
||||
* @fileoverview Default message and error logger service.
|
||||
* @author HackerBay, Inc.
|
||||
* @module logger
|
||||
*/
|
||||
|
||||
const pino = require('pino');
|
||||
|
||||
/** The logger service. */
|
||||
const logger = pino({
|
||||
level: process.env.LOG_LEVEL || 'info',
|
||||
prettyPrint: { colorize: true, translateTime: true },
|
||||
});
|
||||
|
||||
module.exports = logger;
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,968 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Module: api</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Module: api</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
<div class="description">Main API to authenticate user, start and stop server monitoring.</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-author">Author:</dt>
|
||||
<dd class="tag-author">
|
||||
<ul>
|
||||
<li>HackerBay, Inc.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_api.js.html">lib/api.js</a>, <a href="lib_api.js.html#line1">line 1</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-see">See:</dt>
|
||||
<dd class="tag-see">
|
||||
<ul>
|
||||
<li><a href="module-helpers.html">module:helpers</a></li>
|
||||
|
||||
<li><a href="module-logger.html">module:logger</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="module:api"><span class="type-signature"></span>(require("api"))<span class="signature">(config, apiUrl, apiKey, monitorId)</span><span class="type-signature"> → {Object}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Authenticate user and get list of server monitors if monitor id not provided.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>config</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The project id or config of the project.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>apiUrl</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The url of the api.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>apiKey</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The api key of the project.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>monitorId</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The monitor id or function to resolve monitor id of the server monitor.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_api.js.html">lib/api.js</a>, <a href="lib_api.js.html#line184">line 184</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The server monitor handlers.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~ping"><span class="type-signature">(inner) </span>ping<span class="signature">(projectId, monitorId, apiUrl, apiKey, interval)</span><span class="type-signature"> → {Object}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Get system information at interval and upload to server.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
<th>Default</th>
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>projectId</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">The project id of the project.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>monitorId</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">The monitor id of the server monitor.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>apiUrl</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">The url of the api.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>apiKey</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">The api key of the project.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>interval</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
* * * * *
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">The interval of the cron job, must ba a valid cron format.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_api.js.html">lib/api.js</a>, <a href="lib_api.js.html#line34">line 34</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The ping server cron job.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~start"><span class="type-signature">(inner) </span>start<span class="signature">(id)</span><span class="type-signature"> → {Object|number}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Start server monitor.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>id</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The monitor id of the server monitor.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_api.js.html">lib/api.js</a>, <a href="lib_api.js.html#line209">line 209</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The ping server cron job or the error code.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
|
||||
|
||||
<span class="param-type">number</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~stop"><span class="type-signature">(inner) </span>stop<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Stop server monitor.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_api.js.html">lib/api.js</a>, <a href="lib_api.js.html#line290">line 290</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The ping server cron job.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,238 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Module: config</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Module: config</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
<div class="description">Main application config module.</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-author">Author:</dt>
|
||||
<dd class="tag-author">
|
||||
<ul>
|
||||
<li>HackerBay, Inc.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_config.js.html">lib/config.js</a>, <a href="lib_config.js.html#line1">line 1</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Members</h3>
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~API_URL"><span class="type-signature">(inner, constant) </span>API_URL<span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
The api url to send server information.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_config.js.html">lib/config.js</a>, <a href="lib_config.js.html#line12">line 12</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,909 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Module: helpers</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Module: helpers</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
<div class="description">HTTP wrapper functions module.</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-author">Author:</dt>
|
||||
<dd class="tag-author">
|
||||
<ul>
|
||||
<li>HackerBay, Inc.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_helpers.js.html">lib/helpers.js</a>, <a href="lib_helpers.js.html#line1">line 1</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-see">See:</dt>
|
||||
<dd class="tag-see">
|
||||
<ul>
|
||||
<li><a href="module-config.html">module:config</a></li>
|
||||
|
||||
<li><a href="module-logger.html">module:logger</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Members</h3>
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~headers"><span class="type-signature">(inner, constant) </span>headers<span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
The request headers.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_helpers.js.html">lib/helpers.js</a>, <a href="lib_helpers.js.html#line16">line 16</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~defaultErrorHandler"><span class="type-signature">(inner) </span>defaultErrorHandler<span class="signature">()</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Handle request error.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The error object of the request.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_helpers.js.html">lib/helpers.js</a>, <a href="lib_helpers.js.html#line24">line 24</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~get"><span class="type-signature">(inner) </span>get<span class="signature">(apiUrl, url, key, success, error)</span><span class="type-signature"> → {Promise}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Get request data with axios.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>apiUrl</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The url of the api.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>url</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The endpoint of the request.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>key</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The api key of the endpoint.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>success</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The request success callback.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>error</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The request error callback.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_helpers.js.html">lib/helpers.js</a>, <a href="lib_helpers.js.html#line50">line 50</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The request promise.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Promise</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~post"><span class="type-signature">(inner) </span>post<span class="signature">(apiUrl, url, data, key, success, error)</span><span class="type-signature"> → {Promise}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Post request data with axios.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>apiUrl</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The url of the api.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>url</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The endpoint of the request.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>data</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The data of endpoint.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>key</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The api key of the endpoint.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>success</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The request success callback.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>error</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The request error callback.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_helpers.js.html">lib/helpers.js</a>, <a href="lib_helpers.js.html#line70">line 70</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The request promise.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Promise</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,238 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Module: logger</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Module: logger</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
<div class="description">Default message and error logger service.</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-author">Author:</dt>
|
||||
<dd class="tag-author">
|
||||
<ul>
|
||||
<li>HackerBay, Inc.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_logger.js.html">lib/logger.js</a>, <a href="lib_logger.js.html#line1">line 1</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Members</h3>
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~logger"><span class="type-signature">(inner, constant) </span>logger<span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
The logger service.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="lib_logger.js.html">lib/logger.js</a>, <a href="lib_logger.js.html#line10">line 10</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,590 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>JSDoc: Module: server-monitor</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Module: server-monitor</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
<div class="description">Main CLI that is run via the fyipe-server-monitor command.</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-author">Author:</dt>
|
||||
<dd class="tag-author">
|
||||
<ul>
|
||||
<li>HackerBay, Inc.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="bin_server-monitor.js.html">bin/server-monitor.js</a>, <a href="bin_server-monitor.js.html#line3">line 3</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-see">See:</dt>
|
||||
<dd class="tag-see">
|
||||
<ul>
|
||||
<li><a href="module-api.html">module:api</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Members</h3>
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~questions"><span class="type-signature">(inner, constant) </span>questions<span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
The questions to get project id, api url, api key and monitor id.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="bin_server-monitor.js.html">bin/server-monitor.js</a>, <a href="bin_server-monitor.js.html#line41">line 41</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~checkParams"><span class="type-signature">(inner) </span>checkParams<span class="signature">(params)</span><span class="type-signature"> → {Promise}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Check cli params.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>params</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Array</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The params or questions of the cli.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="bin_server-monitor.js.html">bin/server-monitor.js</a>, <a href="bin_server-monitor.js.html#line78">line 78</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The cli params promise.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Promise</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="~getParamValue"><span class="type-signature">(inner) </span>getParamValue<span class="signature">(params, name)</span><span class="type-signature"> → {Promise}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Get cli param value.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>params</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Array</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The params of the cli.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>name</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">The name of the cli param.</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="bin_server-monitor.js.html">bin/server-monitor.js</a>, <a href="bin_server-monitor.js.html#line104">line 104</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
The cli param value promise.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Promise</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a></li><li><a href="module-config.html">config</a></li><li><a href="module-helpers.html">helpers</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-server-monitor.html">server-monitor</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Jan 08 2021 00:53:57 GMT+0100 (West Africa Standard Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,27 +0,0 @@
|
||||
"use strict";
|
||||
|
||||
(function () {
|
||||
var source = document.getElementsByClassName('prettyprint source linenums');
|
||||
var i = 0;
|
||||
var lineNumber = 0;
|
||||
var lineId;
|
||||
var lines;
|
||||
var totalLines;
|
||||
var anchorHash;
|
||||
|
||||
if (source && source[0]) {
|
||||
anchorHash = document.location.hash.substring(1);
|
||||
lines = source[0].getElementsByTagName('li');
|
||||
totalLines = lines.length;
|
||||
|
||||
for (; i < totalLines; i++) {
|
||||
lineNumber++;
|
||||
lineId = "line".concat(lineNumber);
|
||||
lines[i].id = lineId;
|
||||
|
||||
if (lineId === anchorHash) {
|
||||
lines[i].className += ' selected';
|
||||
}
|
||||
}
|
||||
}
|
||||
})();
|
||||
@@ -1,202 +0,0 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -1,5 +0,0 @@
|
||||
"use strict";
|
||||
|
||||
PR.registerLangHandler(PR.createSimpleLexer([["pln", /^[\t\n\f\r ]+/, null, " \t\r\n "]], [["str", /^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/, null], ["str", /^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/, null], ["lang-css-str", /^url\(([^"')]*)\)/i], ["kwd", /^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i, null], ["lang-css-kw", /^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i], ["com", /^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//], ["com", /^(?:<\!--|--\>)/], ["lit", /^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i], ["lit", /^#[\da-f]{3,6}/i], ["pln", /^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i], ["pun", /^[^\s\w"']+/]]), ["css"]);
|
||||
PR.registerLangHandler(PR.createSimpleLexer([], [["kwd", /^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]), ["css-kw"]);
|
||||
PR.registerLangHandler(PR.createSimpleLexer([], [["str", /^[^"')]+/]]), ["css-str"]);
|
||||
@@ -1,567 +0,0 @@
|
||||
"use strict";
|
||||
|
||||
var q = null;
|
||||
window.PR_SHOULD_USE_CONTINUATION = !0;
|
||||
|
||||
(function () {
|
||||
function L(a) {
|
||||
function m(a) {
|
||||
var f = a.charCodeAt(0);
|
||||
if (f !== 92) return f;
|
||||
var b = a.charAt(1);
|
||||
return (f = r[b]) ? f : "0" <= b && b <= "7" ? parseInt(a.substring(1), 8) : b === "u" || b === "x" ? parseInt(a.substring(2), 16) : a.charCodeAt(1);
|
||||
}
|
||||
|
||||
function e(a) {
|
||||
if (a < 32) return (a < 16 ? "\\x0" : "\\x") + a.toString(16);
|
||||
a = String.fromCharCode(a);
|
||||
if (a === "\\" || a === "-" || a === "[" || a === "]") a = "\\" + a;
|
||||
return a;
|
||||
}
|
||||
|
||||
function h(a) {
|
||||
for (var f = a.substring(1, a.length - 1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g), a = [], b = [], o = f[0] === "^", c = o ? 1 : 0, i = f.length; c < i; ++c) {
|
||||
var j = f[c];
|
||||
if (/\\[bdsw]/i.test(j)) a.push(j);else {
|
||||
var j = m(j),
|
||||
d;
|
||||
c + 2 < i && "-" === f[c + 1] ? (d = m(f[c + 2]), c += 2) : d = j;
|
||||
b.push([j, d]);
|
||||
d < 65 || j > 122 || (d < 65 || j > 90 || b.push([Math.max(65, j) | 32, Math.min(d, 90) | 32]), d < 97 || j > 122 || b.push([Math.max(97, j) & -33, Math.min(d, 122) & -33]));
|
||||
}
|
||||
}
|
||||
|
||||
b.sort(function (a, f) {
|
||||
return a[0] - f[0] || f[1] - a[1];
|
||||
});
|
||||
f = [];
|
||||
j = [NaN, NaN];
|
||||
|
||||
for (c = 0; c < b.length; ++c) {
|
||||
i = b[c], i[0] <= j[1] + 1 ? j[1] = Math.max(j[1], i[1]) : f.push(j = i);
|
||||
}
|
||||
|
||||
b = ["["];
|
||||
o && b.push("^");
|
||||
b.push.apply(b, a);
|
||||
|
||||
for (c = 0; c < f.length; ++c) {
|
||||
i = f[c], b.push(e(i[0])), i[1] > i[0] && (i[1] + 1 > i[0] && b.push("-"), b.push(e(i[1])));
|
||||
}
|
||||
|
||||
b.push("]");
|
||||
return b.join("");
|
||||
}
|
||||
|
||||
function y(a) {
|
||||
for (var f = a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g), b = f.length, d = [], c = 0, i = 0; c < b; ++c) {
|
||||
var j = f[c];
|
||||
j === "(" ? ++i : "\\" === j.charAt(0) && (j = +j.substring(1)) && j <= i && (d[j] = -1);
|
||||
}
|
||||
|
||||
for (c = 1; c < d.length; ++c) {
|
||||
-1 === d[c] && (d[c] = ++t);
|
||||
}
|
||||
|
||||
for (i = c = 0; c < b; ++c) {
|
||||
j = f[c], j === "(" ? (++i, d[i] === void 0 && (f[c] = "(?:")) : "\\" === j.charAt(0) && (j = +j.substring(1)) && j <= i && (f[c] = "\\" + d[i]);
|
||||
}
|
||||
|
||||
for (i = c = 0; c < b; ++c) {
|
||||
"^" === f[c] && "^" !== f[c + 1] && (f[c] = "");
|
||||
}
|
||||
|
||||
if (a.ignoreCase && s) for (c = 0; c < b; ++c) {
|
||||
j = f[c], a = j.charAt(0), j.length >= 2 && a === "[" ? f[c] = h(j) : a !== "\\" && (f[c] = j.replace(/[A-Za-z]/g, function (a) {
|
||||
a = a.charCodeAt(0);
|
||||
return "[" + String.fromCharCode(a & -33, a | 32) + "]";
|
||||
}));
|
||||
}
|
||||
return f.join("");
|
||||
}
|
||||
|
||||
for (var t = 0, s = !1, l = !1, p = 0, d = a.length; p < d; ++p) {
|
||||
var g = a[p];
|
||||
if (g.ignoreCase) l = !0;else if (/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi, ""))) {
|
||||
s = !0;
|
||||
l = !1;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
for (var r = {
|
||||
b: 8,
|
||||
t: 9,
|
||||
n: 10,
|
||||
v: 11,
|
||||
f: 12,
|
||||
r: 13
|
||||
}, n = [], p = 0, d = a.length; p < d; ++p) {
|
||||
g = a[p];
|
||||
if (g.global || g.multiline) throw Error("" + g);
|
||||
n.push("(?:" + y(g) + ")");
|
||||
}
|
||||
|
||||
return RegExp(n.join("|"), l ? "gi" : "g");
|
||||
}
|
||||
|
||||
function M(a) {
|
||||
function m(a) {
|
||||
switch (a.nodeType) {
|
||||
case 1:
|
||||
if (e.test(a.className)) break;
|
||||
|
||||
for (var g = a.firstChild; g; g = g.nextSibling) {
|
||||
m(g);
|
||||
}
|
||||
|
||||
g = a.nodeName;
|
||||
if ("BR" === g || "LI" === g) h[s] = "\n", t[s << 1] = y++, t[s++ << 1 | 1] = a;
|
||||
break;
|
||||
|
||||
case 3:
|
||||
case 4:
|
||||
g = a.nodeValue, g.length && (g = p ? g.replace(/\r\n?/g, "\n") : g.replace(/[\t\n\r ]+/g, " "), h[s] = g, t[s << 1] = y, y += g.length, t[s++ << 1 | 1] = a);
|
||||
}
|
||||
}
|
||||
|
||||
var e = /(?:^|\s)nocode(?:\s|$)/,
|
||||
h = [],
|
||||
y = 0,
|
||||
t = [],
|
||||
s = 0,
|
||||
l;
|
||||
a.currentStyle ? l = a.currentStyle.whiteSpace : window.getComputedStyle && (l = document.defaultView.getComputedStyle(a, q).getPropertyValue("white-space"));
|
||||
var p = l && "pre" === l.substring(0, 3);
|
||||
m(a);
|
||||
return {
|
||||
a: h.join("").replace(/\n$/, ""),
|
||||
c: t
|
||||
};
|
||||
}
|
||||
|
||||
function B(a, m, e, h) {
|
||||
m && (a = {
|
||||
a: m,
|
||||
d: a
|
||||
}, e(a), h.push.apply(h, a.e));
|
||||
}
|
||||
|
||||
function x(a, m) {
|
||||
function e(a) {
|
||||
for (var l = a.d, p = [l, "pln"], d = 0, g = a.a.match(y) || [], r = {}, n = 0, z = g.length; n < z; ++n) {
|
||||
var f = g[n],
|
||||
b = r[f],
|
||||
o = void 0,
|
||||
c;
|
||||
if (typeof b === "string") c = !1;else {
|
||||
var i = h[f.charAt(0)];
|
||||
if (i) o = f.match(i[1]), b = i[0];else {
|
||||
for (c = 0; c < t; ++c) {
|
||||
if (i = m[c], o = f.match(i[1])) {
|
||||
b = i[0];
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
o || (b = "pln");
|
||||
}
|
||||
if ((c = b.length >= 5 && "lang-" === b.substring(0, 5)) && !(o && typeof o[1] === "string")) c = !1, b = "src";
|
||||
c || (r[f] = b);
|
||||
}
|
||||
i = d;
|
||||
d += f.length;
|
||||
|
||||
if (c) {
|
||||
c = o[1];
|
||||
var j = f.indexOf(c),
|
||||
k = j + c.length;
|
||||
o[2] && (k = f.length - o[2].length, j = k - c.length);
|
||||
b = b.substring(5);
|
||||
B(l + i, f.substring(0, j), e, p);
|
||||
B(l + i + j, c, C(b, c), p);
|
||||
B(l + i + k, f.substring(k), e, p);
|
||||
} else p.push(l + i, b);
|
||||
}
|
||||
|
||||
a.e = p;
|
||||
}
|
||||
|
||||
var h = {},
|
||||
y;
|
||||
|
||||
(function () {
|
||||
for (var e = a.concat(m), l = [], p = {}, d = 0, g = e.length; d < g; ++d) {
|
||||
var r = e[d],
|
||||
n = r[3];
|
||||
if (n) for (var k = n.length; --k >= 0;) {
|
||||
h[n.charAt(k)] = r;
|
||||
}
|
||||
r = r[1];
|
||||
n = "" + r;
|
||||
p.hasOwnProperty(n) || (l.push(r), p[n] = q);
|
||||
}
|
||||
|
||||
l.push(/[\S\s]/);
|
||||
y = L(l);
|
||||
})();
|
||||
|
||||
var t = m.length;
|
||||
return e;
|
||||
}
|
||||
|
||||
function u(a) {
|
||||
var m = [],
|
||||
e = [];
|
||||
a.tripleQuotedStrings ? m.push(["str", /^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/, q, "'\""]) : a.multiLineStrings ? m.push(["str", /^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, q, "'\"`"]) : m.push(["str", /^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/, q, "\"'"]);
|
||||
a.verbatimStrings && e.push(["str", /^@"(?:[^"]|"")*(?:"|$)/, q]);
|
||||
var h = a.hashComments;
|
||||
h && (a.cStyleComments ? (h > 1 ? m.push(["com", /^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/, q, "#"]) : m.push(["com", /^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/, q, "#"]), e.push(["str", /^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/, q])) : m.push(["com", /^#[^\n\r]*/, q, "#"]));
|
||||
a.cStyleComments && (e.push(["com", /^\/\/[^\n\r]*/, q]), e.push(["com", /^\/\*[\S\s]*?(?:\*\/|$)/, q]));
|
||||
a.regexLiterals && e.push(["lang-regex", /^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);
|
||||
(h = a.types) && e.push(["typ", h]);
|
||||
a = ("" + a.keywords).replace(/^ | $/g, "");
|
||||
a.length && e.push(["kwd", RegExp("^(?:" + a.replace(/[\s,]+/g, "|") + ")\\b"), q]);
|
||||
m.push(["pln", /^\s+/, q, " \r\n\t\xa0"]);
|
||||
e.push(["lit", /^@[$_a-z][\w$@]*/i, q], ["typ", /^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/, q], ["pln", /^[$_a-z][\w$@]*/i, q], ["lit", /^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i, q, "0123456789"], ["pln", /^\\[\S\s]?/, q], ["pun", /^.[^\s\w"-$'./@\\`]*/, q]);
|
||||
return x(m, e);
|
||||
}
|
||||
|
||||
function D(a, m) {
|
||||
function e(a) {
|
||||
switch (a.nodeType) {
|
||||
case 1:
|
||||
if (k.test(a.className)) break;
|
||||
if ("BR" === a.nodeName) h(a), a.parentNode && a.parentNode.removeChild(a);else for (a = a.firstChild; a; a = a.nextSibling) {
|
||||
e(a);
|
||||
}
|
||||
break;
|
||||
|
||||
case 3:
|
||||
case 4:
|
||||
if (p) {
|
||||
var b = a.nodeValue,
|
||||
d = b.match(t);
|
||||
|
||||
if (d) {
|
||||
var c = b.substring(0, d.index);
|
||||
a.nodeValue = c;
|
||||
(b = b.substring(d.index + d[0].length)) && a.parentNode.insertBefore(s.createTextNode(b), a.nextSibling);
|
||||
h(a);
|
||||
c || a.parentNode.removeChild(a);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
function h(a) {
|
||||
function b(a, d) {
|
||||
var e = d ? a.cloneNode(!1) : a,
|
||||
f = a.parentNode;
|
||||
|
||||
if (f) {
|
||||
var f = b(f, 1),
|
||||
g = a.nextSibling;
|
||||
f.appendChild(e);
|
||||
|
||||
for (var h = g; h; h = g) {
|
||||
g = h.nextSibling, f.appendChild(h);
|
||||
}
|
||||
}
|
||||
|
||||
return e;
|
||||
}
|
||||
|
||||
for (; !a.nextSibling;) {
|
||||
if (a = a.parentNode, !a) return;
|
||||
}
|
||||
|
||||
for (var a = b(a.nextSibling, 0), e; (e = a.parentNode) && e.nodeType === 1;) {
|
||||
a = e;
|
||||
}
|
||||
|
||||
d.push(a);
|
||||
}
|
||||
|
||||
var k = /(?:^|\s)nocode(?:\s|$)/,
|
||||
t = /\r\n?|\n/,
|
||||
s = a.ownerDocument,
|
||||
l;
|
||||
a.currentStyle ? l = a.currentStyle.whiteSpace : window.getComputedStyle && (l = s.defaultView.getComputedStyle(a, q).getPropertyValue("white-space"));
|
||||
var p = l && "pre" === l.substring(0, 3);
|
||||
|
||||
for (l = s.createElement("LI"); a.firstChild;) {
|
||||
l.appendChild(a.firstChild);
|
||||
}
|
||||
|
||||
for (var d = [l], g = 0; g < d.length; ++g) {
|
||||
e(d[g]);
|
||||
}
|
||||
|
||||
m === (m | 0) && d[0].setAttribute("value", m);
|
||||
var r = s.createElement("OL");
|
||||
r.className = "linenums";
|
||||
|
||||
for (var n = Math.max(0, m - 1 | 0) || 0, g = 0, z = d.length; g < z; ++g) {
|
||||
l = d[g], l.className = "L" + (g + n) % 10, l.firstChild || l.appendChild(s.createTextNode("\xa0")), r.appendChild(l);
|
||||
}
|
||||
|
||||
a.appendChild(r);
|
||||
}
|
||||
|
||||
function k(a, m) {
|
||||
for (var e = m.length; --e >= 0;) {
|
||||
var h = m[e];
|
||||
A.hasOwnProperty(h) ? window.console && console.warn("cannot override language handler %s", h) : A[h] = a;
|
||||
}
|
||||
}
|
||||
|
||||
function C(a, m) {
|
||||
if (!a || !A.hasOwnProperty(a)) a = /^\s*</.test(m) ? "default-markup" : "default-code";
|
||||
return A[a];
|
||||
}
|
||||
|
||||
function E(a) {
|
||||
var m = a.g;
|
||||
|
||||
try {
|
||||
var e = M(a.h),
|
||||
h = e.a;
|
||||
a.a = h;
|
||||
a.c = e.c;
|
||||
a.d = 0;
|
||||
C(m, h)(a);
|
||||
var k = /\bMSIE\b/.test(navigator.userAgent),
|
||||
m = /\n/g,
|
||||
t = a.a,
|
||||
s = t.length,
|
||||
e = 0,
|
||||
l = a.c,
|
||||
p = l.length,
|
||||
h = 0,
|
||||
d = a.e,
|
||||
g = d.length,
|
||||
a = 0;
|
||||
d[g] = s;
|
||||
var r, n;
|
||||
|
||||
for (n = r = 0; n < g;) {
|
||||
d[n] !== d[n + 2] ? (d[r++] = d[n++], d[r++] = d[n++]) : n += 2;
|
||||
}
|
||||
|
||||
g = r;
|
||||
|
||||
for (n = r = 0; n < g;) {
|
||||
for (var z = d[n], f = d[n + 1], b = n + 2; b + 2 <= g && d[b + 1] === f;) {
|
||||
b += 2;
|
||||
}
|
||||
|
||||
d[r++] = z;
|
||||
d[r++] = f;
|
||||
n = b;
|
||||
}
|
||||
|
||||
for (d.length = r; h < p;) {
|
||||
var o = l[h + 2] || s,
|
||||
c = d[a + 2] || s,
|
||||
b = Math.min(o, c),
|
||||
i = l[h + 1],
|
||||
j;
|
||||
|
||||
if (i.nodeType !== 1 && (j = t.substring(e, b))) {
|
||||
k && (j = j.replace(m, "\r"));
|
||||
i.nodeValue = j;
|
||||
var u = i.ownerDocument,
|
||||
v = u.createElement("SPAN");
|
||||
v.className = d[a + 1];
|
||||
var x = i.parentNode;
|
||||
x.replaceChild(v, i);
|
||||
v.appendChild(i);
|
||||
e < o && (l[h + 1] = i = u.createTextNode(t.substring(b, o)), x.insertBefore(i, v.nextSibling));
|
||||
}
|
||||
|
||||
e = b;
|
||||
e >= o && (h += 2);
|
||||
e >= c && (a += 2);
|
||||
}
|
||||
} catch (w) {
|
||||
"console" in window && console.log(w && w.stack ? w.stack : w);
|
||||
}
|
||||
}
|
||||
|
||||
var v = ["break,continue,do,else,for,if,return,while"],
|
||||
w = [[v, "auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], "catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],
|
||||
F = [w, "alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],
|
||||
G = [w, "abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
|
||||
H = [G, "as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],
|
||||
w = [w, "debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],
|
||||
I = [v, "and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
|
||||
J = [v, "alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],
|
||||
v = [v, "case,done,elif,esac,eval,fi,function,in,local,set,then,until"],
|
||||
K = /^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,
|
||||
N = /\S/,
|
||||
O = u({
|
||||
keywords: [F, H, w, "caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END" + I, J, v],
|
||||
hashComments: !0,
|
||||
cStyleComments: !0,
|
||||
multiLineStrings: !0,
|
||||
regexLiterals: !0
|
||||
}),
|
||||
A = {};
|
||||
k(O, ["default-code"]);
|
||||
k(x([], [["pln", /^[^<?]+/], ["dec", /^<!\w[^>]*(?:>|$)/], ["com", /^<\!--[\S\s]*?(?:--\>|$)/], ["lang-", /^<\?([\S\s]+?)(?:\?>|$)/], ["lang-", /^<%([\S\s]+?)(?:%>|$)/], ["pun", /^(?:<[%?]|[%?]>)/], ["lang-", /^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i], ["lang-js", /^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i], ["lang-css", /^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i], ["lang-in.tag", /^(<\/?[a-z][^<>]*>)/i]]), ["default-markup", "htm", "html", "mxml", "xhtml", "xml", "xsl"]);
|
||||
k(x([["pln", /^\s+/, q, " \t\r\n"], ["atv", /^(?:"[^"]*"?|'[^']*'?)/, q, "\"'"]], [["tag", /^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i], ["atn", /^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i], ["lang-uq.val", /^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/], ["pun", /^[/<->]+/], ["lang-js", /^on\w+\s*=\s*"([^"]+)"/i], ["lang-js", /^on\w+\s*=\s*'([^']+)'/i], ["lang-js", /^on\w+\s*=\s*([^\s"'>]+)/i], ["lang-css", /^style\s*=\s*"([^"]+)"/i], ["lang-css", /^style\s*=\s*'([^']+)'/i], ["lang-css", /^style\s*=\s*([^\s"'>]+)/i]]), ["in.tag"]);
|
||||
k(x([], [["atv", /^[\S\s]+/]]), ["uq.val"]);
|
||||
k(u({
|
||||
keywords: F,
|
||||
hashComments: !0,
|
||||
cStyleComments: !0,
|
||||
types: K
|
||||
}), ["c", "cc", "cpp", "cxx", "cyc", "m"]);
|
||||
k(u({
|
||||
keywords: "null,true,false"
|
||||
}), ["json"]);
|
||||
k(u({
|
||||
keywords: H,
|
||||
hashComments: !0,
|
||||
cStyleComments: !0,
|
||||
verbatimStrings: !0,
|
||||
types: K
|
||||
}), ["cs"]);
|
||||
k(u({
|
||||
keywords: G,
|
||||
cStyleComments: !0
|
||||
}), ["java"]);
|
||||
k(u({
|
||||
keywords: v,
|
||||
hashComments: !0,
|
||||
multiLineStrings: !0
|
||||
}), ["bsh", "csh", "sh"]);
|
||||
k(u({
|
||||
keywords: I,
|
||||
hashComments: !0,
|
||||
multiLineStrings: !0,
|
||||
tripleQuotedStrings: !0
|
||||
}), ["cv", "py"]);
|
||||
k(u({
|
||||
keywords: "caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",
|
||||
hashComments: !0,
|
||||
multiLineStrings: !0,
|
||||
regexLiterals: !0
|
||||
}), ["perl", "pl", "pm"]);
|
||||
k(u({
|
||||
keywords: J,
|
||||
hashComments: !0,
|
||||
multiLineStrings: !0,
|
||||
regexLiterals: !0
|
||||
}), ["rb"]);
|
||||
k(u({
|
||||
keywords: w,
|
||||
cStyleComments: !0,
|
||||
regexLiterals: !0
|
||||
}), ["js"]);
|
||||
k(u({
|
||||
keywords: "all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
|
||||
hashComments: 3,
|
||||
cStyleComments: !0,
|
||||
multilineStrings: !0,
|
||||
tripleQuotedStrings: !0,
|
||||
regexLiterals: !0
|
||||
}), ["coffee"]);
|
||||
k(x([], [["str", /^[\S\s]+/]]), ["regex"]);
|
||||
|
||||
window.prettyPrintOne = function (a, m, e) {
|
||||
var h = document.createElement("PRE");
|
||||
h.innerHTML = a;
|
||||
e && D(h, e);
|
||||
E({
|
||||
g: m,
|
||||
i: e,
|
||||
h: h
|
||||
});
|
||||
return h.innerHTML;
|
||||
};
|
||||
|
||||
window.prettyPrint = function (a) {
|
||||
function m() {
|
||||
for (var e = window.PR_SHOULD_USE_CONTINUATION ? l.now() + 250 : Infinity; p < h.length && l.now() < e; p++) {
|
||||
var n = h[p],
|
||||
k = n.className;
|
||||
|
||||
if (k.indexOf("prettyprint") >= 0) {
|
||||
var k = k.match(g),
|
||||
f,
|
||||
b;
|
||||
|
||||
if (b = !k) {
|
||||
b = n;
|
||||
|
||||
for (var o = void 0, c = b.firstChild; c; c = c.nextSibling) {
|
||||
var i = c.nodeType,
|
||||
o = i === 1 ? o ? b : c : i === 3 ? N.test(c.nodeValue) ? b : o : o;
|
||||
}
|
||||
|
||||
b = (f = o === b ? void 0 : o) && "CODE" === f.tagName;
|
||||
}
|
||||
|
||||
b && (k = f.className.match(g));
|
||||
k && (k = k[1]);
|
||||
b = !1;
|
||||
|
||||
for (o = n.parentNode; o; o = o.parentNode) {
|
||||
if ((o.tagName === "pre" || o.tagName === "code" || o.tagName === "xmp") && o.className && o.className.indexOf("prettyprint") >= 0) {
|
||||
b = !0;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
b || ((b = (b = n.className.match(/\blinenums\b(?::(\d+))?/)) ? b[1] && b[1].length ? +b[1] : !0 : !1) && D(n, b), d = {
|
||||
g: k,
|
||||
h: n,
|
||||
i: b
|
||||
}, E(d));
|
||||
}
|
||||
}
|
||||
|
||||
p < h.length ? setTimeout(m, 250) : a && a();
|
||||
}
|
||||
|
||||
for (var e = [document.getElementsByTagName("pre"), document.getElementsByTagName("code"), document.getElementsByTagName("xmp")], h = [], k = 0; k < e.length; ++k) {
|
||||
for (var t = 0, s = e[k].length; t < s; ++t) {
|
||||
h.push(e[k][t]);
|
||||
}
|
||||
}
|
||||
|
||||
var e = q,
|
||||
l = Date;
|
||||
l.now || (l = {
|
||||
now: function now() {
|
||||
return +new Date();
|
||||
}
|
||||
});
|
||||
var p = 0,
|
||||
d,
|
||||
g = /\blang(?:uage)?-([\w.]+)(?!\S)/;
|
||||
m();
|
||||
};
|
||||
|
||||
window.PR = {
|
||||
createSimpleLexer: x,
|
||||
registerLangHandler: k,
|
||||
sourceDecorator: u,
|
||||
PR_ATTRIB_NAME: "atn",
|
||||
PR_ATTRIB_VALUE: "atv",
|
||||
PR_COMMENT: "com",
|
||||
PR_DECLARATION: "dec",
|
||||
PR_KEYWORD: "kwd",
|
||||
PR_LITERAL: "lit",
|
||||
PR_NOCODE: "nocode",
|
||||
PR_PLAIN: "pln",
|
||||
PR_PUNCTUATION: "pun",
|
||||
PR_SOURCE: "src",
|
||||
PR_STRING: "str",
|
||||
PR_TAG: "tag",
|
||||
PR_TYPE: "typ"
|
||||
};
|
||||
})();
|
||||
@@ -1,358 +0,0 @@
|
||||
@font-face {
|
||||
font-family: 'Open Sans';
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
src: url('../fonts/OpenSans-Regular-webfont.eot');
|
||||
src:
|
||||
local('Open Sans'),
|
||||
local('OpenSans'),
|
||||
url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'),
|
||||
url('../fonts/OpenSans-Regular-webfont.woff') format('woff'),
|
||||
url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg');
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Open Sans Light';
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
src: url('../fonts/OpenSans-Light-webfont.eot');
|
||||
src:
|
||||
local('Open Sans Light'),
|
||||
local('OpenSans Light'),
|
||||
url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'),
|
||||
url('../fonts/OpenSans-Light-webfont.woff') format('woff'),
|
||||
url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
|
||||
}
|
||||
|
||||
html
|
||||
{
|
||||
overflow: auto;
|
||||
background-color: #fff;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
body
|
||||
{
|
||||
font-family: 'Open Sans', sans-serif;
|
||||
line-height: 1.5;
|
||||
color: #4d4e53;
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
a, a:visited, a:active {
|
||||
color: #0095dd;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
header
|
||||
{
|
||||
display: block;
|
||||
padding: 0px 4px;
|
||||
}
|
||||
|
||||
tt, code, kbd, samp {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
}
|
||||
|
||||
.class-description {
|
||||
font-size: 130%;
|
||||
line-height: 140%;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.class-description:empty {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
#main {
|
||||
float: left;
|
||||
width: 70%;
|
||||
}
|
||||
|
||||
article dl {
|
||||
margin-bottom: 40px;
|
||||
}
|
||||
|
||||
article img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
section
|
||||
{
|
||||
display: block;
|
||||
background-color: #fff;
|
||||
padding: 12px 24px;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin-right: 30px;
|
||||
}
|
||||
|
||||
.variation {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.signature-attributes {
|
||||
font-size: 60%;
|
||||
color: #aaa;
|
||||
font-style: italic;
|
||||
font-weight: lighter;
|
||||
}
|
||||
|
||||
nav
|
||||
{
|
||||
display: block;
|
||||
float: right;
|
||||
margin-top: 28px;
|
||||
width: 30%;
|
||||
box-sizing: border-box;
|
||||
border-left: 1px solid #ccc;
|
||||
padding-left: 16px;
|
||||
}
|
||||
|
||||
nav ul {
|
||||
font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
|
||||
font-size: 100%;
|
||||
line-height: 17px;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
nav ul a, nav ul a:visited, nav ul a:active {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
line-height: 18px;
|
||||
color: #4D4E53;
|
||||
}
|
||||
|
||||
nav h3 {
|
||||
margin-top: 12px;
|
||||
}
|
||||
|
||||
nav li {
|
||||
margin-top: 6px;
|
||||
}
|
||||
|
||||
footer {
|
||||
display: block;
|
||||
padding: 6px;
|
||||
margin-top: 12px;
|
||||
font-style: italic;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4 {
|
||||
font-weight: 200;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h1
|
||||
{
|
||||
font-family: 'Open Sans Light', sans-serif;
|
||||
font-size: 48px;
|
||||
letter-spacing: -2px;
|
||||
margin: 12px 24px 20px;
|
||||
}
|
||||
|
||||
h2, h3.subsection-title
|
||||
{
|
||||
font-size: 30px;
|
||||
font-weight: 700;
|
||||
letter-spacing: -1px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
h3
|
||||
{
|
||||
font-size: 24px;
|
||||
letter-spacing: -0.5px;
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
|
||||
h4
|
||||
{
|
||||
font-size: 18px;
|
||||
letter-spacing: -0.33px;
|
||||
margin-bottom: 12px;
|
||||
color: #4d4e53;
|
||||
}
|
||||
|
||||
h5, .container-overview .subsection-title
|
||||
{
|
||||
font-size: 120%;
|
||||
font-weight: bold;
|
||||
letter-spacing: -0.01em;
|
||||
margin: 8px 0 3px 0;
|
||||
}
|
||||
|
||||
h6
|
||||
{
|
||||
font-size: 100%;
|
||||
letter-spacing: -0.01em;
|
||||
margin: 6px 0 3px 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table
|
||||
{
|
||||
border-spacing: 0;
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
td, th
|
||||
{
|
||||
border: 1px solid #ddd;
|
||||
margin: 0px;
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
padding: 4px 6px;
|
||||
display: table-cell;
|
||||
}
|
||||
|
||||
thead tr
|
||||
{
|
||||
background-color: #ddd;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
th { border-right: 1px solid #aaa; }
|
||||
tr > th:last-child { border-right: 1px solid #ddd; }
|
||||
|
||||
.ancestors, .attribs { color: #999; }
|
||||
.ancestors a, .attribs a
|
||||
{
|
||||
color: #999 !important;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.clear
|
||||
{
|
||||
clear: both;
|
||||
}
|
||||
|
||||
.important
|
||||
{
|
||||
font-weight: bold;
|
||||
color: #950B02;
|
||||
}
|
||||
|
||||
.yes-def {
|
||||
text-indent: -1000px;
|
||||
}
|
||||
|
||||
.type-signature {
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
.name, .signature {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
}
|
||||
|
||||
.details { margin-top: 14px; border-left: 2px solid #DDD; }
|
||||
.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; }
|
||||
.details dd { margin-left: 70px; }
|
||||
.details ul { margin: 0; }
|
||||
.details ul { list-style-type: none; }
|
||||
.details li { margin-left: 30px; padding-top: 6px; }
|
||||
.details pre.prettyprint { margin: 0 }
|
||||
.details .object-value { padding-top: 0; }
|
||||
|
||||
.description {
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.code-caption
|
||||
{
|
||||
font-style: italic;
|
||||
font-size: 107%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.source
|
||||
{
|
||||
border: 1px solid #ddd;
|
||||
width: 80%;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
.prettyprint.source {
|
||||
width: inherit;
|
||||
}
|
||||
|
||||
.source code
|
||||
{
|
||||
font-size: 100%;
|
||||
line-height: 18px;
|
||||
display: block;
|
||||
padding: 4px 12px;
|
||||
margin: 0;
|
||||
background-color: #fff;
|
||||
color: #4D4E53;
|
||||
}
|
||||
|
||||
.prettyprint code span.line
|
||||
{
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.prettyprint.linenums
|
||||
{
|
||||
padding-left: 70px;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
.prettyprint.linenums ol
|
||||
{
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
.prettyprint.linenums li
|
||||
{
|
||||
border-left: 3px #ddd solid;
|
||||
}
|
||||
|
||||
.prettyprint.linenums li.selected,
|
||||
.prettyprint.linenums li.selected *
|
||||
{
|
||||
background-color: lightyellow;
|
||||
}
|
||||
|
||||
.prettyprint.linenums li *
|
||||
{
|
||||
-webkit-user-select: text;
|
||||
-moz-user-select: text;
|
||||
-ms-user-select: text;
|
||||
user-select: text;
|
||||
}
|
||||
|
||||
.params .name, .props .name, .name code {
|
||||
color: #4D4E53;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.params td.description > p:first-child,
|
||||
.props td.description > p:first-child
|
||||
{
|
||||
margin-top: 0;
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
.params td.description > p:last-child,
|
||||
.props td.description > p:last-child
|
||||
{
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.disabled {
|
||||
color: #454545;
|
||||
}
|
||||
@@ -1,111 +0,0 @@
|
||||
/* JSDoc prettify.js theme */
|
||||
|
||||
/* plain text */
|
||||
.pln {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* string content */
|
||||
.str {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
font-weight: normal;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
@@ -1,132 +0,0 @@
|
||||
/* Tomorrow Theme */
|
||||
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
|
||||
/* Pretty printing styles. Used with prettify.js. */
|
||||
/* SPAN elements with the classes below are added by prettyprint. */
|
||||
/* plain text */
|
||||
.pln {
|
||||
color: #4d4d4c; }
|
||||
|
||||
@media screen {
|
||||
/* string content */
|
||||
.str {
|
||||
color: #718c00; }
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: #8959a8; }
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
color: #8e908c; }
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: #4271ae; }
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: #f5871f; }
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #4d4d4c; }
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #4d4d4c; }
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #4d4d4c; }
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #c82829; }
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #f5871f; }
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #3e999f; }
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #f5871f; }
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #c82829; }
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #4271ae; } }
|
||||
/* Use higher contrast and text-weight for printable form. */
|
||||
@media print, projection {
|
||||
.str {
|
||||
color: #060; }
|
||||
|
||||
.kwd {
|
||||
color: #006;
|
||||
font-weight: bold; }
|
||||
|
||||
.com {
|
||||
color: #600;
|
||||
font-style: italic; }
|
||||
|
||||
.typ {
|
||||
color: #404;
|
||||
font-weight: bold; }
|
||||
|
||||
.lit {
|
||||
color: #044; }
|
||||
|
||||
.pun, .opn, .clo {
|
||||
color: #440; }
|
||||
|
||||
.tag {
|
||||
color: #006;
|
||||
font-weight: bold; }
|
||||
|
||||
.atn {
|
||||
color: #404; }
|
||||
|
||||
.atv {
|
||||
color: #060; } }
|
||||
/* Style */
|
||||
/*
|
||||
pre.prettyprint {
|
||||
background: white;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 12px;
|
||||
line-height: 1.5;
|
||||
border: 1px solid #ccc;
|
||||
padding: 10px; }
|
||||
*/
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0; }
|
||||
|
||||
/* IE indents via margin-left */
|
||||
li.L0,
|
||||
li.L1,
|
||||
li.L2,
|
||||
li.L3,
|
||||
li.L4,
|
||||
li.L5,
|
||||
li.L6,
|
||||
li.L7,
|
||||
li.L8,
|
||||
li.L9 {
|
||||
/* */ }
|
||||
|
||||
/* Alternate shading for lines */
|
||||
li.L1,
|
||||
li.L3,
|
||||
li.L5,
|
||||
li.L7,
|
||||
li.L9 {
|
||||
/* */ }
|
||||
@@ -1,178 +0,0 @@
|
||||
"use strict";
|
||||
|
||||
/* eslint-disable no-undef */
|
||||
process.env.NODE_ENV = 'development';
|
||||
process.env.LOG_LEVEL = 'error';
|
||||
process.env.API_URL = 'http://localhost:3002';
|
||||
|
||||
var chai = require('chai');
|
||||
|
||||
chai.use(require('chai-http'));
|
||||
var request = chai.request.agent(process.env.API_URL);
|
||||
|
||||
var utils = require('./test-utils');
|
||||
|
||||
var expect = require('chai').expect;
|
||||
|
||||
var serverMonitor = require('../lib/api');
|
||||
|
||||
var user = require('./test-utils').user;
|
||||
|
||||
user.email = utils.generateRandomBusinessEmail();
|
||||
|
||||
var token, projectId, apiKey, _monitorId;
|
||||
|
||||
var badProjectId = 'badProjectId',
|
||||
badApiKey = 'badApiKey';
|
||||
var invalidProjectId = utils.generateRandomString();
|
||||
var timeout = 5000,
|
||||
monitor = {
|
||||
name: 'New Monitor',
|
||||
type: 'server-monitor',
|
||||
data: {}
|
||||
};
|
||||
describe('Server Monitor', function () {
|
||||
this.timeout(timeout + 1000);
|
||||
before(function (done) {
|
||||
this.timeout(30000);
|
||||
request.post('/user/signup').send(user).end(function (err, res) {
|
||||
var project = res.body.project;
|
||||
projectId = project._id;
|
||||
apiKey = project.apiKey;
|
||||
request.post('/user/login').send({
|
||||
email: user.email,
|
||||
password: user.password
|
||||
}).end(function (err, res) {
|
||||
token = res.body.tokens.jwtAccessToken;
|
||||
request.post("/monitor/".concat(projectId)).set('Authorization', "Basic ".concat(token)).send(monitor).end(function (err, res) {
|
||||
expect(res).to.have.status(200);
|
||||
expect(res.body).to.be.an('object');
|
||||
expect(res.body).to.have.property('_id');
|
||||
_monitorId = res.body._id;
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
it('Should connect when project id, api key and monitor id are provided', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: projectId,
|
||||
apiKey: apiKey,
|
||||
monitorId: _monitorId
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(stopJob).to.be.an('object');
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should connect when project id, custom api url, api key and monitor id are provided', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: projectId,
|
||||
apiUrl: 'http://localhost:3002',
|
||||
apiKey: apiKey,
|
||||
monitorId: _monitorId
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(stopJob).to.be.an('object');
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should request for monitor id when only project id and api key are provided', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: projectId,
|
||||
apiKey: apiKey,
|
||||
monitorId: function monitorId(data) {
|
||||
var filteredMonitor = data.filter(function (monitor) {
|
||||
return monitor._id === _monitorId;
|
||||
});
|
||||
|
||||
if (filteredMonitor.length > 0) {
|
||||
return _monitorId;
|
||||
}
|
||||
}
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(stopJob).to.be.an('object');
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should disconnect when project id is invalid', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: invalidProjectId,
|
||||
apiKey: badApiKey
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(job).to.haveOwnProperty('message');
|
||||
expect(job.message).to.equal('Project Id is not valid');
|
||||
expect(stopJob).to.equal(undefined);
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should disconnect when project id or api key are incorrect', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: badProjectId,
|
||||
apiKey: badApiKey
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(job).to.haveOwnProperty('message');
|
||||
expect(job.message).to.equal('No Project found with this API Key and Project ID.');
|
||||
expect(stopJob).to.equal(undefined);
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should disconnect when project id is correct and api key is incorrect', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: projectId,
|
||||
apiKey: badApiKey
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(job).to.haveOwnProperty('message');
|
||||
expect(job.message).to.equal('No Project found with this API Key and Project ID.');
|
||||
expect(stopJob).to.equal(undefined);
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should disconnect when project id is incorrect and api key is correct', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: badProjectId,
|
||||
apiKey: apiKey
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
var stopJob = monitor.stop();
|
||||
expect(job).to.be.an('object');
|
||||
expect(job).to.haveOwnProperty('message');
|
||||
expect(job.message).to.equal('No Project found with this API Key and Project ID.');
|
||||
expect(stopJob).to.equal(undefined);
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('Should disconnect when timeout provided is exceeded', function (done) {
|
||||
var monitor = serverMonitor({
|
||||
projectId: projectId,
|
||||
apiKey: apiKey,
|
||||
monitorId: _monitorId,
|
||||
timeout: timeout
|
||||
});
|
||||
monitor.start().then(function (job) {
|
||||
expect(job).to.be.an('object');
|
||||
expect(job).to.have.property('running');
|
||||
expect(job.running).to.equal(true);
|
||||
setTimeout(function () {
|
||||
expect(job.running).to.equal(false);
|
||||
done();
|
||||
}, timeout);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,37 +0,0 @@
|
||||
"use strict";
|
||||
|
||||
module.exports = {
|
||||
user: {
|
||||
name: 'John Smith',
|
||||
password: '1234567890',
|
||||
confirmPassword: '1234567890',
|
||||
companyName: 'Hackerbay',
|
||||
jobRole: 'Engineer',
|
||||
companySize: 10,
|
||||
card: {
|
||||
stripeToken: 'tok_visa'
|
||||
},
|
||||
subscription: {
|
||||
stripePlanId: 0
|
||||
},
|
||||
cardName: 'Mastercard',
|
||||
cardNumber: '5555555555554444',
|
||||
cvv: '123',
|
||||
expiry: '01/2020',
|
||||
city: 'New York',
|
||||
state: 'New York',
|
||||
zipCode: '111000111',
|
||||
country: 'Iceland',
|
||||
planId: 'plan_EgTJMZULfh6THW',
|
||||
companyRole: 'Snr. Developer',
|
||||
companyPhoneNumber: '+919910568840',
|
||||
reference: 'Github'
|
||||
},
|
||||
generateRandomString: function generateRandomString() {
|
||||
return 'str' + // Prevent strings starting with numbers
|
||||
Math.random().toString(36).substring(10);
|
||||
},
|
||||
generateRandomBusinessEmail: function generateRandomBusinessEmail() {
|
||||
return "".concat(Math.random().toString(36).substring(7), "@").concat(Math.random().toString(36).substring(5), ".com");
|
||||
}
|
||||
};
|
||||
278
js-sdk/dist/fyipe.js
vendored
278
js-sdk/dist/fyipe.js
vendored
File diff suppressed because one or more lines are too long
287
js-sdk/dist/fyipe.min.js
vendored
287
js-sdk/dist/fyipe.min.js
vendored
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user