@zxhy-npm/send-sls-logger 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,70 @@
+import { WebTrackerBrowserOptions } from "@aliyun-sls/web-track-browser";
+
+interface StringObject {
+  [name: string]: string | Function;
+}
+
+/** 对最终发送的日志进行兜底处理，只能在init中使用 */
+type FormatResult = (result: any) => any;
+
+interface initConfig {
+  debug?: boolean;
+  /** 日志默认值，可以配置字符串或者function，如果是function，每次发送日志都会执行，通常用于获取当前页面的url等 */
+  defaultData?: StringObject;
+  /** 设置关键字列表，用于排除一些日志，如果日志中包含配置的这些关键字，则不发送日志 */
+  defaultExclude?: string[];
+  options?: WebTrackerBrowserOptions;
+  /** 最大字符长度，如果关键字里包含token，则不进行截断 */
+  strMaxLength?: number;
+  /** 对最终发送的日志进行兜底处理，只能在init中使用 */
+  userFormatResult?: FormatResult;
+}
+
+export = slsLog;
+export as namespace slsLog;
+
+/**
+ * PC端sls日志组件，使用init初始化项目，填入 options(host、project、logstore)；
+ * 在后续使用的时候，直接调用error｜warn｜log｜into向sls发送日志
+ */
+declare namespace slsLog {
+  /**
+   * @name 发送error日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function error(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 发送警告日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function warn(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 发送普通日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function log(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 发送普通日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function info(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 初始化init
+   * @description 可以多次调用，在发送日志之前，一定要初始化过 options(host、project、logstore) 内容
+   * @param debug 是否开启debug模式
+   * @param defaultData 日志默认值，可以配置字符串或者function，如果是function，每次发送日志都会执行，通常用于获取当前页面的url等
+   * @param defaultExclude 设置关键字列表，用于排除一些日志，如果日志中包含配置的这些关键字，则不发送日志
+   * @param options host、project、logstore
+   * @param strMaxLength 是否开启debug模式 最大字符长度，如果关键字里包含token，则不进行截断
+   * @param userFormatResult 对最终发送的日志进行兜底处理，只能在init中使用
+   */
+  function init(config: initConfig): void;
+}

package/lib/index.js

@@ -0,0 +1,6 @@
+import SlsTracker from "@aliyun-sls/web-track-browser";
+import logger from "./init";
+
+const init = logger.logInit(SlsTracker);
+
+export default { ...logger, init };

package/lib/init.js

@@ -0,0 +1,131 @@
+const opts = {
+	host: "", // 所在地域的服务入口。例如cn-hangzhou.log.aliyuncs.com
+	project: "", // Project名称。
+	logstore: "", // Logstore名称。
+	time: 5, // 发送日志的时间间隔，默认是10秒。
+	count: 10, // 发送日志的数量大小，默认是10条。
+};
+const defaultLogData = {};
+const exclude = [];
+let tracker;
+let userFormatResult;
+let debug;
+
+const getType = (val) => {
+	return Object.prototype.toString.call(val).toLocaleLowerCase().slice(8, -1);
+};
+
+let maxLength = 200;
+const formatDataMaxLength = (data) => {
+	if (getType(data) === "object") {
+		return Object.keys(data).reduce((curr, key) => {
+			curr[key] = /token/.test(key)
+				? data[key]
+				: formatDataMaxLength(data[key]);
+			return curr;
+		}, {});
+	} else if (getType(data) === "array") {
+		return data.map((i) => formatDataMaxLength(i));
+	} else if (getType(data) === "string" && data.length > maxLength) {
+		return `${data.slice(0, maxLength)}...${data.length - maxLength}个字已忽略`;
+	} else {
+		return data;
+	}
+};
+
+const formatFunctionObj = (data) => {
+	if (getType(data) === "object") {
+		return Object.keys(data).reduce((curr, key) => {
+			curr[key] = formatFunctionObj(data[key]);
+			return curr;
+		}, {});
+	} else if (getType(data) === "array") {
+		return data.map((i) => formatFunctionObj(i));
+	} else if (getType(data) === "function") {
+		return data();
+	} else {
+		return data;
+	}
+};
+const formatLogData = (data, type = "log") => {
+	const result = { ...defaultLogData, type };
+	if (typeof data === "string") {
+		Object.assign(result, { data });
+	} else if (typeof data === "object") {
+		Object.assign(result, data);
+	}
+	return formatFunctionObj(result);
+};
+
+const send = (type) => {
+	return function (err, activeFormatResult) {
+		let data = {};
+		if (typeof err === "string") {
+			data.msg = err;
+		} else if (typeof err === "object") {
+			data = { ...err };
+		}
+
+		const result = formatLogData(data, type);
+		const isExcludeMsg = Object.keys(result).find((key) => {
+			return exclude.find((i) => new RegExp(i, "g").test(result[key]));
+		});
+
+		if (!opts.host || !opts.project || !opts.logstore) {
+			return console.warn("日志初始化需要配置options", result);
+		}
+		let formatResultObj = formatDataMaxLength(result);
+
+		if (getType(userFormatResult) === "function") {
+			formatResultObj = userFormatResult(formatResultObj) || formatResultObj;
+		}
+
+		if (getType(activeFormatResult) === "function") {
+			formatResultObj = activeFormatResult(formatResultObj) || formatResultObj;
+		}
+
+		if (isExcludeMsg) {
+			debug && console.log(`logger ${type}`, formatResultObj);
+			return;
+		}
+		tracker.send(formatResultObj);
+	};
+};
+
+const error = send("error");
+const warn = send("warn");
+const log = send("info");
+const info = send("info");
+
+const logInit = (Tracker) => {
+	return (config) => {
+		const {
+			defaultData = {},
+			defaultExclude = [],
+			options = {},
+			strMaxLength = maxLength,
+			debug: defaultDebug = debug,
+			userFormatResult: defaultUserFormatResult = userFormatResult,
+		} = config;
+
+		if (defaultDebug !== undefined) {
+			debug = defaultDebug;
+		}
+		userFormatResult = defaultUserFormatResult;
+		Object.assign(defaultLogData, defaultData);
+		Object.assign(opts, options);
+		if (options.host && options.logstore && options.project) {
+			tracker = new Tracker(opts);
+		}
+		maxLength = strMaxLength;
+		exclude.push(...defaultExclude);
+	};
+};
+
+export default {
+	error,
+	warn,
+	log,
+	info,
+	logInit,
+};

