| 1 | 
|
| 2 |
|
| 3 | [](https://github.com/midwayjs/pandora/blob/master/LICENSE)
|
| 4 | []()
|
| 5 | [](https://travis-ci.org/midwayjs/pandora)
|
| 6 | [](https://codecov.io/gh/midwayjs/pandora/branch/master)
|
| 7 | [](http://packagequality.com/#?package=pandora)
|
| 8 | [](https://lernajs.io/)
|
| 9 | [](https://snyk.io/test/npm/pandora)
|
| 10 | [](https://github.com/midwayjs/pandora/pulls)
|
| 11 |
|
| 12 | ## Installation
|
| 13 |
|
| 14 | ```bash
|
| 15 | $ npm install -g pandora
|
| 16 | ```
|
| 17 |
|
| 18 | Node.js >= 8.2.1 required.
|
| 19 |
|
| 20 | ## Introductions and start with an example project
|
| 21 |
|
| 22 | * [Node.js Ops First with Pandora.js, Today](https://github.com/midwayjs/pandora/wiki/Node.js-Ops-First-with-Pandora.js,-Today)
|
| 23 | * [Pandora.js 专业的 Node.js 应用监控管理器，阿里开源](https://github.com/midwayjs/pandora/wiki/Pandora.js---%E4%B8%93%E4%B8%9A%E7%9A%84-Node.js-%E5%BA%94%E7%94%A8%E7%9B%91%E6%8E%A7%E7%AE%A1%E7%90%86%E5%99%A8%EF%BC%8C%E9%98%BF%E9%87%8C%E5%BC%80%E6%BA%90)
|
| 24 | * <a href="http://www.youtube.com/watch?feature=player_embedded&v=5bWCJi5gPqI
|
| 25 | " target="_blank">Video Introduction <br/> <img src="http://img.youtube.com/vi/5bWCJi5gPqI/0.jpg"
|
| 26 | alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a>
|
| 27 |
|
| 28 | ## Docs
|
| 29 |
|
| 30 | * 中文文档 <http://www.midwayjs.org/pandora/zh-cn/>
|
| 31 | * English documents <http://www.midwayjs.org/pandora/>
|
| 32 |
|
| 33 | ## What is Pandora.js ?
|
| 34 |
|
| 35 | As a consequence of years of experiences on enterprise Node.js applications management, Midway team from Alibaba open-sourced Pandora.js finally. It is an application manager integrates many capabilities like monitoring, debugging, resiliency. You are more than welcome to use it, as well as build your operation infrastructure upon it.
|
| 36 |
|
| 37 | The main concepts of Pandora.js are:
|
| 38 |
|
| 39 | 1. Manageable
|
| 40 | * Standard management capabilities of applications, processes and basic services (such as middleware).
|
| 41 | * Graceful online/offline.
|
| 42 | * Inter-process object proxying.
|
| 43 | 2. Measurable
|
| 44 | * Be able to measure different aspects of applications.
|
| 45 | * Support tons of metrics types, gauge, counter, meter, histogram, etc.
|
| 46 | 3. Traceable
|
| 47 | * Be able to trace the whole execution stack, inspect applications at runtime.
|
| 48 | * Support tons of 3rd party middlewares, MySQL, redis, etc.
|
| 49 | * Compatible with Open-Tracing standard
|
| 50 | 4. Highly available
|
| 51 | * Provides mechanism to mock middleware failures, aims to enhance system resilience.
|
| 52 | * Do trouble shooting by remote debugging.
|
| 53 |
|
| 54 |
|
| 55 | The data can be achieved via RESTFul API or local file system. It is super easy to integrate it with your monitoring system.
|
| 56 |
|
| 57 | ## Features
|
| 58 |
|
| 59 | - ✔︎ Built-in process management
|
| 60 | - ✔︎ Dev Ops customization
|
| 61 | - ✔︎ Provide Metrics and Standard OpenTracing Implementation
|
| 62 | - ✔︎ Support lots of web frameworks
|
| 63 |
|
| 64 | ## How to Contribute
|
| 65 |
|
| 66 | Please let us know how can we help. Do check out [issues](https://github.com/midwayjs/pandora/issues) for bug reports or suggestions first.
|
| 67 |
|
| 68 | To become a contributor, please follow our [contributing guide](CONTRIBUTING.md).
|
| 69 |
|
| 70 | ## License
|
| 71 |
|
| 72 | [MIT](LICENSE)
|
| 73 |
|
| 74 | ## Sponsor
|
| 75 |
|
| 76 | <a target="_blank" href="http://opensource.alibaba.com/" ><img src="https://img.alicdn.com/tfs/TB14aTMbgmTBuNjy1XbXXaMrVXa-328-134.jpg" width="123" /></a>
|