@beforeyoubid/logger-adapter 1.0.11 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +55 -127
- package/dist/console/logWrapper.d.ts +4 -0
- package/dist/index.d.ts +2 -1
- package/dist/logger/index.d.ts +1 -1
- package/dist/logger/logdnaClient.d.ts +19 -0
- package/dist/logger/logger.d.ts +12 -2
- package/dist/logger/util.d.ts +11 -0
- package/dist/params.d.ts +1 -1
- package/dist/src/__tests__/params.spec.js +84 -0
- package/dist/src/console/__tests__/consoleLogger.spec.js +18 -0
- package/dist/src/console/index.js +44 -0
- package/dist/src/console/logWrapper.js +99 -0
- package/dist/src/consts.js +13 -0
- package/dist/src/index.js +40 -0
- package/dist/src/logger/__tests__/index.spec.js +24 -0
- package/dist/src/logger/__tests__/logger.spec.js +139 -0
- package/dist/src/logger/__tests__/util.spec.js +81 -0
- package/dist/src/logger/index.js +17 -0
- package/dist/src/logger/logdnaClient.js +47 -0
- package/dist/src/logger/logger.js +61 -0
- package/dist/src/logger/util.js +57 -0
- package/dist/src/params.js +66 -0
- package/dist/src/transports/logdnaWinston.js +267 -0
- package/dist/src/types.js +6 -0
- package/dist/src/util.js +328 -0
- package/dist/transports/logdnaWinston.d.ts +28 -0
- package/dist/types.d.ts +5 -5
- package/dist/util.d.ts +1 -0
- package/package.json +35 -24
- package/dist/console/index.js +0 -29
- package/dist/console/logger.d.ts +0 -4
- package/dist/console/logger.js +0 -51
- package/dist/consts.js +0 -5
- package/dist/flush.d.ts +0 -29
- package/dist/flush.js +0 -80
- package/dist/index.js +0 -13
- package/dist/logger/index.js +0 -8
- package/dist/logger/logger.js +0 -32
- package/dist/params.js +0 -40
- package/dist/types.js +0 -2
- package/dist/util.js +0 -96
- package/src/console/index.ts +0 -33
- package/src/console/logger.ts +0 -62
- package/src/consts.ts +0 -3
- package/src/index.ts +0 -5
- package/src/logger/index.ts +0 -7
- package/src/logger/logger.ts +0 -41
- package/src/params.ts +0 -53
- package/src/types.ts +0 -23
- package/src/util.ts +0 -89
package/package.json
CHANGED
|
@@ -1,22 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@beforeyoubid/logger-adapter",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "A platform logger module to send the log messages to LogDNA.",
|
|
3
|
+
"version": "2.0.0",
|
|
4
|
+
"description": "A platform logger module to send the log messages to Mezmo (formerly LogDNA).",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"files": [
|
|
8
|
-
"dist/**/*"
|
|
9
|
-
"src/**/*"
|
|
8
|
+
"dist/**/*"
|
|
10
9
|
],
|
|
11
10
|
"scripts": {
|
|
12
11
|
"lint": "eslint --max-warnings 0 '**/*.{ts,tsx,js,jsx}' && tsc --noEmit",
|
|
13
12
|
"lint:fix": "eslint --fix --max-warnings 0 '**/*.{ts,tsx,js,jsx}'",
|
|
14
|
-
"test": "yarn build && jest
|
|
15
|
-
"test:coverage": "yarn build && jest --
|
|
16
|
-
"test:ci": "
|
|
17
|
-
"test-only": "jest
|
|
18
|
-
"build": "
|
|
19
|
-
"build
|
|
13
|
+
"test": "yarn build && jest",
|
|
14
|
+
"test:coverage": "yarn build && jest --watch --coverage",
|
|
15
|
+
"test:ci": "jest --verbose=false --coverage",
|
|
16
|
+
"test-only": "jest",
|
|
17
|
+
"build": "rimraf dist && npm run build:types && npm run build:js",
|
|
18
|
+
"build:types": "tsc --emitDeclarationOnly --declaration --project tsconfig.build.json",
|
|
19
|
+
"build:js": "swc src --out-dir dist --extensions \".ts,.tsx\" --source-maps inline --ignore=.spec.js",
|
|
20
|
+
"ts": "tsc --noEmit",
|
|
21
|
+
"build-and-publish": "npm run build && npm publish --access public",
|
|
22
|
+
"build-and-publish-dryrun": "npm run build && npm publish --dry-run",
|
|
23
|
+
"build-and-publish-dryrun-ci": "npm run build && npm publish --registry http://localhost:4873"
|
|
20
24
|
},
|
|
21
25
|
"repository": {
|
|
22
26
|
"type": "git",
|
|
@@ -30,22 +34,29 @@
|
|
|
30
34
|
},
|
|
31
35
|
"homepage": "https://github.com/beforeyoubid/npm-logger-adapter#readme",
|
|
32
36
|
"dependencies": {
|
|
33
|
-
"logdna": "^
|
|
34
|
-
"
|
|
35
|
-
"winston": "^
|
|
37
|
+
"@logdna/logger": "^2.6.9",
|
|
38
|
+
"winston": "^3.13.0",
|
|
39
|
+
"winston-transport": "^4.7.0"
|
|
36
40
|
},
|
|
37
41
|
"devDependencies": {
|
|
38
|
-
"@
|
|
39
|
-
"@
|
|
40
|
-
"@
|
|
41
|
-
"@
|
|
42
|
-
"
|
|
43
|
-
"eslint-
|
|
44
|
-
"eslint
|
|
45
|
-
"
|
|
46
|
-
"
|
|
47
|
-
"
|
|
48
|
-
"
|
|
42
|
+
"@swc/cli": "^0.4.0",
|
|
43
|
+
"@swc/core": "^1.6.6",
|
|
44
|
+
"@swc/jest": "^0.2.36",
|
|
45
|
+
"@types/jest": "^29.5.12",
|
|
46
|
+
"@types/node": "18.13.0",
|
|
47
|
+
"@typescript-eslint/eslint-plugin": "5.52.0",
|
|
48
|
+
"@typescript-eslint/parser": "5.52.0",
|
|
49
|
+
"danger": "11.2.3",
|
|
50
|
+
"danger-plugin-yarn": "1.6.0",
|
|
51
|
+
"eslint": "8.34.0",
|
|
52
|
+
"eslint-config-prettier": "8.6.0",
|
|
53
|
+
"eslint-plugin-prettier": "4.2.1",
|
|
54
|
+
"jest": "^29.7.0",
|
|
55
|
+
"jest-junit": "15.0.0",
|
|
56
|
+
"prettier": "2.8.4",
|
|
57
|
+
"rimraf": "^4.1.2",
|
|
58
|
+
"ts-node": "^10.9.1",
|
|
59
|
+
"typescript": "4.9.5"
|
|
49
60
|
},
|
|
50
61
|
"resolutions": {
|
|
51
62
|
"colors": "1.4.0"
|
package/dist/console/index.js
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.consoleLogger = void 0;
|
|
4
|
-
const params_1 = require("../params");
|
|
5
|
-
const logger_1 = require("./logger");
|
|
6
|
-
const util_1 = require("../util");
|
|
7
|
-
let loggerObject;
|
|
8
|
-
const logParams = params_1.getLogParams();
|
|
9
|
-
/**
|
|
10
|
-
* Initialise and wrap the native console object
|
|
11
|
-
* @param params
|
|
12
|
-
*/
|
|
13
|
-
const init = (params = logParams) => {
|
|
14
|
-
// If has wrapped already, don't do it again
|
|
15
|
-
if (!!loggerObject)
|
|
16
|
-
return;
|
|
17
|
-
const { logDNAKey, sendToRemote } = params;
|
|
18
|
-
const isEnabled = util_1.isLogDNAEnabled(logDNAKey, sendToRemote);
|
|
19
|
-
// Wrap console object
|
|
20
|
-
loggerObject = isEnabled ? logger_1.getLogger(params) : {};
|
|
21
|
-
if (!isEnabled) {
|
|
22
|
-
console.info(`LOGDNA is disabled`);
|
|
23
|
-
}
|
|
24
|
-
};
|
|
25
|
-
const consoleLogger = {
|
|
26
|
-
init,
|
|
27
|
-
flushAll: util_1.flushAll,
|
|
28
|
-
};
|
|
29
|
-
exports.consoleLogger = consoleLogger;
|
package/dist/console/logger.d.ts
DELETED
package/dist/console/logger.js
DELETED
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getDefaultConsoleLog = exports.getLogger = void 0;
|
|
4
|
-
const LogDNALogger = require('logdna');
|
|
5
|
-
const { flushAll } = require('../util');
|
|
6
|
-
let logger;
|
|
7
|
-
// Default console
|
|
8
|
-
const _log = console.log;
|
|
9
|
-
const _info = console.info;
|
|
10
|
-
const _warn = console.warn;
|
|
11
|
-
const _error = console.error;
|
|
12
|
-
const wrapConsole = (logger, logLevel) => {
|
|
13
|
-
_log('--------------------- Wrapping Console -----------------------');
|
|
14
|
-
const log = function (...args) {
|
|
15
|
-
if (logLevel === 'debug') {
|
|
16
|
-
logger.debug([...args].join(' '));
|
|
17
|
-
}
|
|
18
|
-
_log(...args);
|
|
19
|
-
};
|
|
20
|
-
const info = function (...args) {
|
|
21
|
-
if (['debug', 'info'].indexOf(logLevel) !== -1) {
|
|
22
|
-
logger.info([...args].join(' '));
|
|
23
|
-
}
|
|
24
|
-
_info(...args);
|
|
25
|
-
};
|
|
26
|
-
const warn = function (...args) {
|
|
27
|
-
logger.warn([...args].join(' '));
|
|
28
|
-
_warn(...args);
|
|
29
|
-
};
|
|
30
|
-
const error = function (...args) {
|
|
31
|
-
logger.error([...args].join(' '));
|
|
32
|
-
_error(...args);
|
|
33
|
-
};
|
|
34
|
-
console.log = log;
|
|
35
|
-
console.debug = log;
|
|
36
|
-
console.info = info;
|
|
37
|
-
console.warn = warn;
|
|
38
|
-
console.error = error;
|
|
39
|
-
};
|
|
40
|
-
const getLogger = (params) => {
|
|
41
|
-
const { logDNAKey, logLevel, logDNAOptions } = params;
|
|
42
|
-
logger = LogDNALogger.setupDefaultLogger(logDNAKey, logDNAOptions);
|
|
43
|
-
// Wrap default
|
|
44
|
-
wrapConsole(logger, logLevel);
|
|
45
|
-
// Attach flushAll
|
|
46
|
-
logger.flushAll = flushAll;
|
|
47
|
-
return logger;
|
|
48
|
-
};
|
|
49
|
-
exports.getLogger = getLogger;
|
|
50
|
-
const getDefaultConsoleLog = () => _log;
|
|
51
|
-
exports.getDefaultConsoleLog = getDefaultConsoleLog;
|
package/dist/consts.js
DELETED
package/dist/flush.d.ts
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import { LambdaHandlerWithAsyncFunction, LambdaHandlerWithCallbackFunction } from './types';
|
|
2
|
-
/**
|
|
3
|
-
* REturn if we need to suppress flushAll on a local machine
|
|
4
|
-
*/
|
|
5
|
-
export declare const suppressFlushAll: () => boolean;
|
|
6
|
-
export declare const sleep: (time: number) => Promise<void>;
|
|
7
|
-
/**
|
|
8
|
-
* Send all log messages to LogDNA before lambda is terminated
|
|
9
|
-
*/
|
|
10
|
-
export declare const flushAll: () => Promise<void>;
|
|
11
|
-
/**
|
|
12
|
-
* Fallback promise just in
|
|
13
|
-
*/
|
|
14
|
-
export declare const timeoutPromise: () => Promise<unknown>;
|
|
15
|
-
/**
|
|
16
|
-
* Lambda wrapper to ensure we flush messages before returning the response
|
|
17
|
-
* @param lambdaHandler
|
|
18
|
-
*/
|
|
19
|
-
export declare const ensureFlushAll: (lambdaHandler: LambdaHandlerWithAsyncFunction) => LambdaHandlerWithAsyncFunction;
|
|
20
|
-
/**
|
|
21
|
-
* A Lambda wrapper to ensure we flush messages before a Lambda function get terminated
|
|
22
|
-
* NOTE: For non-async handlers, AWS Lambda will wait until the event loop is completed.
|
|
23
|
-
* This means after a callback function is called, a Lambda function still run
|
|
24
|
-
* and we can catch the final clean up.
|
|
25
|
-
* REF: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html
|
|
26
|
-
*
|
|
27
|
-
* @param lambdaHandler
|
|
28
|
-
*/
|
|
29
|
-
export declare const ensureFlushAllCallback: (lambdaHandler: LambdaHandlerWithCallbackFunction) => LambdaHandlerWithCallbackFunction;
|
package/dist/flush.js
DELETED
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
-
});
|
|
10
|
-
};
|
|
11
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.ensureFlushAllCallback = exports.ensureFlushAll = exports.timeoutPromise = exports.flushAll = exports.sleep = exports.suppressFlushAll = void 0;
|
|
13
|
-
const logger_1 = require("./logger");
|
|
14
|
-
const debug = require('util').debuglog('logger-adapter');
|
|
15
|
-
const { once } = require('events');
|
|
16
|
-
const { FALLBACK_TIMEOUT_AFTER_FLUSHING } = require('./consts');
|
|
17
|
-
const { getLogParams } = require('./params');
|
|
18
|
-
// timeout
|
|
19
|
-
let timeout;
|
|
20
|
-
/**
|
|
21
|
-
* REturn if we need to suppress flushAll on a local machine
|
|
22
|
-
*/
|
|
23
|
-
exports.suppressFlushAll = () => { var _a; return ((_a = getLogParams()) === null || _a === void 0 ? void 0 : _a.logDNASuppressFlushAll) || false; };
|
|
24
|
-
exports.sleep = (time) => new Promise((resolve) => setTimeout(resolve, time));
|
|
25
|
-
/**
|
|
26
|
-
* Send all log messages to LogDNA before lambda is terminated
|
|
27
|
-
*/
|
|
28
|
-
exports.flushAll = () => {
|
|
29
|
-
debug('Flushing all logs...');
|
|
30
|
-
return new Promise(resolve => logger_1.logdnaTransport.Logger.flushAll(resolve));
|
|
31
|
-
};
|
|
32
|
-
/**
|
|
33
|
-
* Fallback promise just in
|
|
34
|
-
*/
|
|
35
|
-
exports.timeoutPromise = () => {
|
|
36
|
-
return new Promise(resolve => {
|
|
37
|
-
timeout = setTimeout(() => {
|
|
38
|
-
debug('Flushing timeout has reached. Ignore flushing messages...');
|
|
39
|
-
resolve();
|
|
40
|
-
}, FALLBACK_TIMEOUT_AFTER_FLUSHING);
|
|
41
|
-
});
|
|
42
|
-
};
|
|
43
|
-
/**
|
|
44
|
-
* Lambda wrapper to ensure we flush messages before returning the response
|
|
45
|
-
* @param lambdaHandler
|
|
46
|
-
*/
|
|
47
|
-
exports.ensureFlushAll = (lambdaHandler) => {
|
|
48
|
-
return (event, context) => __awaiter(void 0, void 0, void 0, function* () {
|
|
49
|
-
try {
|
|
50
|
-
const result = yield lambdaHandler(event, context);
|
|
51
|
-
if (!exports.suppressFlushAll())
|
|
52
|
-
yield Promise.race([exports.flushAll(), exports.timeoutPromise()]);
|
|
53
|
-
return result;
|
|
54
|
-
}
|
|
55
|
-
catch (e) {
|
|
56
|
-
if (!exports.suppressFlushAll())
|
|
57
|
-
yield Promise.race([exports.flushAll(), exports.timeoutPromise()]);
|
|
58
|
-
throw e;
|
|
59
|
-
}
|
|
60
|
-
});
|
|
61
|
-
};
|
|
62
|
-
/**
|
|
63
|
-
* A Lambda wrapper to ensure we flush messages before a Lambda function get terminated
|
|
64
|
-
* NOTE: For non-async handlers, AWS Lambda will wait until the event loop is completed.
|
|
65
|
-
* This means after a callback function is called, a Lambda function still run
|
|
66
|
-
* and we can catch the final clean up.
|
|
67
|
-
* REF: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html
|
|
68
|
-
*
|
|
69
|
-
* @param lambdaHandler
|
|
70
|
-
*/
|
|
71
|
-
exports.ensureFlushAllCallback = (lambdaHandler) => {
|
|
72
|
-
return (event, context, callback) => {
|
|
73
|
-
const thisCallback = (error, result) => {
|
|
74
|
-
callback(error, result);
|
|
75
|
-
if (!exports.suppressFlushAll())
|
|
76
|
-
exports.flushAll();
|
|
77
|
-
};
|
|
78
|
-
lambdaHandler(event, context, thisCallback);
|
|
79
|
-
};
|
|
80
|
-
};
|
package/dist/index.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ensureFlushAllCallback = exports.ensureFlushAll = exports.flushAll = exports.getLogParams = exports.logger = exports.consoleLogger = void 0;
|
|
4
|
-
const console_1 = require("./console");
|
|
5
|
-
Object.defineProperty(exports, "consoleLogger", { enumerable: true, get: function () { return console_1.consoleLogger; } });
|
|
6
|
-
const logger_1 = require("./logger");
|
|
7
|
-
Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });
|
|
8
|
-
const params_1 = require("./params");
|
|
9
|
-
Object.defineProperty(exports, "getLogParams", { enumerable: true, get: function () { return params_1.getLogParams; } });
|
|
10
|
-
const util_1 = require("./util");
|
|
11
|
-
Object.defineProperty(exports, "flushAll", { enumerable: true, get: function () { return util_1.flushAll; } });
|
|
12
|
-
Object.defineProperty(exports, "ensureFlushAll", { enumerable: true, get: function () { return util_1.ensureFlushAll; } });
|
|
13
|
-
Object.defineProperty(exports, "ensureFlushAllCallback", { enumerable: true, get: function () { return util_1.ensureFlushAllCallback; } });
|
package/dist/logger/index.js
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.logger = void 0;
|
|
4
|
-
const params_1 = require("../params");
|
|
5
|
-
const logger_1 = require("./logger");
|
|
6
|
-
const logParams = params_1.getLogParams();
|
|
7
|
-
const logger = logger_1.getLogger(logParams);
|
|
8
|
-
exports.logger = logger;
|
package/dist/logger/logger.js
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getLogger = void 0;
|
|
4
|
-
const logdnaWinston = require('logdna-winston');
|
|
5
|
-
const winston = require('winston');
|
|
6
|
-
const { isLogDNAEnabled } = require('../util');
|
|
7
|
-
const { format, transports } = winston;
|
|
8
|
-
const createWinstonLogger = (logLevel) => {
|
|
9
|
-
const logger = winston.createLogger({
|
|
10
|
-
level: logLevel || 'info',
|
|
11
|
-
format: format.combine(format.timestamp(), format.simple(), format.printf((info) => `${info.timestamp} - ${info.level}: ${info.message}`)),
|
|
12
|
-
transports: [
|
|
13
|
-
new transports.Console({
|
|
14
|
-
format: format.combine(format.timestamp(), format.simple(), format.printf((info) => `${info.timestamp} - ${info.level}: ${info.message}`), format.colorize({ all: true })),
|
|
15
|
-
}),
|
|
16
|
-
],
|
|
17
|
-
});
|
|
18
|
-
return logger;
|
|
19
|
-
};
|
|
20
|
-
const getLogger = (params) => {
|
|
21
|
-
const { logLevel, logDNAOptions, logDNAKey, sendToRemote } = params;
|
|
22
|
-
const isEnabled = isLogDNAEnabled(logDNAKey, sendToRemote);
|
|
23
|
-
const logger = createWinstonLogger(logLevel);
|
|
24
|
-
if (isEnabled) {
|
|
25
|
-
logger.add(new logdnaWinston(logDNAOptions));
|
|
26
|
-
}
|
|
27
|
-
else {
|
|
28
|
-
logger.info(`LOGDNA is disabled`);
|
|
29
|
-
}
|
|
30
|
-
return logger;
|
|
31
|
-
};
|
|
32
|
-
exports.getLogger = getLogger;
|
package/dist/params.js
DELETED
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.sendToRemote = exports.getLogParams = void 0;
|
|
4
|
-
const getEnvs = (env = (process === null || process === void 0 ? void 0 : process.env) || {}) => {
|
|
5
|
-
const { LOG_LEVEL = 'info', LOGDNA_KEY = '', STAGE = 'n/a', AWS_LAMBDA_FUNCTION_NAME = 'n/a', LOGDNA_ENABLED = 'true', LOGDNA_SUPPRESS_FLUSH_ALL = 'false', } = env;
|
|
6
|
-
return {
|
|
7
|
-
LOG_LEVEL,
|
|
8
|
-
LOGDNA_KEY,
|
|
9
|
-
STAGE,
|
|
10
|
-
AWS_LAMBDA_FUNCTION_NAME,
|
|
11
|
-
LOGDNA_ENABLED,
|
|
12
|
-
LOGDNA_SUPPRESS_FLUSH_ALL,
|
|
13
|
-
};
|
|
14
|
-
};
|
|
15
|
-
const sendToRemote = (logDNAKey, logDNAEnabled) => {
|
|
16
|
-
return !!logDNAKey && logDNAEnabled === 'true';
|
|
17
|
-
};
|
|
18
|
-
exports.sendToRemote = sendToRemote;
|
|
19
|
-
const getLogParams = (env = (process === null || process === void 0 ? void 0 : process.env) || {}) => {
|
|
20
|
-
const { LOG_LEVEL, LOGDNA_KEY, STAGE, AWS_LAMBDA_FUNCTION_NAME, LOGDNA_ENABLED, LOGDNA_SUPPRESS_FLUSH_ALL } = getEnvs(env);
|
|
21
|
-
const logDNAOptions = {
|
|
22
|
-
key: LOGDNA_KEY,
|
|
23
|
-
env: STAGE,
|
|
24
|
-
app: AWS_LAMBDA_FUNCTION_NAME,
|
|
25
|
-
hostname: STAGE,
|
|
26
|
-
index_meta: true,
|
|
27
|
-
tags: [AWS_LAMBDA_FUNCTION_NAME, STAGE],
|
|
28
|
-
level: LOG_LEVEL,
|
|
29
|
-
handleExceptions: true,
|
|
30
|
-
};
|
|
31
|
-
return {
|
|
32
|
-
logLevel: LOG_LEVEL,
|
|
33
|
-
logDNAKey: LOGDNA_KEY,
|
|
34
|
-
sendToRemote: sendToRemote(LOGDNA_KEY, LOGDNA_ENABLED),
|
|
35
|
-
logDNASuppressFlushAll: LOGDNA_SUPPRESS_FLUSH_ALL === 'true',
|
|
36
|
-
functionName: AWS_LAMBDA_FUNCTION_NAME,
|
|
37
|
-
logDNAOptions,
|
|
38
|
-
};
|
|
39
|
-
};
|
|
40
|
-
exports.getLogParams = getLogParams;
|
package/dist/types.js
DELETED
package/dist/util.js
DELETED
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
-
});
|
|
10
|
-
};
|
|
11
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.ensureFlushAllCallback = exports.ensureFlushAll = exports.flushAll = exports.isLogDNAEnabled = void 0;
|
|
13
|
-
const LogDNALogger = require('logdna');
|
|
14
|
-
const debug = require('util').debuglog('logger-adapter');
|
|
15
|
-
const { FALLBACK_TIMEOUT_AFTER_FLUSHING } = require('./consts');
|
|
16
|
-
const { getLogParams } = require('./params');
|
|
17
|
-
// timeout
|
|
18
|
-
let timeout;
|
|
19
|
-
/**
|
|
20
|
-
* Handy function to check if we are sending to LogDNA
|
|
21
|
-
* @param logDNAKey
|
|
22
|
-
* @param sendToRemote
|
|
23
|
-
*/
|
|
24
|
-
const isLogDNAEnabled = (logDNAKey, sendToRemote) => !!logDNAKey && sendToRemote;
|
|
25
|
-
exports.isLogDNAEnabled = isLogDNAEnabled;
|
|
26
|
-
/**
|
|
27
|
-
* REturn if we need to suppress flushAll on a local machine
|
|
28
|
-
*/
|
|
29
|
-
const suppressFlushAll = () => { var _a; return ((_a = getLogParams()) === null || _a === void 0 ? void 0 : _a.logDNASuppressFlushAll) || false; };
|
|
30
|
-
/**
|
|
31
|
-
* Send all log messages to LogDNA before lambda is terminated
|
|
32
|
-
*/
|
|
33
|
-
const flushAll = () => __awaiter(void 0, void 0, void 0, function* () {
|
|
34
|
-
return new Promise(resolve => {
|
|
35
|
-
debug('Flushing all logs...');
|
|
36
|
-
LogDNALogger.flushAll(() => {
|
|
37
|
-
debug('Completed flushing all log messages');
|
|
38
|
-
if (timeout) {
|
|
39
|
-
clearTimeout(timeout);
|
|
40
|
-
}
|
|
41
|
-
resolve();
|
|
42
|
-
});
|
|
43
|
-
});
|
|
44
|
-
});
|
|
45
|
-
exports.flushAll = flushAll;
|
|
46
|
-
/**
|
|
47
|
-
* Fallback promise just in
|
|
48
|
-
*/
|
|
49
|
-
const timeoutPromise = () => {
|
|
50
|
-
return new Promise(resolve => {
|
|
51
|
-
timeout = setTimeout(() => {
|
|
52
|
-
debug('Flushing timeout has reached. Ignore flushing messages...');
|
|
53
|
-
resolve();
|
|
54
|
-
}, FALLBACK_TIMEOUT_AFTER_FLUSHING);
|
|
55
|
-
});
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* Lambda wrapper to ensure we flush messages before returning the response
|
|
59
|
-
* @param lambdaHandler
|
|
60
|
-
*/
|
|
61
|
-
const ensureFlushAll = (lambdaHandler) => {
|
|
62
|
-
return (event, context) => __awaiter(void 0, void 0, void 0, function* () {
|
|
63
|
-
try {
|
|
64
|
-
const result = yield lambdaHandler(event, context);
|
|
65
|
-
if (!suppressFlushAll())
|
|
66
|
-
yield Promise.race([flushAll(), timeoutPromise()]);
|
|
67
|
-
return result;
|
|
68
|
-
}
|
|
69
|
-
catch (e) {
|
|
70
|
-
if (!suppressFlushAll())
|
|
71
|
-
yield Promise.race([flushAll(), timeoutPromise()]);
|
|
72
|
-
throw e;
|
|
73
|
-
}
|
|
74
|
-
});
|
|
75
|
-
};
|
|
76
|
-
exports.ensureFlushAll = ensureFlushAll;
|
|
77
|
-
/**
|
|
78
|
-
* A Lambda wrapper to ensure we flush messages before a Lambda function get terminated
|
|
79
|
-
* NOTE: For non-async handlers, AWS Lambda will wait until the event loop is completed.
|
|
80
|
-
* This means after a callback function is called, a Lambda function still run
|
|
81
|
-
* and we can catch the final clean up.
|
|
82
|
-
* REF: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html
|
|
83
|
-
*
|
|
84
|
-
* @param lambdaHandler
|
|
85
|
-
*/
|
|
86
|
-
const ensureFlushAllCallback = (lambdaHandler) => {
|
|
87
|
-
return (event, context, callback) => {
|
|
88
|
-
const thisCallback = (error, result) => {
|
|
89
|
-
callback(error, result);
|
|
90
|
-
if (!suppressFlushAll())
|
|
91
|
-
flushAll();
|
|
92
|
-
};
|
|
93
|
-
lambdaHandler(event, context, thisCallback);
|
|
94
|
-
};
|
|
95
|
-
};
|
|
96
|
-
exports.ensureFlushAllCallback = ensureFlushAllCallback;
|
package/src/console/index.ts
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
import { ILogDNAParams } from '../types';
|
|
2
|
-
|
|
3
|
-
import { getLogParams } from '../params';
|
|
4
|
-
import { getLogger } from './logger';
|
|
5
|
-
import { isLogDNAEnabled, flushAll } from '../util';
|
|
6
|
-
|
|
7
|
-
let loggerObject: any;
|
|
8
|
-
const logParams = getLogParams();
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* Initialise and wrap the native console object
|
|
12
|
-
* @param params
|
|
13
|
-
*/
|
|
14
|
-
const init = (params: ILogDNAParams = logParams): void => {
|
|
15
|
-
// If has wrapped already, don't do it again
|
|
16
|
-
if (!!loggerObject) return;
|
|
17
|
-
|
|
18
|
-
const { logDNAKey, sendToRemote } = params;
|
|
19
|
-
const isEnabled = isLogDNAEnabled(logDNAKey, sendToRemote);
|
|
20
|
-
|
|
21
|
-
// Wrap console object
|
|
22
|
-
loggerObject = isEnabled ? getLogger(params) : {};
|
|
23
|
-
if (!isEnabled) {
|
|
24
|
-
console.info(`LOGDNA is disabled`);
|
|
25
|
-
}
|
|
26
|
-
};
|
|
27
|
-
|
|
28
|
-
const consoleLogger = {
|
|
29
|
-
init,
|
|
30
|
-
flushAll,
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
export { consoleLogger };
|
package/src/console/logger.ts
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
import { ILogDNAParams } from '../types';
|
|
2
|
-
const LogDNALogger = require('logdna');
|
|
3
|
-
const { flushAll } = require('../util');
|
|
4
|
-
let logger: any;
|
|
5
|
-
|
|
6
|
-
// Default console
|
|
7
|
-
const _log = console.log;
|
|
8
|
-
const _info = console.info;
|
|
9
|
-
const _warn = console.warn;
|
|
10
|
-
const _error = console.error;
|
|
11
|
-
|
|
12
|
-
const wrapConsole = (logger: any, logLevel: string): void => {
|
|
13
|
-
_log('--------------------- Wrapping Console -----------------------');
|
|
14
|
-
|
|
15
|
-
const log = function (...args: any[]) {
|
|
16
|
-
if (logLevel === 'debug') {
|
|
17
|
-
logger.debug([...args].join(' '));
|
|
18
|
-
}
|
|
19
|
-
_log(...args);
|
|
20
|
-
};
|
|
21
|
-
|
|
22
|
-
const info = function (...args: any[]) {
|
|
23
|
-
if (['debug', 'info'].indexOf(logLevel) !== -1) {
|
|
24
|
-
logger.info([...args].join(' '));
|
|
25
|
-
}
|
|
26
|
-
_info(...args);
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
const warn = function (...args: any[]) {
|
|
30
|
-
logger.warn([...args].join(' '));
|
|
31
|
-
_warn(...args);
|
|
32
|
-
};
|
|
33
|
-
|
|
34
|
-
const error = function (...args: any[]) {
|
|
35
|
-
logger.error([...args].join(' '));
|
|
36
|
-
_error(...args);
|
|
37
|
-
};
|
|
38
|
-
|
|
39
|
-
console.log = log;
|
|
40
|
-
console.debug = log;
|
|
41
|
-
console.info = info;
|
|
42
|
-
console.warn = warn;
|
|
43
|
-
console.error = error;
|
|
44
|
-
};
|
|
45
|
-
|
|
46
|
-
const getLogger = (params: ILogDNAParams): any => {
|
|
47
|
-
const { logDNAKey, logLevel, logDNAOptions } = params;
|
|
48
|
-
|
|
49
|
-
logger = LogDNALogger.setupDefaultLogger(logDNAKey, logDNAOptions);
|
|
50
|
-
|
|
51
|
-
// Wrap default
|
|
52
|
-
wrapConsole(logger, logLevel);
|
|
53
|
-
|
|
54
|
-
// Attach flushAll
|
|
55
|
-
logger.flushAll = flushAll;
|
|
56
|
-
|
|
57
|
-
return logger;
|
|
58
|
-
};
|
|
59
|
-
|
|
60
|
-
const getDefaultConsoleLog = (): any => _log;
|
|
61
|
-
|
|
62
|
-
export { getLogger, getDefaultConsoleLog };
|
package/src/consts.ts
DELETED
package/src/index.ts
DELETED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { consoleLogger } from './console';
|
|
2
|
-
import { logger } from './logger';
|
|
3
|
-
import { getLogParams } from './params';
|
|
4
|
-
import { flushAll, ensureFlushAll, ensureFlushAllCallback } from './util';
|
|
5
|
-
export { consoleLogger, logger, getLogParams, flushAll, ensureFlushAll, ensureFlushAllCallback };
|
package/src/logger/index.ts
DELETED
package/src/logger/logger.ts
DELETED
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
import { ILogDNAParams } from '../types';
|
|
2
|
-
const logdnaWinston = require('logdna-winston');
|
|
3
|
-
const winston = require('winston');
|
|
4
|
-
const { isLogDNAEnabled } = require('../util');
|
|
5
|
-
const { format, transports } = winston;
|
|
6
|
-
|
|
7
|
-
const createWinstonLogger = (logLevel: string) => {
|
|
8
|
-
const logger = winston.createLogger({
|
|
9
|
-
level: logLevel || 'info',
|
|
10
|
-
format: format.combine(
|
|
11
|
-
format.timestamp(),
|
|
12
|
-
format.simple(),
|
|
13
|
-
format.printf((info: any) => `${info.timestamp} - ${info.level}: ${info.message}`)
|
|
14
|
-
),
|
|
15
|
-
transports: [
|
|
16
|
-
new transports.Console({
|
|
17
|
-
format: format.combine(
|
|
18
|
-
format.timestamp(),
|
|
19
|
-
format.simple(),
|
|
20
|
-
format.printf((info: any) => `${info.timestamp} - ${info.level}: ${info.message}`),
|
|
21
|
-
format.colorize({ all: true })
|
|
22
|
-
),
|
|
23
|
-
}),
|
|
24
|
-
],
|
|
25
|
-
});
|
|
26
|
-
return logger;
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
const getLogger = (params: ILogDNAParams): any => {
|
|
30
|
-
const { logLevel, logDNAOptions, logDNAKey, sendToRemote } = params;
|
|
31
|
-
const isEnabled = isLogDNAEnabled(logDNAKey, sendToRemote);
|
|
32
|
-
const logger = createWinstonLogger(logLevel);
|
|
33
|
-
if (isEnabled) {
|
|
34
|
-
logger.add(new logdnaWinston(logDNAOptions));
|
|
35
|
-
} else {
|
|
36
|
-
logger.info(`LOGDNA is disabled`);
|
|
37
|
-
}
|
|
38
|
-
return logger;
|
|
39
|
-
};
|
|
40
|
-
|
|
41
|
-
export { getLogger };
|