Skip to content

Add a timeout + debug steps to the Coder agent (agent stuck in Connecting... forever isn't accurate) #4678

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.

Sign up for GitHub

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

Jump to bottom
Closed
bpmct opened this issue Oct 21, 2022 · 2 comments · Fixed by #4937
Closed

Add a timeout + debug steps to the Coder agent (agent stuck in Connecting... forever isn't accurate) #4678

bpmct opened this issue Oct 21, 2022 · 2 comments · Fixed by #4937
Milestone
EE

Comments

@bpmct
Copy link
Member

bpmct commented Oct 21, 2022 •
edited
Loading

This is taken from #4201

Step 3. Add a timeout parameter to the coder_agent resource
After the specified duration of inactivity, the UI and CLI would display that something wrong happened. Templates can define a debug_url parameter in their front-matter that can direct users to a help page.

After the timeout, the agent can go from Connecting to Disconnected

This debug_url can be surfaced in the dashboard/CLI to make it easy for admins to troubleshoot a timed-out workspace. For larger deployments, an admin could edit the template README and change debug_url to an internal wiki/chat/ticketing system so users can request help. Perhaps the debug URL could also be surfaced for failed builds as well
@bpmct bpmct added this to the EE milestone Oct 21, 2022
@bpmct bpmct mentioned this issue Oct 21, 2022
Closed
@BrunoQuaresma
Copy link
Collaborator

I made some designs for this one:

Initial
Tooltip Open

Figma link: https://www.figma.com/file/YIGBkXUcnRGz2ZKNmLaJQf/Coder-Product-V2?node-id=1484%3A963

@BrunoQuaresma
Copy link
Collaborator

Some thoughts:

  • Add a coder agent config called connection_timeout
  • If the connection is "timeout" interrupt the connection to free up some resources
  • When timeout, the WorkspaceAgentStatus should be timeout so we can consistently rely on that on the client side (CLI and Web App)

mafredri added a commit to coder/terraform-provider-coder that referenced this issue Nov 7, 2022
@mafredri
feat: Add connection_timeout and troubleshooting_url to agent
98d1639 
Related: coder/coder#4678
@mafredri mafredri mentioned this issue Nov 7, 2022
Merged
mafredri added a commit to coder/terraform-provider-coder that referenced this issue Nov 7, 2022
@mafredri
feat: Add connection_timeout and troubleshooting_url to agent (#71)
dbd74d6 
Related: coder/coder#4678
@mafredri mafredri mentioned this issue Nov 7, 2022
Merged
mafredri added a commit that referenced this issue Nov 7, 2022
@mafredri
feat: Add connection_timeout and troubleshooting_url to agent
a1e1238 
This commit adds the connection timeout and troubleshooting url fields
to coder agents.

If an initial connection cannot be established within connection timeout
seconds, then the agent status will be marked as `"timeout"`.

The troubleshooting URL will be present, if configured in the Terraform
template, it can be presented to the user when the agent state is either
`"timeout"` or `"disconnected"`.

Fixes #4678
mafredri added a commit that referenced this issue Nov 7, 2022
@mafredri
feat: Add connection_timeout and troubleshooting_url to agent
f02dfca 
This commit adds the connection timeout and troubleshooting url fields
to coder agents.

If an initial connection cannot be established within connection timeout
seconds, then the agent status will be marked as `"timeout"`.

The troubleshooting URL will be present, if configured in the Terraform
template, it can be presented to the user when the agent state is either
`"timeout"` or `"disconnected"`.

Fixes #4678
mafredri added a commit that referenced this issue Nov 9, 2022
@mafredri
feat: Add connection_timeout and troubleshooting_url to agent
2bf20be 
This commit adds the connection timeout and troubleshooting url fields
to coder agents.

If an initial connection cannot be established within connection timeout
seconds, then the agent status will be marked as `"timeout"`.

The troubleshooting URL will be present, if configured in the Terraform
template, it can be presented to the user when the agent state is either
`"timeout"` or `"disconnected"`.

Fixes #4678
mafredri added a commit that referenced this issue Nov 9, 2022
@mafredri
feat: Add connection_timeout and troubleshooting_url to agent (#4937)
90c34b7 
* feat: Add connection_timeout and troubleshooting_url to agent

This commit adds the connection timeout and troubleshooting url fields
to coder agents.

If an initial connection cannot be established within connection timeout
seconds, then the agent status will be marked as `"timeout"`.

The troubleshooting URL will be present, if configured in the Terraform
template, it can be presented to the user when the agent state is either
`"timeout"` or `"disconnected"`.

Fixes #4678
DanielleMaywood pushed a commit to coder/terraform-provider-coder that referenced this issue Sep 5, 2024
@mafredri @DanielleMaywood
feat: Add connection_timeout and troubleshooting_url to agent (#71)
b20adf0 
Related: coder/coder#4678
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
EE
Development

Successfully merging a pull request may close this issue.

feat: Add connection_timeout and troubleshooting_url to agent coder/coder
2 participants
@BrunoQuaresma @bpmct