You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2020/12/29 03:39:16 UTC

[skywalking-client-js] branch master updated: docs: update readme (#29)

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-client-js.git


The following commit(s) were added to refs/heads/master by this push:
     new 6daf5f1  docs: update readme (#29)
6daf5f1 is described below

commit 6daf5f15d85d7b2fc45e54d3471e6238bbfd0feb
Author: Qiuxia Fan <fi...@outlook.com>
AuthorDate: Tue Dec 29 11:39:08 2020 +0800

    docs: update readme (#29)
---
 CHANGES.md | 4 ++++
 README.md  | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index baf33fc..96c818e 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,5 +1,9 @@
 # Changes
 
+## 0.3.0
+
+1. Support tracing starting at the browser.
+
 ## 0.2.0
 
 1. Fix: `secureConnectionStart` is zero bug.
diff --git a/README.md b/README.md
index f79451b..034c394 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ The register method supports the following parameters.
 |Parameter|Type|Description|Required|Default Value|
 |----|----|----|----|----|
 |collector|String|In default, the collected data would be reported to current domain(`/browser/perfData`. Then, typically, we recommend you use a Gateway/proxy to redirect the data to the OAP(`resthost:restport`). If you set this, the data could be reported to another domain, NOTE [the Cross-Origin Resource Sharing (CORS) issuse and solution](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS). |false|-|
-|service|String|project id|true|-|
+|service|String|project id. NOTE, in tracing data requests, the service parameter is `service + '<browser>'`.|true|-|
 |serviceVersion|String|project verison|true|-|
 |pagePath|String|project path|true|-|
 |jsErrors|Boolean|Support js errors monitoring|false|true|
@@ -96,7 +96,7 @@ app.on('routeChange', function (next) {
 });   
 ```
 
-## Tracing range of data requests in the broswer
+## Tracing range of data requests in the browser
 
 Support tracking these([XMLHttpRequest](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) and [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)) two modes of data requests. At the same time, Support tracking libraries and tools that base on XMLHttpRequest and fetch, such as [Axios](https://github.com/axios/axios), [SuperAgent](https://github.com/visionmedia/superagent), [OpenApi](https://www.openapis.org/) and so on.