Skip to content

README_en.md

Latest commit

 

History

History
87 lines (51 loc) · 2.68 KB

README_en.md

File metadata and controls

87 lines (51 loc) · 2.68 KB

Introduction

Tencent Server side Web(TSW) is a Node.js infrastructure which is designed for improving the efficiency of locating problems, providing multiple functions for front-end developers: online dyeing/packet capture, holographic logging and abnormity discovery. TSW, focusing on the operation and maintenance of businesses, is suitable for web and mobile applications based on http or websocket protocols. It can be readily integrated with existing systems.

tsw

Online dyeing/packet capture

TSW supports packet capture based on user granularity.

  • Dye labelled user by users' feature IDs
  • Collect packets within corresponding requests' lifecycles for dyed users.
  • Provid functions to view and download captured packets.
  • Support Fiddler(windows), Charles(mac) and HAR format.

Holographic logging

The full content of the request can be seen through the log.

  • Record packets within requests' lifecycles holographically in the form of log flow.
  • Aggregate log flows based on user granularity.
  • View log flows by user features. Help analyzing and solving problems efficiently.

Abnormity discovery

  • Monitor preset indicators in real time
  • Push alarms for code exceptions

Requirement

  • OS: Windows/Mac/Linux
  • Node.js: 8.0.0+

npm

  • Before installing, download and install Node.js. Node.js 8.0.0 or higher is required.
  • npm i @tswjs/tsw
  • npx --node-arg=--inspect tsw
  • Open http://127.0.0.1/ in your browser.

git

  • Before installing, download and install Node.js. Node.js 8.0.0 or higher is required.

  • Clone the repo: git clone https://github.com/Tencent/TSW.git

  • Enter the TSW: cd TSW

  • NPM : npm install

  • Run node --inspect index.js to start Node.js server

  • Open http://127.0.0.1/ in your browser.

docker

# build
docker build -t tsw .
# run
docker run -v configure_dir:/data/release/node_modules -p 8080:80 tsw

Documentation

Supporting facilities

Contributing

Find a bug or have a feature request? Please read the issues guidelines and search for existing and closed issues.

If your problem or idea is not addressed yet, please read through our contributing guidelines and open a new issues.

License

Tencent Server Web is released under MIT license.

Contacts

[email protected]