Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the browser API protocol doc #12619

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
64 changes: 63 additions & 1 deletion docs/en/api/browser-http-api-protocol.md
Original file line number Diff line number Diff line change
@@ -31,7 +31,69 @@ Input:
"sslTime": 10,
"ttlTime": 10,
"firstPackTime": 10,
"fmpTime": 10
}
```

OutPut:

Http Status: 204

### POST http://localhost:12800/browser/perfData/webVitals
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two URIs we should adopt in the receiver.


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

2 changes: 2 additions & 0 deletions docs/en/changes/changes.md
Original file line number Diff line number Diff line change
@@ -62,4 +62,6 @@
* Improve component-libraries documentation.
* Improve configuration-vocabulary documentation.


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