diff --git a/docs/how-to-deploy-agent-in-egg-framework.md b/docs/how-to-deploy-agent-in-egg-framework.md index 7dbf1b08d5b8b73e5bf6857626e9816e8453142b..f8e127c0e1260c9b6267103d2029c0d8dc98f396 100644 --- a/docs/how-to-deploy-agent-in-egg-framework.md +++ b/docs/how-to-deploy-agent-in-egg-framework.md @@ -15,10 +15,10 @@ Skywalking provide two deploy mode, one is standalone mode and the other is clus ## Modify start script Add the following the stuff to the start script ``` ---require sw-egg-script --sw_pplication_code=Your_application_code --sw_direct_Servers=Collector_remote_grpc_address +--require skyapm-egg-require --sw_service_name=Your_service_name --sw_direct_Servers=Collector_remote_grpc_address ``` -* `Your_application_code`: It used to differentiate between different applications. the value will be shown in WebUI. +* `Your_service_name`: It used to differentiate between different services. the value will be shown in WebUI. * `Collector_agent_grpc_address`: This value should be consistent with the `agent_gRPC.gRPC` configuration items in the application.yml in the Collector project. (default value: localhost:11800) diff --git a/docs/install-agent.md b/docs/install-agent.md index 3c3ffcffda4d6f8da1950a39c96ed2967ec77155..0c7a6c8bf6c6cfe5e5ab7503fa8932bd4a700f6f 100644 --- a/docs/install-agent.md +++ b/docs/install-agent.md @@ -10,13 +10,14 @@ require and start the agent in your application’s main file. ```javascript require('skyapm-nodejs').start({ - // Application code is showed in sky-walking-ui. Suggestion: set an unique name for each application, one - // application's nodes share the same code. + // Service name is showed in sky-walking-ui. Suggestion: set an unique name for each service, one + // service's nodes share the same code. // this value cannot be empty. serviceName: 'test', // Collector agent_gRPC/grpc service addresses. // default value: localhost:11800 directServers: 'localhost:11800' }); +``` *NOTE*: If your application is using egg framework. please read the [deploy agent in egg framework](how-to-deploy-agent-in-egg-framework.md). diff --git a/modules/skyapm-egg-require/README.md b/modules/skyapm-egg-require/README.md index 13bad59f8ad2d5cf989c552e037a7e36354d4934..cdf7f5a6a61dc8197efdfb399ad6912c93bc7429 100644 --- a/modules/skyapm-egg-require/README.md +++ b/modules/skyapm-egg-require/README.md @@ -9,5 +9,5 @@ npm i skyapm-egg-require --save 2. Add start arguments add the following script arguments to the start script of your egg application. ``` ---require sw-egg-script --sw_service_name=Your_application_code --sw_direct_Servers=Collector_agent_grpc_address +--require skyapm-egg-require --sw_service_name=Your_service_name --sw_direct_Servers=Collector_agent_grpc_address ```