Skip to content

Commit

Permalink
Merge pull request #26 from Tencent/dev
Browse files Browse the repository at this point in the history
eslint & travis
  • Loading branch information
huangyoukun authored May 22, 2018
2 parents 30ab595 + 1de770d commit a66b72c
Show file tree
Hide file tree
Showing 157 changed files with 12,102 additions and 12,224 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# http://editorconfig.org

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
bin/wwwroot/**/highlight-tsw.js
bin/wwwroot/**/zepto.min.js
bin/lib/api/L5/L5.api.js
42 changes: 42 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"env": {
"node": true,
"commonjs": true,
"es6": true
},
"extends": "eslint:recommended",
"parserOptions": {
"sourceType": "module",
"ecmaVersion": 2017
},
"globals": {
"plug": false,
"window": false,
"context": false,
"define": false
},
"rules": {
"indent": [
"error",
4
],
"linebreak-style": [
"error",
"unix"
],
"quotes": [
"error",
"single"
],
"semi": [
"error",
"always"
],
"no-unused-vars": [
"error",
{
"args": "none"
}
]
}
}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/node_modules
node_modules
.vscode
.idea
.DS_Store
7 changes: 6 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
sudo: false
language: node_js
node_js:
- "8"
- "9"
- "9"

script:
- npm run lint
- npm test && npm run coverage
164 changes: 83 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,84 @@
# [Tencent Server Web](https://tswjs.org)


[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](./LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/TSW/pulls) [![wiki](https://img.shields.io/badge/Wiki-open-brightgreen.svg)](https://tswjs.org/guide/index) ![node](https://img.shields.io/badge/node-%3E%3D8.0.0-green.svg)

---


[English Version](./README_en.md)


## 简介

Tencent Server Web(TSW),是一套面向WEB前端开发者,以提升问题定位效率为初衷,提供染色抓包、全息日志和异常发现的Node.js基础设施。TSW关注业务的运维监控能力,适用于http、websocket协议的业务场景,可无缝与即有项目进行整合。支持公有云、私有云和本地部署。

![tsw](./static/resource/structure.png)

#### 染色抓包

TSW 支持用户维度的抓包

- 对于指定的用户(白名单内)
- 请求生命周期内,对请求本身及衍生请求进行抓包
- 提供抓包查看、下载等功能
- 抓包格式支持Fiddler和Charles,以及HAR

#### 全息日志

TSW 提供用户维度的全息日志帮助开发者快速定位问题

- 对请求生命周期内的日志,采用全息的方式记录,形成流水
- 流水按用户维度聚合
- 提供查看功能,快速定位问题原因

#### 异常发现

- 内置指标实时监控
- 代码异常推送告警

## 环境要求

- 操作系统: Windows/Mac/Linux
- Node.js: 8.0.0+

## 开始

1. 请先下载安装[Node.js](https://nodejs.org/en/download/),并且Node.js的版本需不低于8.0.0。
1. 安装 -- `git clone https://github.com/Tencent/TSW.git`
1. 配置 -- 修改 `TSW/conf/config.js`,更多配置项参考 [手册](https://tswjs.org/doc/api/config)

```js
this.httpAddress = '0.0.0.0';

this.httpPort = 80;
```

1. 启动 -- ``node TSW``
1. 预览 -- 打开浏览器,访问 ``http://127.0.0.1/`` 即可

## 官方网站

- 更多教程 [https://tswjs.org/guide/index](https://tswjs.org/guide/index)

- 使用手册 [https://tswjs.org/doc/api/index](https://tswjs.org/doc/api/index)

## 配套设施

- TSW开放平台 [https://tswjs.org](https://tswjs.org)

## 贡献代码

如果您使用过程中发现Bug,请通过 [https://github.com/Tencent/TSW/issues](https://github.com/Tencent/TSW/issues) 来提交并描述相关的问题,您也可以在这里查看其它的issue,通过解决这些issue来贡献代码。

如果您是第一次贡献代码,请阅读 [CONTRIBUTING](./CONTRIBUTING.md) 了解我们的贡献流程,并提交 pull request 给我们。

## 许可证

Tencent Server Web 的开源协议为 MIT, 详情参见 [LICENSE](./LICENSE) 。

## 联系方式

# [Tencent Server Web](https://tswjs.org)


[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](./LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/TSW/pulls) [![wiki](https://img.shields.io/badge/Wiki-open-brightgreen.svg)](https://tswjs.org/guide/index) ![node](https://img.shields.io/badge/node-%3E%3D8.0.0-green.svg) [![Build Status](https://travis-ci.org/Tencent/TSW.svg?branch=master)](https://travis-ci.org/Tencent/TSW)

---


[English Version](./README_en.md)


## 简介

Tencent Server Web(TSW),是一套面向WEB前端开发者,以提升问题定位效率为初衷,提供染色抓包、全息日志和异常发现的Node.js基础设施。TSW关注业务的运维监控能力,适用于http、websocket协议的业务场景,可无缝与即有项目进行整合。支持公有云、私有云和本地部署。

![tsw](./static/resource/structure.png)

#### 染色抓包

TSW 支持用户维度的抓包

- 对于指定的用户(白名单内)
- 请求生命周期内,对请求本身及衍生请求进行抓包
- 提供抓包查看、下载等功能
- 抓包格式支持Fiddler和Charles,以及HAR

#### 全息日志

TSW 提供用户维度的全息日志帮助开发者快速定位问题

- 对请求生命周期内的日志,采用全息的方式记录,形成流水
- 流水按用户维度聚合
- 提供查看功能,快速定位问题原因

#### 异常发现

- 内置指标实时监控
- 代码异常推送告警

## 环境要求

- 操作系统: Windows/Mac/Linux
- Node.js: 8.0.0+

## 开始

1. 需先安装[Node.js](https://nodejs.org/en/download/),并且Node.js的版本需不低于8.0.0。
1. 安装 -- `git clone https://github.com/Tencent/TSW.git`
1. 切换工作目录 -- `cd TSW`
1. 补全依赖 -- `npm install --no-optional`
1. 配置 -- 修改 `TSW/conf/config.js`,更多配置项参考 [手册](https://tswjs.org/doc/api/config)

```js
this.httpAddress = '0.0.0.0';

this.httpPort = 80;
```

1. 启动 -- `node index.js`
1. 预览 -- 打开浏览器,访问 `http://127.0.0.1/` 即可

## 官方网站

- 更多教程 [https://tswjs.org/guide/index](https://tswjs.org/guide/index)

- 使用手册 [https://tswjs.org/doc/api/index](https://tswjs.org/doc/api/index)

## 配套设施

- TSW开放平台 [https://tswjs.org](https://tswjs.org)

## 贡献代码

如果您使用过程中发现Bug,请通过 [https://github.com/Tencent/TSW/issues](https://github.com/Tencent/TSW/issues) 来提交并描述相关的问题,您也可以在这里查看其它的issue,通过解决这些issue来贡献代码。

如果您是第一次贡献代码,请阅读 [CONTRIBUTING](./CONTRIBUTING.md) 了解我们的贡献流程,并提交 pull request 给我们。

## 许可证

Tencent Server Web 的开源协议为 MIT, 详情参见 [LICENSE](./LICENSE) 。

## 联系方式

tsw@tencent.com
Loading

0 comments on commit a66b72c

Please sign in to comment.