opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-22 05:05:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(site): add agent connection timings (#15276)

Browse Source 
Local preview:

<img width="1260" alt="Screenshot 2024-10-29 at 16 16 01"
src="https://github.com/user-attachments/assets/10fdb20d-1f2a-4b0a-a8a1-171050ee620d">


Close https://github.com/coder/internal/issues/116

---------

Co-authored-by: Danny Kopping <danny@coder.com>
This commit is contained in:
Bruno Quaresma
2024-11-01 13:29:00 -03:00
committed by GitHub
co-authored by Danny Kopping
parent 18ef954a03
commit e232aee011
22 changed files with 747 additions and 304 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/builds.md
Generated
+14 -3
View File
@@ -1016,14 +1016,25 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim
```json
{
"agent_connection_timings": [
{
"ended_at": "2019-08-24T14:15:22Z",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
],
"agent_script_timings": [
{
"display_name": "string",
"ended_at": "2019-08-24T14:15:22Z",
"exit_code": 0,
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"status": "string"
"status": "string",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
],
"provisioner_timings": [
@@ -1033,7 +1044,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"resource": "string",
"source": "string",
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z"
}
]
docs/reference/api/schemas.md
Generated
+86 -27
View File
@@ -349,6 +349,28 @@
| --------- | ------ | -------- | ------------ | ----------- |
| `license` | string | true | | |
## codersdk.AgentConnectionTiming
```json
{
"ended_at": "2019-08-24T14:15:22Z",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------------- | -------------------------------------------- | -------- | ------------ | ----------- |
| `ended_at` | string | false | | |
| `stage` | [codersdk.TimingStage](#codersdktimingstage) | false | | |
| `started_at` | string | false | | |
| `workspace_agent_id` | string | false | | |
| `workspace_agent_name` | string | false | | |
## codersdk.AgentScriptTiming
```json
@@ -356,22 +378,26 @@
"display_name": "string",
"ended_at": "2019-08-24T14:15:22Z",
"exit_code": 0,
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"status": "string"
"status": "string",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ----------- |
| `display_name` | string | false | | |
| `ended_at` | string | false | | |
| `exit_code` | integer | false | | |
| `stage` | string | false | | |
| `started_at` | string | false | | |
| `status` | string | false | | |
| Name | Type | Required | Restrictions | Description |
| ---------------------- | -------------------------------------------- | -------- | ------------ | ----------- |
| `display_name` | string | false | | |
| `ended_at` | string | false | | |
| `exit_code` | integer | false | | |
| `stage` | [codersdk.TimingStage](#codersdktimingstage) | false | | |
| `started_at` | string | false | | |
| `status` | string | false | | |
| `workspace_agent_id` | string | false | | |
| `workspace_agent_name` | string | false | | |
## codersdk.AgentSubsystem
@@ -4359,22 +4385,22 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"resource": "string",
"source": "string",
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------ | -------- | ------------ | ----------- |
| `action` | string | false | | |
| `ended_at` | string | false | | |
| `job_id` | string | false | | |
| `resource` | string | false | | |
| `source` | string | false | | |
| `stage` | string | false | | |
| `started_at` | string | false | | |
| Name | Type | Required | Restrictions | Description |
| ------------ | -------------------------------------------- | -------- | ------------ | ----------- |
| `action` | string | false | | |
| `ended_at` | string | false | | |
| `job_id` | string | false | | |
| `resource` | string | false | | |
| `source` | string | false | | |
| `stage` | [codersdk.TimingStage](#codersdktimingstage) | false | | |
| `started_at` | string | false | | |
## codersdk.ProxyHealthReport
@@ -5717,6 +5743,27 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
| ------------------------ |
| `UNSUPPORTED_WORKSPACES` |
## codersdk.TimingStage
```json
"init"
```
### Properties
#### Enumerated Values
| Value |
| --------- |
| `init` |
| `plan` |
| `graph` |
| `apply` |
| `start` |
| `stop` |
| `cron` |
| `connect` |
## codersdk.TokenConfig
```json
@@ -7381,14 +7428,25 @@ If the schedule is empty, the user will be updated to use the default schedule.|
```json
{
"agent_connection_timings": [
{
"ended_at": "2019-08-24T14:15:22Z",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
],
"agent_script_timings": [
{
"display_name": "string",
"ended_at": "2019-08-24T14:15:22Z",
"exit_code": 0,
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"status": "string"
"status": "string",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
],
"provisioner_timings": [
@@ -7398,7 +7456,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"resource": "string",
"source": "string",
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z"
}
]
@@ -7407,10 +7465,11 @@ If the schedule is empty, the user will be updated to use the default schedule.|
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------------- | ----------------------------------------------------------------- | -------- | ------------ | ----------- |
| `agent_script_timings` | array of [codersdk.AgentScriptTiming](#codersdkagentscripttiming) | false | | |
| `provisioner_timings` | array of [codersdk.ProvisionerTiming](#codersdkprovisionertiming) | false | | |
| Name | Type | Required | Restrictions | Description |
| -------------------------- | ------------------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------- |
| `agent_connection_timings` | array of [codersdk.AgentConnectionTiming](#codersdkagentconnectiontiming) | false | | |
| `agent_script_timings` | array of [codersdk.AgentScriptTiming](#codersdkagentscripttiming) | false | | Agent script timings Consolidate agent-related timing metrics into a single struct when updating the API version |
| `provisioner_timings` | array of [codersdk.ProvisionerTiming](#codersdkprovisionertiming) | false | | |
## codersdk.WorkspaceConnectionLatencyMS
docs/reference/api/workspaces.md
Generated
+14 -3
View File
@@ -1641,14 +1641,25 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \
```json
{
"agent_connection_timings": [
{
"ended_at": "2019-08-24T14:15:22Z",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
],
"agent_script_timings": [
{
"display_name": "string",
"ended_at": "2019-08-24T14:15:22Z",
"exit_code": 0,
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z",
"status": "string"
"status": "string",
"workspace_agent_id": "string",
"workspace_agent_name": "string"
}
],
"provisioner_timings": [
@@ -1658,7 +1669,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"resource": "string",
"source": "string",
"stage": "string",
"stage": "init",
"started_at": "2019-08-24T14:15:22Z"
}
]