package/lib/mini.d.ts

@@ -0,0 +1,71 @@
+import { WebTrackerMiniOptions } from "@aliyun-sls/web-track-mini";
+interface StringObject {
+  [name: string]: string | Function;
+}
+
+/** 对最终发送的日志进行兜底处理，只能在init中使用 */
+type FormatResult = (result: any) => any;
+
+/** init 可以多次调用，最好在初次，填入 options 内容 */
+interface initConfig {
+  /** 是否开启debug模式 */
+  debug?: boolean;
+  /** 日志默认值，可以配置字符串或者function，如果是function，每次发送日志都会执行，通常用于获取当前页面的url等 */
+  defaultData?: StringObject;
+  /** 设置关键字列表，用于排除一些日志，如果日志中包含配置的这些关键字，则不发送日志 */
+  defaultExclude?: string[];
+  options?: WebTrackerMiniOptions;
+  /** 最大字符长度，如果关键字里包含token，则不进行截断 */
+  strMaxLength?: number;
+  /** 对最终发送的日志进行兜底处理，只能在init中使用 */
+  userFormatResult?: FormatResult;
+}
+
+export = miniLog;
+export as namespace miniLog;
+
+/**
+ * 小程序日志，使用init初始化项目，填入 options(host、project、logstore)，init可以多次调用，填入defaultData等默认信息；
+ * 在后续使用的时候，直接调用error｜warn｜log｜into向sls发送日志
+ */
+declare namespace miniLog {
+  /**
+   * @name 发送error日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function error(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 发送警告日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function warn(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 发送普通日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function log(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 发送普通日志
+   * 接收两个参数，
+   * @param log string | StringObject
+   * @param format 整理即将发送的，返回要发送的日志结果
+   * */
+  function info(str: string | StringObject, format?: FormatResult): void;
+  /**
+   * @name 初始化init
+   * @description 可以多次调用，在发送日志之前，一定要初始化过 options(host、project、logstore) 内容
+   * @param debug 是否开启debug模式
+   * @param defaultData 日志默认值，可以配置字符串或者function，如果是function，每次发送日志都会执行，通常用于获取当前页面的url等
+   * @param defaultExclude 设置关键字列表，用于排除一些日志，如果日志中包含配置的这些关键字，则不发送日志
+   * @param options host、project、logstore
+   * @param strMaxLength 是否开启debug模式 最大字符长度，如果关键字里包含token，则不进行截断
+   * @param userFormatResult 对最终发送的日志进行兜底处理，只能在init中使用
+   */
+  function init(config: initConfig): void;
+}

package/lib/mini.js

@@ -0,0 +1,6 @@
+import SlsMiniTracker from "@aliyun-sls/web-track-mini";
+import logger from "./init";
+
+const init = logger.logInit(SlsMiniTracker);
+
+export default { ...logger, init };

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@zxhy-npm/send-sls-logger",
+  "version": "0.0.1",
+  "description": "阿里云sls的logger发送",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "lib"
+  ],
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js",
+    "./mini": "./lib/mini.js"
+  },
+  "keywords": [
+    "logger",
+    "sls"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "liukai",
+  "license": "ISC",
+  "dependencies": {
+    "@aliyun-sls/web-track-browser": "^0.0.3",
+    "@aliyun-sls/web-track-mini": "^0.0.2"
+  }
+}

package/readme.md

@@ -0,0 +1,44 @@
+## PC 使用方式
+
+```javascript
+import slsLog from "send-sls-logger";
+slsLog.init({
+  defaultData: logDefaultData, // 默认带的数据
+  defaultExclude: ["模拟器", "ResizeObserver"], // 需要排除的数据
+  options: {
+    host: host, // 所在地域的服务入口。例如cn-hangzhou.log.aliyuncs.com
+    project: project, // Project名称。
+    logstore: logstore, // Logstore名称。
+  },
+});
+slsLog.error({ msg: "这是一条错误日志" });
+slsLog.warn({ msg: "这是一条警告日志" });
+slsLog.log({ msg: "这是一条默认日志" });
+slsLog.info({ msg: "这是一条默认日志" });
+```
+
+## 小程序 使用方式
+
+```javascript
+import miniLog from "send-sls-logger/lib/mini";
+miniLog.init({
+  defaultData: logDefaultData, // 默认带的数据
+  defaultExclude: ["模拟器", "ResizeObserver"], // 需要排除的数据
+  options: {
+    host: host, // 所在地域的服务入口。例如cn-hangzhou.log.aliyuncs.com
+    project: project, // Project名称。
+    logstore: logstore, // Logstore名称。
+  },
+});
+miniLog.error({ msg: "这是一条错误日志" });
+miniLog.warn({ msg: "这是一条警告日志" });
+miniLog.log({ msg: "这是一条默认日志" });
+miniLog.info({ msg: "这是一条默认日志" });
+```
+
+## 更新备注
+
+0.0.6 ---------- 2022-11-23 16:59:00  
+更新内容: 增加 ts 解析器
+0.0.41 ---------- 2023-02-10 14:51:18  
+更新内容: 增加使用说明