# wind-logger-miniprogram

> 风行前端行为日志收集模块,适配微信小程序

Latest version **1.0.6** (published 2023-08-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install wind-logger-miniprogram
pnpm add wind-logger-miniprogram
yarn add wind-logger-miniprogram
bun add wind-logger-miniprogram
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-08-02 |
| First published | 2022-09-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 34.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | xiahouwei |
| Maintainers | xiahouwei |
| Keywords | fx, wind, logger, miniprogram |

## Links

- npm: https://www.npmjs.com/package/wind-logger-miniprogram
- Repository: https://github.com/xiahouwei/wind-logger-miniprogram
- Homepage: https://github.com/xiahouwei//wind-logger-miniprogram#readme
- Issues: https://github.com/xiahouwei/wind-logger-miniprogram/issues
- npm.io page: https://npm.io/package/wind-logger-miniprogram

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.6 (latest) — 2023-08-02
- 1.0.5 — 2023-08-02
- 1.0.4 — 2022-10-25
- 1.0.3 — 2022-10-25
- 1.0.2 — 2022-09-14
- 1.0.1 — 2022-09-14
- 1.0.0 — 2022-09-14

## README

# wind-logger-miniprogram
风行前端行为日志收集模块-微信小程序

### 安装
```
// 1. 在小程序开发工具

npm install wind-logger-miniprogram --save

// 2. 小程序开发工具选择 [工具] -> [构建npm]

```

不错的教程👇🏻👇🏻👇🏻

[微信小程序如何引入npm包？](https://developers.weixin.qq.com/community/develop/article/doc/0008aecec4c9601e750be048d51c13)


### 引入日志模块

```javascript

import FxLogger from 'wind-logger-miniprogram'
const LOGGER_CONFIG = {
	app: 'logger-test',
	remote: 'https://action.fxscm.net/logger/v1/shopedi/loggers',
	defaultInfo: {
		appType: 'logger-demo-miniprogram'
	},
	customInfo: {
		actionType: ''
	}
}
// 创建日志实例
const $fxLogger = new FxLogger(LOGGER_CONFIG)
App({
	onLaunch() {
        // 挂载日志模块
		this.globalData.$fxLogger = $fxLogger
	},
	globalData: {},
	onError (error) {
        // 捕获error日志
		$fxLogger.runtimeInfo(error)
	}
})

```

### 使用方法
```javascript
// 日志初始化
app.globalData.$fxLogger.init({
    username: '系统管理员',
    userId: '1'
})
```

![日志初始化](https://pic.imgdb.cn/item/62eb521f16f2c2beb1408f98.png)

```javascript
// 切换用户
app.globalData.$fxLogger.setUserInfo({
    username: '用户01',
    userId: '2'
})
```
![切换用户](https://pic.imgdb.cn/item/62eb52aa16f2c2beb1414613.png)

```javascript
// 发送成功日志
const logger = app.globalData.$fxLogger.actionInfo({
	message: '成功的日志消息1',
    // 公司定义的默认日志字段
    oneStageModule: '一级菜单1',
    twoStageModule: '二级菜单1',
     // 生产线定义的自定义日志字段
    actionType: 'demo按钮2'
})
setTimeout(() => {
	logger.success()
}, 1000)
```
![发送成功日志](https://pic.imgdb.cn/item/62c81b70f54cd3f937468376.png)

```javascript
// 发送失败的日志
const logger = app.globalData.$fxLogger.actionInfo({
	message: '失败的日志消息'
})
setTimeout(() => {
	logger.error('服务器异常')
}, 1000)
```
![发送失败的日志](https://pic.imgdb.cn/item/62c81c0ff54cd3f93747704d.png)

```javascript
// 对request请求进行捕获
fxRequest ({ url, data, query }) {
		return new Promise((resolve, reject) => {
		// 创建request日志
		const logger = app.globalData.$fxLogger.requestInfoStart({ url, data, query })
		setTimeout(() => {
			if (data.billType === '1') {
				const succesResponse = {
					result: true
				}
				// 成功日志的手收集
				logger.end({
					res: succesResponse
				})
				resolve(succesResponse)
			} else {
				const errorResponse = {
					result: false,
					message: '单据类型错误'
				}
				// 失败日志的收集
				logger.end({
					error: errorResponse
				})
				reject(errorResponse)
			}
		}, 1000)
	})
}
```
![request请求日志](https://pic.imgdb.cn/item/62eb539516f2c2beb1424235.png)

---
_Source: https://npm.io/package/wind-logger-miniprogram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._