kezhenxu94 commented on a change in pull request #52:
URL: https://github.com/apache/skywalking-nodejs/pull/52#discussion_r634892921



##########
File path: README.md
##########
@@ -56,7 +56,8 @@ Environment Variable | Description | Default
 | `SW_AGENT_SECURE` | Whether to use secure connection to backend OAP server | 
`false` |
 | `SW_AGENT_AUTHENTICATION` | The authentication token to verify that the 
agent is trusted by the backend OAP, as for how to configure the backend, refer 
to [the 
yaml](https://github.com/apache/skywalking/blob/4f0f39ffccdc9b41049903cc540b8904f7c9728e/oap-server/server-bootstrap/src/main/resources/application.yml#L155-L158).
 | not set |
 | `SW_AGENT_LOGGING_LEVEL` | The logging level, could be one of `error`, 
`warn`, `info`, `debug` | `info` |
-| `SW_AGENT_DISABLE_PLUGINS` | Comma-delimited list of plugins to disable in 
the plugins directory (e.g. "mysql", "express"). | `` |
+| `SW_AGENT_DISABLE_PLUGINS` | Comma-delimited list of plugins to disable in 
the plugins directory (e.g. "mysql", "express") | `` |
+| `SW_COLD_ENDPOINT` | When a cold start is detected append `<cold>` to the 
endpoint name | `false` |

Review comment:
       I’d suggest put some of the following into the doc
   
   > Cold start detection is as follows: First span to run within 1 second of 
skywalking init is considered a cold start. This span gets the tag 'coldStart' 
set to 'true'. This span also optionally gets the text '<cold>' appended to the 
endpoint name if env var SW_COLD_ENDPOINT is set to 'true' or config option 
'coldEndpoint', the default is off (normal endpoint names). A dummy span 
running first due to ignore is considered a valid first run and eats the cold 
start. Note: 'coldStart' tag is not added at all if cold start is not detected, 
which means most spans will not have anything extra added.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to