@kcuf/sls-logger-base 0.0.1 → 0.0.2
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 +2 -2
- package/dist/cjs/class/sls-logger.js +4 -4
- package/dist/cjs/util/flatten-object.js +4 -4
- package/dist/cjs/util/flatten-should-ignore.js +1 -1
- package/dist/esm/class/sls-logger.js +4 -4
- package/dist/esm/class/sls-logger.js.map +1 -1
- package/dist/esm/types/common.js.map +1 -1
- package/dist/esm/types/options.js.map +1 -1
- package/dist/esm/util/flatten-object.js +4 -4
- package/dist/esm/util/flatten-object.js.map +1 -1
- package/dist/esm/util/flatten-should-ignore.js +1 -1
- package/dist/esm/util/flatten-should-ignore.js.map +1 -1
- package/dist/types/types/common.d.ts +2 -2
- package/dist/types/types/options.d.ts +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,7 +32,7 @@ sls(options, topic);
|
|
|
32
32
|
sls(options, topic, payload);
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
以上，`options` 可用于覆盖创建 `sls` 的时候的 `
|
|
35
|
+
以上，`options` 可用于覆盖创建 `sls` 的时候的 `prefix`、`sampling` 等工厂默认的参数，也可以立即发送日志，默认所有的日志会在一定的时间内积压，以避免和业务逻辑竞争。
|
|
36
36
|
|
|
37
37
|
## 记录的数据
|
|
38
38
|
|
|
@@ -67,5 +67,5 @@ sls({
|
|
|
67
67
|
|
|
68
68
|
## 参考
|
|
69
69
|
|
|
70
|
-
* [POST 发送日志参考文档](https://help.aliyun.com/document_detail/2771303.html)
|
|
71
70
|
* [Web Tracking](https://help.aliyun.com/document_detail/31752.html)
|
|
71
|
+
* [POST 发送日志参考文档](https://help.aliyun.com/document_detail/2771303.html)
|
|
@@ -46,20 +46,20 @@ var SlsLogger = exports.default = /*#__PURE__*/function () {
|
|
|
46
46
|
payload = _ref4[2];
|
|
47
47
|
}
|
|
48
48
|
var _this$options = _this.options,
|
|
49
|
-
|
|
49
|
+
factoryPrefix = _this$options.prefix,
|
|
50
50
|
factorySampling = _this$options.sampling,
|
|
51
51
|
defaultParams = _this$options.defaultParams;
|
|
52
52
|
var _options2 = options,
|
|
53
53
|
_options2$group = _options2.group,
|
|
54
54
|
group = _options2$group === void 0 ? 'LOG' : _options2$group,
|
|
55
|
-
_options2$
|
|
56
|
-
|
|
55
|
+
_options2$prefix = _options2.prefix,
|
|
56
|
+
prefix = _options2$prefix === void 0 ? factoryPrefix : _options2$prefix,
|
|
57
57
|
_options2$sampling = _options2.sampling,
|
|
58
58
|
sampling = _options2$sampling === void 0 ? factorySampling : _options2$sampling,
|
|
59
59
|
instant = _options2.instant,
|
|
60
60
|
once = _options2.once,
|
|
61
61
|
flatten = _options2.flatten;
|
|
62
|
-
var finalTopic =
|
|
62
|
+
var finalTopic = prefix ? "".concat(prefix).concat(topic) : topic;
|
|
63
63
|
var onceKey = (0, _util.getLogOnceKey)(finalTopic, once);
|
|
64
64
|
if (_this.shouldIgnore(sampling, onceKey)) {
|
|
65
65
|
return;
|
|
@@ -25,9 +25,9 @@ var _flattenShouldIgnore = _interopRequireDefault(require("./flatten-should-igno
|
|
|
25
25
|
*/
|
|
26
26
|
function flattenObject(o, options) {
|
|
27
27
|
var resolvedOptions = typeof options === 'string' ? {
|
|
28
|
-
|
|
28
|
+
scope: options
|
|
29
29
|
} : options;
|
|
30
|
-
var
|
|
30
|
+
var scope = resolvedOptions.scope,
|
|
31
31
|
_resolvedOptions$dept = resolvedOptions.depth,
|
|
32
32
|
depth = _resolvedOptions$dept === void 0 ? 5 : _resolvedOptions$dept,
|
|
33
33
|
ignore = resolvedOptions.ignore;
|
|
@@ -39,7 +39,7 @@ function flattenObject(o, options) {
|
|
|
39
39
|
var depthFull = depth > 0 && parentPaths.length + 1 >= depth;
|
|
40
40
|
(0, _forEach2.default)(currentObj, function (v, k) {
|
|
41
41
|
var key = [].concat((0, _toConsumableArray2.default)(parentPaths), [k]).join('.');
|
|
42
|
-
var
|
|
42
|
+
var scopedKey = scope ? "".concat(scope, ".").concat(key) : key;
|
|
43
43
|
|
|
44
44
|
// 可以忽略不重要的信息
|
|
45
45
|
if ((0, _flattenShouldIgnore.default)(ignore, key, k, v)) {
|
|
@@ -49,7 +49,7 @@ function flattenObject(o, options) {
|
|
|
49
49
|
|
|
50
50
|
// 深度满了，或者不是对象或 Error，或者空对象（或数组），则不继续 loop
|
|
51
51
|
if (depthFull || !(0, _isPlainObject2.default)(vAsObject) || (0, _isEmpty2.default)(vAsObject)) {
|
|
52
|
-
result[
|
|
52
|
+
result[scopedKey] = vAsObject;
|
|
53
53
|
return;
|
|
54
54
|
}
|
|
55
55
|
loop(vAsObject, [].concat((0, _toConsumableArray2.default)(parentPaths), [k]));
|
|
@@ -40,20 +40,20 @@ var SlsLogger = /*#__PURE__*/function () {
|
|
|
40
40
|
payload = _ref4[2];
|
|
41
41
|
}
|
|
42
42
|
var _this$options = _this.options,
|
|
43
|
-
|
|
43
|
+
factoryPrefix = _this$options.prefix,
|
|
44
44
|
factorySampling = _this$options.sampling,
|
|
45
45
|
defaultParams = _this$options.defaultParams;
|
|
46
46
|
var _options2 = options,
|
|
47
47
|
_options2$group = _options2.group,
|
|
48
48
|
group = _options2$group === void 0 ? 'LOG' : _options2$group,
|
|
49
|
-
_options2$
|
|
50
|
-
|
|
49
|
+
_options2$prefix = _options2.prefix,
|
|
50
|
+
prefix = _options2$prefix === void 0 ? factoryPrefix : _options2$prefix,
|
|
51
51
|
_options2$sampling = _options2.sampling,
|
|
52
52
|
sampling = _options2$sampling === void 0 ? factorySampling : _options2$sampling,
|
|
53
53
|
instant = _options2.instant,
|
|
54
54
|
once = _options2.once,
|
|
55
55
|
flatten = _options2.flatten;
|
|
56
|
-
var finalTopic =
|
|
56
|
+
var finalTopic = prefix ? "".concat(prefix).concat(topic) : topic;
|
|
57
57
|
var onceKey = getLogOnceKey(finalTopic, once);
|
|
58
58
|
if (_this.shouldIgnore(sampling, onceKey)) {
|
|
59
59
|
return;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sls-logger.js","names":["_isError","API_VERSION","PIPE_SILENT_TIME","PIPE_WAIT_TIME","PIPE_MAX_CHUNK","getLogOnceKey","flattenObject","convertErrorToPlain","resolveDefaultParams","SlsPipe","SlsLogger","sender","options","_this","_options$silentTime","_options$waitTime","_options$maxChunk","_classCallCheck","_defineProperty","topic","payload","_len","arguments","length","args","Array","_key","_ref","_ref2","_slicedToArray","_ref3","_ref4","_this$options","
|
|
1
|
+
{"version":3,"file":"sls-logger.js","names":["_isError","API_VERSION","PIPE_SILENT_TIME","PIPE_WAIT_TIME","PIPE_MAX_CHUNK","getLogOnceKey","flattenObject","convertErrorToPlain","resolveDefaultParams","SlsPipe","SlsLogger","sender","options","_this","_options$silentTime","_options$waitTime","_options$maxChunk","_classCallCheck","_defineProperty","topic","payload","_len","arguments","length","args","Array","_key","_ref","_ref2","_slicedToArray","_ref3","_ref4","_this$options","factoryPrefix","prefix","factorySampling","sampling","defaultParams","_options2","_options2$group","group","_options2$prefix","_options2$sampling","instant","once","flatten","finalTopic","concat","onceKey","shouldIgnore","plainInfo","slsPipe","pipe","_objectSpread","__topic__","_GROUP","trackUrl","project","endpoint","logstore","apiVersion","silentTime","waitTime","maxChunk","_createClass","key","value","_shouldIgnore","Math","random","default"],"sources":["../../../src/class/sls-logger.ts"],"sourcesContent":["import _isError from 'lodash/isError';\n\nimport {\n TLogArgs,\n ICreateLoggerOptions,\n ILogSender,\n ISlsLogOptions,\n ISlsLogFn\n} from '../types';\nimport {\n API_VERSION,\n PIPE_SILENT_TIME,\n PIPE_WAIT_TIME,\n PIPE_MAX_CHUNK\n} from '../const';\nimport {\n getLogOnceKey,\n flattenObject,\n convertErrorToPlain,\n resolveDefaultParams\n} from '../util';\n\nimport SlsPipe from './sls-pipe';\n\n/**\n * 创建 SLS 日志方法\n */\nexport default class SlsLogger {\n private readonly options: ICreateLoggerOptions;\n private readonly slsPipe: SlsPipe;\n private once: Record<string, 1> = {};\n \n constructor(sender: ILogSender, options: ICreateLoggerOptions) {\n this.options = options;\n this.slsPipe = new SlsPipe(sender, {\n trackUrl: `https://${options.project}.${options.endpoint}/logstores/${options.logstore}/track`,\n apiVersion: options.apiVersion || API_VERSION,\n silentTime: options.silentTime ?? PIPE_SILENT_TIME,\n waitTime: options.waitTime ?? PIPE_WAIT_TIME,\n maxChunk: options.maxChunk ?? PIPE_MAX_CHUNK\n });\n }\n \n log: ISlsLogFn = (...args: TLogArgs): void => {\n let options: ISlsLogOptions = {};\n let topic: string;\n let payload: Record<string, unknown> | undefined;\n \n if (typeof args[0] === 'string') {\n [topic, payload] = args as [string, Record<string, unknown>?];\n } else {\n [options, topic, payload] = args as [ISlsLogOptions, string, Record<string, unknown>?];\n }\n \n const {\n options: {\n prefix: factoryPrefix,\n sampling: factorySampling,\n defaultParams\n }\n } = this;\n const {\n group = 'LOG',\n prefix = factoryPrefix,\n sampling = factorySampling,\n instant,\n once,\n flatten\n } = options;\n const finalTopic = prefix ? `${prefix}${topic}` : topic;\n const onceKey: string | undefined = getLogOnceKey(finalTopic, once);\n \n if (this.shouldIgnore(sampling, onceKey)) {\n return;\n }\n \n if (onceKey) {\n this.once[onceKey] = 1;\n }\n \n let plainInfo: object | undefined;\n \n if (payload) {\n if (flatten) {\n plainInfo = flattenObject(payload, flatten === true ? '' : flatten);\n } else if (_isError(payload)) {\n plainInfo = convertErrorToPlain(payload);\n } else {\n plainInfo = payload;\n }\n }\n \n this.slsPipe.pipe({\n ...resolveDefaultParams(defaultParams),\n ...plainInfo,\n __topic__: finalTopic,\n _GROUP: group\n }, instant);\n };\n \n /**\n * 检查是否需要忽略\n */\n private shouldIgnore(sampling?: number, onceKey?: string): boolean {\n const {\n options: {\n shouldIgnore\n }\n } = this;\n \n if (onceKey && this.once[onceKey]) { // 只需发送一次，已发送过，忽略\n return true;\n }\n \n if (shouldIgnore?.() === true) { // shouldIgnore 阻止发送\n return true;\n }\n \n if (typeof sampling === 'number' && sampling > 0 && sampling < 1) { // 采样，`(0, 1)` 开区间\n return Math.random() > sampling;\n }\n \n return false;\n }\n}"],"mappings":";;;;;;AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AASrC,SACEC,WAAW,EACXC,gBAAgB,EAChBC,cAAc,EACdC,cAAc,QACT,UAAU;AACjB,SACEC,aAAa,EACbC,aAAa,EACbC,mBAAmB,EACnBC,oBAAoB,QACf,SAAS;AAEhB,OAAOC,OAAO,MAAM,YAAY;;AAEhC;AACA;AACA;AAFA,IAGqBC,SAAS;EAK5B,SAAAA,UAAYC,MAAkB,EAAEC,QAA6B,EAAE;IAAA,IAAAC,KAAA;MAAAC,mBAAA;MAAAC,iBAAA;MAAAC,iBAAA;IAAAC,eAAA,OAAAP,SAAA;IAAAQ,eAAA,eAF7B,CAAC,CAAC;IAAAA,eAAA,cAanB,YAA6B;MAC5C,IAAIN,OAAuB,GAAG,CAAC,CAAC;MAChC,IAAIO,KAAa;MACjB,IAAIC,OAA4C;MAAC,SAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,EAH9BC,IAAI,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;QAAJF,IAAI,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;MAAA;MAKvB,IAAI,OAAOF,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;QAAA,IAAAG,IAAA,GACZH,IAAI;QAAA,IAAAI,KAAA,GAAAC,cAAA,CAAAF,IAAA;QAAtBR,KAAK,GAAAS,KAAA;QAAER,OAAO,GAAAQ,KAAA;MACjB,CAAC,MAAM;QAAA,IAAAE,KAAA,GACuBN,IAAI;QAAA,IAAAO,KAAA,GAAAF,cAAA,CAAAC,KAAA;QAA/BlB,OAAO,GAAAmB,KAAA;QAAEZ,KAAK,GAAAY,KAAA;QAAEX,OAAO,GAAAW,KAAA;MAC1B;MAEA,IAAAC,aAAA,GAMInB,KAAI,CALND,OAAO;QACGqB,aAAa,GAAAD,aAAA,CAArBE,MAAM;QACIC,eAAe,GAAAH,aAAA,CAAzBI,QAAQ;QACRC,aAAa,GAAAL,aAAA,CAAbK,aAAa;MAGjB,IAAAC,SAAA,GAOI1B,OAAO;QAAA2B,eAAA,GAAAD,SAAA,CANTE,KAAK;QAALA,KAAK,GAAAD,eAAA,cAAG,KAAK,GAAAA,eAAA;QAAAE,gBAAA,GAAAH,SAAA,CACbJ,MAAM;QAANA,MAAM,GAAAO,gBAAA,cAAGR,aAAa,GAAAQ,gBAAA;QAAAC,kBAAA,GAAAJ,SAAA,CACtBF,QAAQ;QAARA,QAAQ,GAAAM,kBAAA,cAAGP,eAAe,GAAAO,kBAAA;QAC1BC,OAAO,GAAAL,SAAA,CAAPK,OAAO;QACPC,IAAI,GAAAN,SAAA,CAAJM,IAAI;QACJC,OAAO,GAAAP,SAAA,CAAPO,OAAO;MAET,IAAMC,UAAU,GAAGZ,MAAM,MAAAa,MAAA,CAAMb,MAAM,EAAAa,MAAA,CAAG5B,KAAK,IAAKA,KAAK;MACvD,IAAM6B,OAA2B,GAAG3C,aAAa,CAACyC,UAAU,EAAEF,IAAI,CAAC;MAEnE,IAAI/B,KAAI,CAACoC,YAAY,CAACb,QAAQ,EAAEY,OAAO,CAAC,EAAE;QACxC;MACF;MAEA,IAAIA,OAAO,EAAE;QACXnC,KAAI,CAAC+B,IAAI,CAACI,OAAO,CAAC,GAAG,CAAC;MACxB;MAEA,IAAIE,SAA6B;MAEjC,IAAI9B,OAAO,EAAE;QACX,IAAIyB,OAAO,EAAE;UACXK,SAAS,GAAG5C,aAAa,CAACc,OAAO,EAAEyB,OAAO,KAAK,IAAI,GAAG,EAAE,GAAGA,OAAO,CAAC;QACrE,CAAC,MAAM,IAAI7C,QAAQ,CAACoB,OAAO,CAAC,EAAE;UAC5B8B,SAAS,GAAG3C,mBAAmB,CAACa,OAAO,CAAC;QAC1C,CAAC,MAAM;UACL8B,SAAS,GAAG9B,OAAO;QACrB;MACF;MAEAP,KAAI,CAACsC,OAAO,CAACC,IAAI,CAAAC,aAAA,CAAAA,aAAA,CAAAA,aAAA,KACZ7C,oBAAoB,CAAC6B,aAAa,CAAC,GACnCa,SAAS;QACZI,SAAS,EAAER,UAAU;QACrBS,MAAM,EAAEf;MAAK,IACZG,OAAO,CAAC;IACb,CAAC;IAjEC,IAAI,CAAC/B,OAAO,GAAGA,QAAO;IACtB,IAAI,CAACuC,OAAO,GAAG,IAAI1C,OAAO,CAACE,MAAM,EAAE;MACjC6C,QAAQ,aAAAT,MAAA,CAAanC,QAAO,CAAC6C,OAAO,OAAAV,MAAA,CAAInC,QAAO,CAAC8C,QAAQ,iBAAAX,MAAA,CAAcnC,QAAO,CAAC+C,QAAQ,WAAQ;MAC9FC,UAAU,EAAEhD,QAAO,CAACgD,UAAU,IAAI3D,WAAW;MAC7C4D,UAAU,GAAA/C,mBAAA,GAAEF,QAAO,CAACiD,UAAU,cAAA/C,mBAAA,cAAAA,mBAAA,GAAIZ,gBAAgB;MAClD4D,QAAQ,GAAA/C,iBAAA,GAAEH,QAAO,CAACkD,QAAQ,cAAA/C,iBAAA,cAAAA,iBAAA,GAAIZ,cAAc;MAC5C4D,QAAQ,GAAA/C,iBAAA,GAAEJ,QAAO,CAACmD,QAAQ,cAAA/C,iBAAA,cAAAA,iBAAA,GAAIZ;IAChC,CAAC,CAAC;EACJ;EAAC,OAAA4D,YAAA,CAAAtD,SAAA;IAAAuD,GAAA;IAAAC,KAAA;IA2DD;AACF;AACA;IACE,SAAQjB,YAAYA,CAACb,QAAiB,EAAEY,OAAgB,EAAW;MAAA,IAAAmB,aAAA;MACjE,IAEIlB,YAAY,GAEZ,IAAI,CAHNrC,OAAO,CACLqC,YAAY;MAIhB,IAAID,OAAO,IAAI,IAAI,CAACJ,IAAI,CAACI,OAAO,CAAC,EAAE;QAAE;QACnC,OAAO,IAAI;MACb;MAEA,IAAI,EAAAmB,aAAA,GAAAlB,YAAY,cAAAkB,aAAA,uBAAZA,aAAA,CAAe,CAAC,MAAK,IAAI,EAAE;QAAE;QAC/B,OAAO,IAAI;MACb;MAEA,IAAI,OAAO/B,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,GAAG,CAAC,IAAIA,QAAQ,GAAG,CAAC,EAAE;QAAE;QAClE,OAAOgC,IAAI,CAACC,MAAM,CAAC,CAAC,GAAGjC,QAAQ;MACjC;MAEA,OAAO,KAAK;IACd;EAAC;AAAA;AAAA,SAhGkB1B,SAAS,IAAA4D,OAAA","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.js","names":[],"sources":["../../../src/types/common.ts"],"sourcesContent":["export interface IDefaultParams {\n (): Record<string, unknown>;\n}\n\nexport type TDefaultParams = Record<string, unknown> | IDefaultParams;\n\nexport interface IShouldIgnore {\n (): void | boolean;\n}\n\n/**\n * 真正发送请求的实现逻辑（以支持多平台的需求），注意必需用 POST\n */\nexport interface ILogSender {\n (trackUrl: string, body: string, headers: Record<string, string>): void;\n}\n\n/**\n * 用于在 flattenObject 的时候忽略部分属性\n *\n * - 默认忽略所有以 `_` 为前缀的属性\n * - `string` 等于 `key` 则忽略\n * - `string[]` 包含 `key` 则忽略\n * - 方法，可用 `path` 进行判断（注意这里的 `path` 和 `
|
|
1
|
+
{"version":3,"file":"common.js","names":[],"sources":["../../../src/types/common.ts"],"sourcesContent":["export interface IDefaultParams {\n (): Record<string, unknown>;\n}\n\nexport type TDefaultParams = Record<string, unknown> | IDefaultParams;\n\nexport interface IShouldIgnore {\n (): void | boolean;\n}\n\n/**\n * 真正发送请求的实现逻辑（以支持多平台的需求），注意必需用 POST\n */\nexport interface ILogSender {\n (trackUrl: string, body: string, headers: Record<string, string>): void;\n}\n\n/**\n * 用于在 flattenObject 的时候忽略部分属性\n *\n * - 默认忽略所有以 `_` 为前缀的属性\n * - `string` 等于 `key` 则忽略\n * - `string[]` 包含 `key` 则忽略\n * - 方法，可用 `path` 进行判断（注意这里的 `path` 和 `scope` 没有关系）\n */\nexport type TFlattenIgnore = string | string[] | {\n (path: string, key: string, value: unknown): boolean;\n};\n\nexport interface ISlsLogPayload {\n __topic__: string;\n [k: string]: unknown;\n}\n\nexport interface ISlsPostBody {\n __topic__: string;\n __logs__: Record<string, string>[];\n // __source__?: string;\n // __tags__?: Record<string, string>;\n}"],"mappings":"","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"options.js","names":[],"sources":["../../../src/types/options.ts"],"sourcesContent":["import {\n TDefaultParams,\n IShouldIgnore,\n TFlattenIgnore\n} from './common';\n\nexport interface ISlsPipeOptions {\n trackUrl: string;\n /**\n * 不知所谓的参数，但必需，说是保留字段，默认 `0.6.0`（文档中的版本号），请不要使用\n */\n apiVersion: string;\n /**\n * 应用初始化后，多少时间内对日志请求进行冷冻处理，以让行业务请求，提升业务性能\n *\n * 默认 5000ms\n */\n silentTime: number;\n /**\n * 调用方法到日志被真正发送的等待时间，这段时间内，若有新的日志进来，会被合并并重新计时\n *\n * 默认 200ms\n */\n waitTime: number;\n /**\n * 一次最多发送日志条数，若积累的日志数超过，将切成多个请求发送\n *\n * 默认 50\n */\n maxChunk: number;\n}\n\nexport interface ICreateLoggerOptions extends Partial<ISlsPipeOptions> {\n /**\n * logstore 所在的 SLS project\n */\n project: string;\n /**\n * project 的外网访问域名，在 SLS 控制台 project 概览页可以找到，\n * 如 `cn-hangzhou.log.aliyuncs.com`（仅跟 project 所在地域有关）\n */\n endpoint: string;\n /**\n * SLS project 下的 logstore，必须开通 Web Tracking 功能，日志记录的存储点\n */\n logstore: string;\n /**\n * 当希望同一个模块的日志使用统一的前缀，又不想每次调用的时候写，可以用这个\n */\n
|
|
1
|
+
{"version":3,"file":"options.js","names":[],"sources":["../../../src/types/options.ts"],"sourcesContent":["import {\n TDefaultParams,\n IShouldIgnore,\n TFlattenIgnore\n} from './common';\n\nexport interface ISlsPipeOptions {\n trackUrl: string;\n /**\n * 不知所谓的参数，但必需，说是保留字段，默认 `0.6.0`（文档中的版本号），请不要使用\n */\n apiVersion: string;\n /**\n * 应用初始化后，多少时间内对日志请求进行冷冻处理，以让行业务请求，提升业务性能\n *\n * 默认 5000ms\n */\n silentTime: number;\n /**\n * 调用方法到日志被真正发送的等待时间，这段时间内，若有新的日志进来，会被合并并重新计时\n *\n * 默认 200ms\n */\n waitTime: number;\n /**\n * 一次最多发送日志条数，若积累的日志数超过，将切成多个请求发送\n *\n * 默认 50\n */\n maxChunk: number;\n}\n\nexport interface ICreateLoggerOptions extends Partial<ISlsPipeOptions> {\n /**\n * logstore 所在的 SLS project\n */\n project: string;\n /**\n * project 的外网访问域名，在 SLS 控制台 project 概览页可以找到，\n * 如 `cn-hangzhou.log.aliyuncs.com`（仅跟 project 所在地域有关）\n */\n endpoint: string;\n /**\n * SLS project 下的 logstore，必须开通 Web Tracking 功能，日志记录的存储点\n */\n logstore: string;\n /**\n * 当希望同一个模块的日志使用统一的前缀，又不想每次调用的时候写，可以用这个\n */\n prefix?: string;\n /**\n * 生产出的日志方法的整体采样率，可在调用时由方法参数覆盖，范围为 (0, 1]，默认 1\n */\n sampling?: number;\n /**\n * 默认参数，避免每次都要传，可以是静态数据或产生动态数据的方法，这些参数可以覆盖自动记录的参数，\n * 但会被日志方法的第二个参数 `params` 中对应的字段覆盖\n */\n defaultParams?: TDefaultParams;\n /**\n * 上报之前进行判断是否继续，返回 false 以阻止上报\n *\n * 在某些场景下需要禁用日志上报功能，比如国外禁止将日志上报到国内的 logstore\n */\n shouldIgnore?: IShouldIgnore;\n}\n\n/**\n * 生成 `createLogger` 方法的工厂方法的 options，用于制定工厂级别的参数的忽略方法\n */\nexport interface IGenerateCreateLoggerOptions {\n defaultParams?: TDefaultParams;\n shouldIgnore?: IShouldIgnore;\n}\n\nexport interface ISlsFlattenOptions {\n scope?: string;\n depth?: number;\n ignore?: TFlattenIgnore;\n}\n\n/**\n * SLS 日志方法 Options\n */\nexport interface ISlsLogOptions {\n /**\n * 覆盖 IFactoryOptions 的 prefix 设置，仅针对当前日志\n */\n prefix?: string;\n /**\n * 覆盖 IFactoryOptions 的 sampling 设置，仅针对当前日志\n */\n sampling?: number;\n /**\n * 有日志只需要在应用起来后记录一次，后续的将被丢弃\n *\n * - true 表示以该 topic 做判断，针对该 topic 只记录一次\n * - 如果是字符串，则以「topic + 此字符串」做判断\n */\n once?: true | string;\n /**\n * 日志不是强需求，不能压过业务，要业务先行。网络请求一般在页面的一开始最密集，如果日志在这时上报会造成网络阻塞而产生性能问题。\n *\n * 办法是先积压着，等到时间到了，再把积压着的日志一起上报。\n *\n * 所以，为了提升性能，做了以下事情：\n *\n * 1. 应用起来后，有一定的静默时间，这段时间的日志会被积压，用于给应用的请求让路\n * 2. 整体或单个日志的延时时间\n * 3. 整体或单个日志的采样率\n * 4. 有的日志只会发送一次\n * 5. 日志发送前也有一个很短的等待时间，在这段时间内，如果有新的日志进来，也将被积压，并重新计时\n * 6. 最后，积压的日志利用 POST 请求对日志进行合并发送\n *\n * 然而，总有例外，有的日志希望是即时的，比如需要拿它来算 PvUv，instant 就是为此而生。\n * 注意：instant 会忽略延时，但不会忽略采样率\n */\n instant?: boolean;\n /**\n * 是否对 info 进行 flatten 操作\n */\n flatten?: boolean | string | ISlsFlattenOptions;\n /**\n * 为日志增加默认参数 `_GROUP`，可用于数据分析分组\n */\n group?: string;\n}\n\n/**\n * SLS 快捷方法 Options\n */\nexport interface ISlsLogOptionsQuick extends Omit<ISlsLogOptions, 'group'> {}"],"mappings":"","ignoreList":[]}
|
|
@@ -19,9 +19,9 @@ import flattenShouldIgnore from './flatten-should-ignore';
|
|
|
19
19
|
*/
|
|
20
20
|
export default function flattenObject(o, options) {
|
|
21
21
|
var resolvedOptions = typeof options === 'string' ? {
|
|
22
|
-
|
|
22
|
+
scope: options
|
|
23
23
|
} : options;
|
|
24
|
-
var
|
|
24
|
+
var scope = resolvedOptions.scope,
|
|
25
25
|
_resolvedOptions$dept = resolvedOptions.depth,
|
|
26
26
|
depth = _resolvedOptions$dept === void 0 ? 5 : _resolvedOptions$dept,
|
|
27
27
|
ignore = resolvedOptions.ignore;
|
|
@@ -33,7 +33,7 @@ export default function flattenObject(o, options) {
|
|
|
33
33
|
var depthFull = depth > 0 && parentPaths.length + 1 >= depth;
|
|
34
34
|
_forEach(currentObj, function (v, k) {
|
|
35
35
|
var key = [].concat(_toConsumableArray(parentPaths), [k]).join('.');
|
|
36
|
-
var
|
|
36
|
+
var scopedKey = scope ? "".concat(scope, ".").concat(key) : key;
|
|
37
37
|
|
|
38
38
|
// 可以忽略不重要的信息
|
|
39
39
|
if (flattenShouldIgnore(ignore, key, k, v)) {
|
|
@@ -43,7 +43,7 @@ export default function flattenObject(o, options) {
|
|
|
43
43
|
|
|
44
44
|
// 深度满了，或者不是对象或 Error，或者空对象（或数组），则不继续 loop
|
|
45
45
|
if (depthFull || !_isPlainObject(vAsObject) || _isEmpty(vAsObject)) {
|
|
46
|
-
result[
|
|
46
|
+
result[scopedKey] = vAsObject;
|
|
47
47
|
return;
|
|
48
48
|
}
|
|
49
49
|
loop(vAsObject, [].concat(_toConsumableArray(parentPaths), [k]));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flatten-object.js","names":["_isEmpty","_isPlainObject","_isError","_forEach","convertErrorToPlain","flattenShouldIgnore","flattenObject","o","options","resolvedOptions","
|
|
1
|
+
{"version":3,"file":"flatten-object.js","names":["_isEmpty","_isPlainObject","_isError","_forEach","convertErrorToPlain","flattenShouldIgnore","flattenObject","o","options","resolvedOptions","scope","_resolvedOptions$dept","depth","ignore","result","makeSureErrorObject","errorOrObject","loop","currentObj","parentPaths","depthFull","length","v","k","key","concat","_toConsumableArray","join","scopedKey","vAsObject"],"sources":["../../../src/util/flatten-object.ts"],"sourcesContent":["import _isEmpty from 'lodash/isEmpty';\nimport _isPlainObject from 'lodash/isPlainObject';\nimport _isError from 'lodash/isError';\nimport _forEach from 'lodash/forEach';\n\nimport type {\n ISlsFlattenOptions\n} from '../types';\n\nimport convertErrorToPlain from './convert-error-to-plain';\nimport flattenShouldIgnore from './flatten-should-ignore';\n\n/**\n * 有时候为了统计方便，需要把传入的对象展平，比如 error 对象，可能会展平成如下形状：\n *\n * ```\n * {\n * \"error.name\": \"..\",\n * \"error.message\": \"..\",\n * \"error.stack\": \"..\"\n * }\n * ```\n */\nexport default function flattenObject<T extends object>(o: T, options: string | ISlsFlattenOptions): Record<string, unknown> {\n const resolvedOptions = typeof options === 'string' ? {\n scope: options\n } : options;\n const {\n scope,\n depth = 5,\n ignore\n } = resolvedOptions;\n const result: Record<string, unknown> = {};\n \n function makeSureErrorObject(errorOrObject: object): object {\n return _isError(errorOrObject) ? convertErrorToPlain(errorOrObject) : errorOrObject;\n }\n \n function loop(currentObj: object, parentPaths: string[]): void {\n const depthFull = depth > 0 && parentPaths.length + 1 >= depth;\n \n _forEach(currentObj, (v: unknown, k: string) => {\n const key = [...parentPaths, k].join('.');\n const scopedKey = scope ? `${scope}.${key}` : key;\n \n // 可以忽略不重要的信息\n if (flattenShouldIgnore(ignore, key, k, v)) {\n return;\n }\n \n const vAsObject = makeSureErrorObject(v as object);\n \n // 深度满了，或者不是对象或 Error，或者空对象（或数组），则不继续 loop\n if (depthFull || !_isPlainObject(vAsObject) || _isEmpty(vAsObject)) {\n result[scopedKey] = vAsObject;\n \n return;\n }\n \n loop(vAsObject, [...parentPaths, k]);\n });\n }\n \n loop(makeSureErrorObject(o), []);\n \n return result;\n}"],"mappings":";AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,cAAc,MAAM,sBAAsB;AACjD,OAAOC,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,QAAQ,MAAM,gBAAgB;AAMrC,OAAOC,mBAAmB,MAAM,0BAA0B;AAC1D,OAAOC,mBAAmB,MAAM,yBAAyB;;AAEzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,aAAaA,CAAmBC,CAAI,EAAEC,OAAoC,EAA2B;EAC3H,IAAMC,eAAe,GAAG,OAAOD,OAAO,KAAK,QAAQ,GAAG;IACpDE,KAAK,EAAEF;EACT,CAAC,GAAGA,OAAO;EACX,IACEE,KAAK,GAGHD,eAAe,CAHjBC,KAAK;IAAAC,qBAAA,GAGHF,eAAe,CAFjBG,KAAK;IAALA,KAAK,GAAAD,qBAAA,cAAG,CAAC,GAAAA,qBAAA;IACTE,MAAM,GACJJ,eAAe,CADjBI,MAAM;EAER,IAAMC,MAA+B,GAAG,CAAC,CAAC;EAE1C,SAASC,mBAAmBA,CAACC,aAAqB,EAAU;IAC1D,OAAOd,QAAQ,CAACc,aAAa,CAAC,GAAGZ,mBAAmB,CAACY,aAAa,CAAC,GAAGA,aAAa;EACrF;EAEA,SAASC,IAAIA,CAACC,UAAkB,EAAEC,WAAqB,EAAQ;IAC7D,IAAMC,SAAS,GAAGR,KAAK,GAAG,CAAC,IAAIO,WAAW,CAACE,MAAM,GAAG,CAAC,IAAIT,KAAK;IAE9DT,QAAQ,CAACe,UAAU,EAAE,UAACI,CAAU,EAAEC,CAAS,EAAK;MAC9C,IAAMC,GAAG,GAAG,GAAAC,MAAA,CAAAC,kBAAA,CAAIP,WAAW,IAAEI,CAAC,GAAEI,IAAI,CAAC,GAAG,CAAC;MACzC,IAAMC,SAAS,GAAGlB,KAAK,MAAAe,MAAA,CAAMf,KAAK,OAAAe,MAAA,CAAID,GAAG,IAAKA,GAAG;;MAEjD;MACA,IAAInB,mBAAmB,CAACQ,MAAM,EAAEW,GAAG,EAAED,CAAC,EAAED,CAAC,CAAC,EAAE;QAC1C;MACF;MAEA,IAAMO,SAAS,GAAGd,mBAAmB,CAACO,CAAW,CAAC;;MAElD;MACA,IAAIF,SAAS,IAAI,CAACnB,cAAc,CAAC4B,SAAS,CAAC,IAAI7B,QAAQ,CAAC6B,SAAS,CAAC,EAAE;QAClEf,MAAM,CAACc,SAAS,CAAC,GAAGC,SAAS;QAE7B;MACF;MAEAZ,IAAI,CAACY,SAAS,KAAAJ,MAAA,CAAAC,kBAAA,CAAMP,WAAW,IAAEI,CAAC,EAAC,CAAC;IACtC,CAAC,CAAC;EACJ;EAEAN,IAAI,CAACF,mBAAmB,CAACR,CAAC,CAAC,EAAE,EAAE,CAAC;EAEhC,OAAOO,MAAM;AACf","ignoreList":[]}
|
|
@@ -7,7 +7,7 @@ export default function flattenShouldIgnore(ignore, path, key, value) {
|
|
|
7
7
|
return false;
|
|
8
8
|
}
|
|
9
9
|
if (typeof ignore === 'function') {
|
|
10
|
-
return ignore(key, value
|
|
10
|
+
return ignore(path, key, value);
|
|
11
11
|
}
|
|
12
12
|
if (Array.isArray(ignore)) {
|
|
13
13
|
return ignore.includes(key);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flatten-should-ignore.js","names":["flattenShouldIgnore","ignore","path","key","value","test","Array","isArray","includes"],"sources":["../../../src/util/flatten-should-ignore.ts"],"sourcesContent":["import type {\n ISlsFlattenOptions\n} from '../types';\n\nexport default function flattenShouldIgnore(ignore: ISlsFlattenOptions['ignore'], path: string, key: string, value: unknown): boolean {\n if (/^_/.test(key)) { // 默认不记录 _ 打头的所有数据\n return true;\n }\n \n if (!ignore) {\n return false;\n }\n \n if (typeof ignore === 'function') {\n return ignore(key, value
|
|
1
|
+
{"version":3,"file":"flatten-should-ignore.js","names":["flattenShouldIgnore","ignore","path","key","value","test","Array","isArray","includes"],"sources":["../../../src/util/flatten-should-ignore.ts"],"sourcesContent":["import type {\n ISlsFlattenOptions\n} from '../types';\n\nexport default function flattenShouldIgnore(ignore: ISlsFlattenOptions['ignore'], path: string, key: string, value: unknown): boolean {\n if (/^_/.test(key)) { // 默认不记录 _ 打头的所有数据\n return true;\n }\n \n if (!ignore) {\n return false;\n }\n \n if (typeof ignore === 'function') {\n return ignore(path, key, value);\n }\n \n if (Array.isArray(ignore)) {\n return ignore.includes(key);\n }\n \n return key === ignore;\n}"],"mappings":"AAIA,eAAe,SAASA,mBAAmBA,CAACC,MAAoC,EAAEC,IAAY,EAAEC,GAAW,EAAEC,KAAc,EAAW;EACpI,IAAI,IAAI,CAACC,IAAI,CAACF,GAAG,CAAC,EAAE;IAAE;IACpB,OAAO,IAAI;EACb;EAEA,IAAI,CAACF,MAAM,EAAE;IACX,OAAO,KAAK;EACd;EAEA,IAAI,OAAOA,MAAM,KAAK,UAAU,EAAE;IAChC,OAAOA,MAAM,CAACC,IAAI,EAAEC,GAAG,EAAEC,KAAK,CAAC;EACjC;EAEA,IAAIE,KAAK,CAACC,OAAO,CAACN,MAAM,CAAC,EAAE;IACzB,OAAOA,MAAM,CAACO,QAAQ,CAACL,GAAG,CAAC;EAC7B;EAEA,OAAOA,GAAG,KAAKF,MAAM;AACvB","ignoreList":[]}
|
|
@@ -17,10 +17,10 @@ export interface ILogSender {
|
|
|
17
17
|
* - 默认忽略所有以 `_` 为前缀的属性
|
|
18
18
|
* - `string` 等于 `key` 则忽略
|
|
19
19
|
* - `string[]` 包含 `key` 则忽略
|
|
20
|
-
* - 方法，可用 `path` 进行判断（注意这里的 `path` 和 `
|
|
20
|
+
* - 方法，可用 `path` 进行判断（注意这里的 `path` 和 `scope` 没有关系）
|
|
21
21
|
*/
|
|
22
22
|
export type TFlattenIgnore = string | string[] | {
|
|
23
|
-
(
|
|
23
|
+
(path: string, key: string, value: unknown): boolean;
|
|
24
24
|
};
|
|
25
25
|
export interface ISlsLogPayload {
|
|
26
26
|
__topic__: string;
|
|
@@ -41,7 +41,7 @@ export interface ICreateLoggerOptions extends Partial<ISlsPipeOptions> {
|
|
|
41
41
|
/**
|
|
42
42
|
* 当希望同一个模块的日志使用统一的前缀，又不想每次调用的时候写，可以用这个
|
|
43
43
|
*/
|
|
44
|
-
|
|
44
|
+
prefix?: string;
|
|
45
45
|
/**
|
|
46
46
|
* 生产出的日志方法的整体采样率，可在调用时由方法参数覆盖，范围为 (0, 1]，默认 1
|
|
47
47
|
*/
|
|
@@ -66,7 +66,7 @@ export interface IGenerateCreateLoggerOptions {
|
|
|
66
66
|
shouldIgnore?: IShouldIgnore;
|
|
67
67
|
}
|
|
68
68
|
export interface ISlsFlattenOptions {
|
|
69
|
-
|
|
69
|
+
scope?: string;
|
|
70
70
|
depth?: number;
|
|
71
71
|
ignore?: TFlattenIgnore;
|
|
72
72
|
}
|
|
@@ -75,9 +75,9 @@ export interface ISlsFlattenOptions {
|
|
|
75
75
|
*/
|
|
76
76
|
export interface ISlsLogOptions {
|
|
77
77
|
/**
|
|
78
|
-
* 覆盖 IFactoryOptions 的
|
|
78
|
+
* 覆盖 IFactoryOptions 的 prefix 设置，仅针对当前日志
|
|
79
79
|
*/
|
|
80
|
-
|
|
80
|
+
prefix?: string;
|
|
81
81
|
/**
|
|
82
82
|
* 覆盖 IFactoryOptions 的 sampling 设置，仅针对当前日志
|
|
83
83
|
*/
|