Skip to content

Commit 09965ab

Browse files
authored
Update the browser API protocol doc (#12619)
1 parent 844aa50 commit 09965ab

File tree

2 files changed

+65
-1
lines changed

2 files changed

+65
-1
lines changed

docs/en/api/browser-http-api-protocol.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,69 @@ Input:
3131
"sslTime": 10,
3232
"ttlTime": 10,
3333
"firstPackTime": 10,
34-
"fmpTime": 10
34+
}
35+
```
36+
37+
OutPut:
38+
39+
Http Status: 204
40+
41+
### POST http://localhost:12800/browser/perfData/webVitals
42+
43+
Send a performance data object in JSON format. Since client-js 1.0.0, the following attached metrics are reported.
44+
45+
Input:
46+
47+
```json
48+
{
49+
"service": "web",
50+
"serviceVersion": "v0.0.1",
51+
"pagePath": "/index.html",
52+
"fmpTime": 10,
53+
"clsTime": 10,
54+
"lcpTime": 10,
55+
}
56+
```
57+
58+
OutPut:
59+
60+
Http Status: 204
61+
62+
### POST http://localhost:12800/browser/perfData/webInteraction
63+
64+
Send a performance data object in JSON format. Since client-js 1.0.0, the following attached metrics are reported.
65+
66+
Input:
67+
68+
```json
69+
{
70+
"service": "web",
71+
"serviceVersion": "v0.0.1",
72+
"pagePath": "/index.html",
73+
"fidTime": 10,
74+
}
75+
```
76+
77+
OutPut:
78+
79+
Http Status: 204
80+
81+
### POST http://localhost:12800/browser/perfData/resources
82+
83+
Send a static resources data object in JSON format. Since client-js 1.0.0, the following attached metrics are reported.
84+
85+
Input:
86+
87+
```json
88+
{
89+
"service": "web",
90+
"serviceVersion": "v0.0.1",
91+
"pagePath": "/index.html",
92+
"name": "vue.js",
93+
"duration": 600,
94+
"size": 100000,
95+
"protocol": "h2",
96+
"type": "script",
3597
}
3698
```
3799

docs/en/changes/changes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,6 @@
8484
* Add Status APIs docs.
8585
* Simplified the release process with removing maven central publish relative processes.
8686

87+
8788
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)
89+

0 commit comments

Comments
 (0)