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.git
The following commit(s) were added to refs/heads/master by this push:
new 09965ab4b5 Update the browser API protocol doc (#12619)
09965ab4b5 is described below
commit 09965ab4b536565ec6eba940887ceafe5f37895f
Author: Fine0830 <[email protected]>
AuthorDate: Tue Jan 7 14:17:14 2025 +0800
Update the browser API protocol doc (#12619)
---
docs/en/api/browser-http-api-protocol.md | 64 +++++++++++++++++++++++++++++++-
docs/en/changes/changes.md | 2 +
2 files changed, 65 insertions(+), 1 deletion(-)
diff --git a/docs/en/api/browser-http-api-protocol.md
b/docs/en/api/browser-http-api-protocol.md
index 6966c21f5b..2ec24e3287 100644
--- a/docs/en/api/browser-http-api-protocol.md
+++ b/docs/en/api/browser-http-api-protocol.md
@@ -31,7 +31,69 @@ Input:
"sslTime": 10,
"ttlTime": 10,
"firstPackTime": 10,
- "fmpTime": 10
+}
+```
+
+OutPut:
+
+Http Status: 204
+
+### POST http://localhost:12800/browser/perfData/webVitals
+
+Send a performance data object in JSON format. Since client-js 1.0.0, the
following attached metrics are reported.
+
+Input:
+
+```json
+{
+ "service": "web",
+ "serviceVersion": "v0.0.1",
+ "pagePath": "/index.html",
+ "fmpTime": 10,
+ "clsTime": 10,
+ "lcpTime": 10,
+}
+```
+
+OutPut:
+
+Http Status: 204
+
+### POST http://localhost:12800/browser/perfData/webInteraction
+
+Send a performance data object in JSON format. Since client-js 1.0.0, the
following attached metrics are reported.
+
+Input:
+
+```json
+{
+ "service": "web",
+ "serviceVersion": "v0.0.1",
+ "pagePath": "/index.html",
+ "fidTime": 10,
+}
+```
+
+OutPut:
+
+Http Status: 204
+
+### POST http://localhost:12800/browser/perfData/resources
+
+Send a static resources data object in JSON format. Since client-js 1.0.0, the
following attached metrics are reported.
+
+Input:
+
+```json
+{
+ "service": "web",
+ "serviceVersion": "v0.0.1",
+ "pagePath": "/index.html",
+ "name": "vue.js",
+ "duration": 600,
+ "size": 100000,
+ "protocol": "h2",
+ "type": "script",
}
```
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 47bf0f301c..ce6c048c02 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -84,4 +84,6 @@
* Add Status APIs docs.
* Simplified the release process with removing maven central publish relative
processes.
+
All issues and pull requests are
[here](https://github.com/apache/skywalking/milestone/224?closed=1)
+
