Skip to content

Commit

Permalink
docs: add 0x00, 0x01 and 0x12 translation
Browse files Browse the repository at this point in the history
  • Loading branch information
hyj1991 committed Jul 23, 2020
1 parent 7c6dbd4 commit f24897b
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/0x00_Description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Description

As a Node.js developer, I know that for front-end developers who are new to the server field, it is easy to get lost when introducing Node.js:

- My application memory has risen a little bit. Why?
- Why is the response time of my application so slow?
- Where is the performance bottleneck of my code?
- ...

Easy-Monitor is a solution for Node.js application performance monitoring and online fault location.

Aiming at the open source ecological tool chain of Node.js, do something that can help developers who want to use and are using Node.js to better perceive their Node.js application status, so as to better face the performance and stable challenges.

## Main features

- Performance monitoring for Node.js process and system metrics
- Error log display and Npm module dependencies security risk tips
- Customized intelligent operation and maintenance alarms and real-time status export of online processes

Compared to its predecessors such as AliNode, Easy-Monitor provides:

- Privatization deployment capability
- Low invasiveness, providing capabilities through Addon, no need to customize Node.js Runtime, and faster follow-up upstream
- Support Linux, macOS, Windows three operating systems

![image.png](https://cdn.nlark.com/yuque/0/2020/png/155185/1591704520476-c5a15cc6-32f0-4257-b8f7-a344765f959c.png?x-oss-process=image%2Fresize%2Cw_1492)

- Yuque document: [https://github.com/hyj1991/easy-monitor](https://github.com/hyj1991/easy-monitor)
- Source address: [https://github.com/X-Profiler](https://github.com/X-Profiler)
25 changes: 25 additions & 0 deletions docs/0x01_Architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Architecture

## I. Project address

Easy-Monitor 3.0 version description and entry address: [https://github.com/hyj1991/easy-monitor](https://github.com/hyj1991/easy-monitor) .

Because of the huge changes in the overall structure, multiple sub-modules are divided and stored in the organization \*\*X-Profiler \*\*, the address is: [https://github.com/X-Profiler](https://github.com/X-Profiler) .

A brief description of the functions of each sub-module of the project and the warehouse address:

- Version 3.0 display console: [xprofiler-console](https://github.com/X-Profiler/xprofiler-console)
- xtransit management service: [xtransit-manager](https://github.com/X-Profiler/xtransit-manager)
- xtransit long connection service: [xtransit-server](https://github.com/X-Profiler/xtransit-server)
- Performance log generation plugin: [xprofiler](https://github.com/X-Profiler/xprofiler)
- Performance log collector: [xtransit](https://github.com/X-Profiler/xtransit)

## II. Technology Stack

The front end of the console is written based on the [Vue.js](https://vuejs.org/) + [iView UI](https://github.com/view-design/ViewUI) framework, the monitoring server part is written based on the [Egg.js](https://eggjs.org/) framework, and the UI part is based on the [AliNode](https://node.console.aliyun.com/) console as a whole.

Click the [Easy-Monitor 3.0 console sample](http://120.27.24.200:7443/) to preview the function and interface.

## III. Architecture design diagram

Easy-Monitor 3.0 supports three platforms: **Window** , **Linux** and **MacOS** . The overall architecture is as follows: ![image.png](https://cdn.nlark.com/yuque/0/2020/png/155185/1590935827983-bea9fd78-7f10-47dd-9304-8c63ef63656a.png#align=left&display=inline&height=490&margin=%5Bobject%20Object%5D&name=image.png&originHeight=928&originWidth=1666&size=141099&status=done&style=none&width=880)
9 changes: 9 additions & 0 deletions docs/0x12_Settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Settings

The system settings page is only visible to application administrators:

![image.png](https://cdn.nlark.com/yuque/0/2020/png/155185/1591280596438-6cc133bd-80e9-4d8d-906c-115ad52d636d.png#align=left&display=inline&height=418&margin=%5Bobject%20Object%5D&name=image.png&originHeight=836&originWidth=3618&size=128407&status=done&style=shadow&width=1809)

Here you can get the `appId` and `appSecret` information required by `xtransit`to access this application.

The administrator can also rename the application and delete the application here. It should be noted that all instances will be disconnected after deleting the application, and the monitoring data, performance analysis files, etc. will be lost. You need to be careful.

0 comments on commit f24897b

Please sign in to comment.