Update the browser API protocol doc (#12619)

This commit is contained in:
Fine0830 2025-01-07 14:17:14 +08:00 committed by GitHub
parent 844aa5084d
commit 09965ab4b5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 65 additions and 1 deletions

View File

@ -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",
}
```

View File

@ -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)