@@ -33,15 +33,16 @@ You can filter connection logs by the following parameters:
3333- ` workspace_owner ` - The username of the owner of the workspace being connected
3434 to.
3535- ` type ` - The type of the connection, such as SSH, VS Code, or workspace app.
36- An exhaustive list is
37- [ available here ] ( https://pkg.go.dev/github.com/coder/coder/v2/codersdk#ConnectionType ) .
36+ For more connection types, refer to the
37+ [ CoderSDK documentation ] ( https://pkg.go.dev/github.com/coder/coder/v2/codersdk#ConnectionType ) .
3838- ` username ` : The name of the user who initiated the connection.
3939 Results will not include SSH or IDE sessions.
4040- ` user_email ` : The email of the user who initiated the connection.
4141 Results will not include SSH or IDE sessions.
4242- ` started_after ` : The time after which the connection started.
4343 Uses the RFC3339Nano format.
44- - ` started_before ` : The time before which the connection started. Uses the RFC3339Nano format.
44+ - ` started_before ` : The time before which the connection started.
45+ Uses the RFC3339Nano format.
4546- ` workspace_id ` : The ID of the workspace being connected to.
4647- ` connection_id ` : The ID of the connection.
4748- ` status ` : The status of the connection, either ` ongoing ` or ` completed ` .
@@ -50,16 +51,17 @@ You can filter connection logs by the following parameters:
5051
5152## Capturing/Exporting Connection Logs
5253
53- In addition to the user interface , there are multiple ways to consume or query
54+ In addition to the Coder dashboard , there are multiple ways to consume or query
5455connection events.
5556
56- ## REST API
57+ ### REST API
5758
58- Connection logs can be retrieved via our REST API. You can find detailed
59- information about this in our
60- [ endpoint documentation] ( ../../reference/api/enterprise.md#get-connection-logs ) .
59+ You can retrieve connection logs via the Coder API.
60+ Visit the
61+ [ ` get-connection-logs ` endpoint documentation] ( ../../reference/api/enterprise.md#get-connection-logs )
62+ for details.
6163
62- ## Service Logs
64+ ### Service Logs
6365
6466Connection events are also dispatched as service logs and can be captured and
6567categorized using any log management tool such as [ Splunk] ( https://splunk.com ) .
@@ -104,6 +106,6 @@ connection log entry, when `code-server` is opened:
104106[API] 2025-07-03 06:57:16.157 [info] coderd: connection_log request_id=de3f6004-6cc1-4880-a296-d7c6ca1abf75 ID=f0249951-d454-48f6-9504-e73340fa07b7 Time="2025-07-03T06:57:16.144719Z" OrganizationID=0665a54f-0b77-4a58-94aa-59646fa38a74 WorkspaceOwnerID=6dea5f8c-ecec-4cf0-a5bd-bc2c63af2efa WorkspaceID=3c0b37c8-e58c-4980-b9a1-2732410480a5 WorkspaceName=dev AgentName=main Type=workspace_app Code=200 Ip=127.0.0.1 UserAgent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36" UserID=6dea5f8c-ecec-4cf0-a5bd-bc2c63af2efa SlugOrPort=code-server ConnectionID=<nil> CloseReason="" ConnectionStatus=connected
105107```
106108
107- ## Enabling this feature
109+ ## How to Enable Connection Logs
108110
109- This feature is only available with a premium license.
111+ This feature is only available with a [ Premium license] ( ../licensing/index.md ) .
0 commit comments