Skip to content
This repository has been archived by the owner on Jun 17, 2021. It is now read-only.

Commit

Permalink
Update documentations and fix some dead links (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
kezhenxu94 authored Apr 21, 2020
1 parent db12eb2 commit 4295210
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
12 changes: 6 additions & 6 deletions docs/compatibility-list.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# 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 |
| 1.0.0 | 6.0.0-GA |


## 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.

Expand Down
10 changes: 5 additions & 5 deletions docs/how-to-deploy-agent-in-egg-framework.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

6 changes: 3 additions & 3 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -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.
And now your application has been monitored.
10 changes: 5 additions & 5 deletions modules/nodejs-agent/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)

0 comments on commit 4295210

Please sign in to comment.