Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

chore(docs): document agent api debug endpoints#14454

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
DanielleMaywood merged 7 commits intomainfromdm-agent-endpoint-docs
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletionagent/agent.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1787,7 +1787,7 @@ func (a *agent) HandleHTTPDebugLogs(w http.ResponseWriter, r *http.Request) {
}
defer f.Close()

// Limit to10MB.
// Limit to10MiB.
w.WriteHeader(http.StatusOK)
_, err = io.Copy(w, io.LimitReader(f, 10*1024*1024))
if err != nil && !errors.Is(err, io.EOF) {
Expand Down
16 changes: 16 additions & 0 deletionsdocs/manifest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,6 +1105,22 @@
"path": "reference/cli/whoami.md"
}
]
},
{
"title": "Agent API",
"description": "Learn how to use Coder Agent API",
"path": "./reference/agent-api/README.md",
"icon_path": "./images/icons/api.svg",
"children": [
{
"title": "Debug",
"path": "./reference/agent-api/debug.md"
},
{
"title": "Schemas",
"path": "./reference/agent-api/schemas.md"
}
]
}
]
},
Expand Down
1 change: 1 addition & 0 deletionsdocs/reference/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ Autogenerated documentation around Coder.

- [REST API](./api)
- [Command Line](./cli)
- [Agent API](./agent-api)
5 changes: 5 additions & 0 deletionsdocs/reference/agent-api/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
## Sections

<children>
This page is rendered on https://coder.com/docs/reference/agent-api. Refer to the other documents in the `agent-api/` directory.
</children>
76 changes: 76 additions & 0 deletionsdocs/reference/agent-api/debug.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
# Debug

## Get debug logs

### Code samples

```shell
curl $CODER_AGENT_DEBUG_ADDRESS/debug/logs
```

`GET /debug/logs`

Get the first 10MiB of data from `$CODER_AGENT_LOG_DIR/coder-agent.log`.

### Responses

| Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |

## Get debug info for magicsock

### Code samples

```shell
curl $CODER_AGENT_DEBUG_ADDRESS/debug/magicsock
```

`GET /debug/magicsock`

See
[Tailscale's documentation](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.ServeHTTPDebug).

## Toggle debug logging for magicsock

### Code samples

```shell
curl $CODER_AGENT_DEBUG_ADDRESS/debug/magicsock/debug-logging/true
```

`GET /debug/magicsock/debug-logging/{state}`

Set whether debug logging is enabled. See
[Tailscale's documentation](https://pkg.go.dev/tailscale.com/wgengine/magicsock#Conn.SetDebugLoggingEnabled)
for more information.

### Parameters

| Name | In | Type | Required | Description |
| ------- | ---- | ------- | -------- | ------------------- |
| `state` | path | boolean | true | Debug logging state |

### Responses

| Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |

## Get debug manifest

### Code samples

```shell
curl $CODER_AGENT_DEBUG_ADDRESS/debug/manifest
```

`GET /debug/manifest`

Get the manifest the agent fetched from `coderd` upon startup.

### Responses

| Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.Manifest](./schemas.md#agentsdkmanifest) |
124 changes: 124 additions & 0 deletionsdocs/reference/agent-api/schemas.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
# Schemas

## agentsdk.Manifest

```json
{
"agent_id": "151321db-0713-473c-ab42-2cc6ddeab1a4",
"agent_name": "string",
"owner_name": "string",
"workspace_id": "8ef13a0d-a5c9-4fb4-abf2-f8f65c3830fb",
"workspace_name": "string",
"git_auth_configs": 1,
"vscode_port_proxy_uri": "string",
"apps": [
{
"id": "c488c933-688a-444e-a55d-f1e88ecc78f5",
"url": "string",
"external": false,
"slug": "string",
"display_name": "string",
"icon": "string",
"subdomain": false,
"sharing_level": "owner",
"healthcheck": {
"url": "string",
"interval": 5,
"threshold": 6
},
"health": "initializing"
}
],
"derpmap": {
"HomeParams": {},
"Regions": {
"1000": {
"EmbeddedRelay": false,
"RegionID": 1000,
"RegionCode": "string",
"RegionName": "string",
"Nodes": [
{
"Name": "string",
"RegionID": 1000,
"HostName": "string",
"STUNPort": 19302,
"STUNOnly": true
}
]
}
}
},
"derp_force_websockets": false,
"environment_variables": {
"OIDC_TOKEN": "string"
},
"directory": "string",
"motd_file": "string",
"disable_direct_connections": false,
"metadata": [
{
"display_name": "string",
"key": "string",
"script": "string",
"interval": 10,
"timeout": 1
}
],
"scripts": [
{
"log_source_id": "3e79c8da-08ae-48f4-b73e-11e194cdea06",
"log_path": "string",
"script": "string",
"cron": "string",
"run_on_start": true,
"run_on_stop": false,
"start_blocks_login": true,
"timeout": 0
}
]
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `agent_id` | string | true | | |
| `agent_name` | string | true | | |
| `owner_name` | string | true | | |
| `workspace_id` | string | true | | |
| `workspace_name` | string | true | | |
| `git_auth_configs` | int | true | | |
| `vscode_port_proxy_uri` | string | true | | |
| `apps` | array of [codersdk.WorkspaceApp](../api/schemas.md#codersdkworkspaceapp) | true | | |
| `derpmap` | [tailcfg.DERPMap](../api/schemas.md#tailcfgderpmap) | true | | |
| `derp_force_websockets` | boolean | true | | |
| `environment_variables` | object | true | | |
| `directory` | string | true | | |
| `motd_file` | string | true | | |
| `disable_direct_connections` | boolean | true | | |
| `metadata` | array of [codersdk.WorkspaceAgentMetadataDescription](#codersdkworkspaceagentmetadatadescription) | true | | |
| `scripts` | array of [codersdk.WorkspaceAgentScript](../api/schemas.md#codersdkworkspaceagentscript) | true | | |

## codersdk.WorkspaceAgentMetadataDescription

```json
{
"display_name": "string",
"key": "string",
"script": "string",
"interval": 10,
"timeout": 1
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ----------- |
| `display_name` | string | true | | |
| `key` | string | true | | |
| `script` | string | true | | |
| `interval` | integer | true | | |
| `timeout` | integer | true | | |
Loading
[8]ページ先頭
©2009-2025 Movatter.jp