diff --git a/.gitmodules b/.gitmodules index bceb5cb..d1db49d 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "modules/nodejs-agent/proto"] path = modules/nodejs-agent/proto - url = https://github.com/apache/incubator-skywalking-data-collect-protocol.git + url = https://github.com/apache/skywalking-data-collect-protocol.git diff --git a/README.md b/README.md index cd785b1..f561fe9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [Apache SkyWalking](https://github.com/apache/skywalking) backend and others compatible agents/SDKs. -[![Build Status](https://travis-ci.org/SkyAPM/SkyAPM-nodejs.svg?branch=master)](https://travis-ci.org/SkyAPM/SkyAPM-nodejs) +[![Build Status](https://github.com/SkyAPM/SkyAPM-nodejs/workflows/Build/badge.svg?branch=master)](https://github.com/SkyAPM/SkyAPM-nodejs/actions?query=branch%3Amaster+event%3Apush+workflow%3ABuild) ## Documents * [Document in English](docs/README.md) diff --git a/docs/compatibility-list.md b/docs/compatibility-list.md index e0925e1..e1b1323 100644 --- a/docs/compatibility-list.md +++ b/docs/compatibility-list.md @@ -1,11 +1,11 @@ -# Capatibility list -In Skywalking, each monitored component/framework will have a unique identifier. because of the publish time and publish version for the Skywalking main project and nodejs project is not one by one corresponding. So some monitored component/framework identifier are not recognized by the Skywalking Collector, it will cause some problems on the UI. +# Compatibility list +In SkyWalking, each monitored component/framework will have a unique identifier. because of the publish time and publish version for the SkyWalking main project and nodejs project is not one by one corresponding. So some monitored component/framework identifier are not recognized by the SkyWalking Collector, it will cause some problems on the UI. -So you have two way to resolve this problem. One is **download the capatiblity version** and the other way is **add your own component library setting**. +So you have two ways to resolve this problem. One is **download the compatible version** and the other way is **add your own component library setting**. -## Download the capatiblity version +## Download the compatible version -| Nodejs agent version| Skywalking backend version| +| Nodejs agent version| SkyWalking backend version| |:------|:----| | 0.1.x | 5.0.0-beta | | 0.3.0 | 5.0.0-RC | @@ -13,7 +13,7 @@ So you have two way to resolve this problem. One is **download the capatiblity v ## Add your own component library -If you don't want to upgrade the Skywalking backend, No problem, Skywalking provide another simple way to resolve it, Just following [this document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Component-libraries-extend.md) to add your own component libray setting. +If you don't want to upgrade the SkyWalking backend, no problem, SkyWalking provides another simple way to resolve it, just follow [this document](https://github.com/apache/skywalking/blob/master/docs/en/Component-libraries-extend.md) to add your own component library setting. Here is the plugin support mapping. diff --git a/docs/how-to-deploy-agent-in-egg-framework.md b/docs/how-to-deploy-agent-in-egg-framework.md index f8e127c..a54e8af 100644 --- a/docs/how-to-deploy-agent-in-egg-framework.md +++ b/docs/how-to-deploy-agent-in-egg-framework.md @@ -1,16 +1,16 @@ # How to deploy agent in egg framework ## Install `skyapm-egg-require` module -1. goto project +1. goto project 2. run the following command ```shell $ npm install skyapm-egg-require --save ``` ## Deploy Skywalking backend -Skywalking provide two deploy mode, one is standalone mode and the other is cluster mode, and here is the deploy documents. -* [Local mode](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md) -* [Cluster mode](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-cluster-mode.md) +SkyWalking provide two deploy mode, one is standalone mode and the other is cluster mode, and here is the deploy documents. +* [Local mode](https://github.com/apache/skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md) +* [Cluster mode](https://github.com/apache/skywalking/blob/master/docs/en/Deploy-backend-in-cluster-mode.md) ## Modify start script Add the following the stuff to the start script @@ -25,6 +25,6 @@ Add the following the stuff to the start script ## Visit your application After you do all above actions and your application has been monitored. you can visit your service that your application provided and the tracking data will be reported to the Skywalking backend. -## Visit skywalking webui +## Visit SkyWalking webui If you has start up UI, you maybe can open browser and visit the webui url. The url by default is [http://localhost:8080](http://localhost:8080), If you has changed `server.port` configuration about webui, the visit url has change to http://localhost:[server.port]. If you haven't started yet, don't worry about the loss data problem and Skywalking will keep your data safe, just start up UI, and visit the webui url. diff --git a/docs/quick-start.md b/docs/quick-start.md index abbeb11..b0e0959 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -1,10 +1,10 @@ # Quick start Here is the steps: -1. Look up the [compatiblity list](compatibility-list.md) +1. Look up the [compatibility list](compatibility-list.md) 2. Download corresponding releases package from [Apache official website](http://skywalking.apache.org/downloads/). -3. Deploy skywalking backend in standalone mode according [this document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md) +3. Deploy SkyWalking backend in standalone mode according [this document](https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/backend-ui-setup.md) 4. [Install Nodejs Agent](install-agent.md) 5. Reboot your applications and visit your service. -And now your application has been monitored. \ No newline at end of file +And now your application has been monitored. diff --git a/modules/nodejs-agent/README.md b/modules/nodejs-agent/README.md index ca23dd2..8048d6b 100644 --- a/modules/nodejs-agent/README.md +++ b/modules/nodejs-agent/README.md @@ -1,11 +1,11 @@ # SkyAPM Nodejs Agent -SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [Apache SkyWalking(Incubating) APM](https://github.com/apache/incubator-skywalking) backend and others compatible agents/SDKs. +SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [Apache SkyWalking APM](https://github.com/apache/skywalking) backend and others compatible agents/SDKs. -[![Build Status](https://travis-ci.org/SkyAPM/SkyAPM-nodejs.svg?branch=master)](https://travis-ci.org/SkyAPM/SkyAPM-nodejs) +[![Build Status](https://github.com/SkyAPM/SkyAPM-nodejs/workflows/Build/badge.svg?branch=master)](https://github.com/SkyAPM/SkyAPM-nodejs/actions?query=branch%3Amaster+event%3Apush+workflow%3ABuild) ## Documents -* [Document in English](../docs/README.md) +* [Document in English](../../docs/README.md) ## Support List 1. [Http](https://nodejs.org/api/http.html) @@ -16,5 +16,5 @@ SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [A * Submit an issue * QQ Group: 392443393 - ## License ## License - [Apache 2.0](LICENSE.md) +## License +[Apache 2.0](../../../LICENSE)