You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
restarts to apply template updates regardless of user activity.
17
-
-**Activity bump**: The duration of inactivity that must pass before a
18
-
workspace is automatically stopped.
17
+
-**Activity bump**: The duration by which to extend a workspace's deadline when activity is detected (default: 1 hour). The workspace will be considered inactive when no sessions are detected (VSCode, JetBrains, Terminal, or SSH). For details on what counts as activity, see the [user guide on activity detection](../../../user-guides/workspace-scheduling.md#activity-detection).
19
18
-**Dormancy**: This allows automatic deletion of unused workspaces to reduce
Copy file name to clipboardExpand all lines: docs/user-guides/workspace-scheduling.md
+36-17
Original file line number
Diff line number
Diff line change
@@ -37,18 +37,37 @@ days of the week your workspace is allowed to autostart.
37
37
Use autostop to stop a workspace after a number of hours. Autostop won't stop a
38
38
workspace if you're still using it. It will wait for the user to become inactive
39
39
before checking connections again (1 hour by default). Template admins can
40
-
modify the inactivity timeout duration with the
41
-
[inactivity bump](#inactivity-timeout) template setting. Coder checks for active
42
-
connections in the IDE, SSH, Port Forwarding, and coder_app.
40
+
modify this duration with the **activity bump** template setting.
43
41
44
42
45
43
46
-
## Inactivity timeout
44
+
## Activity detection
47
45
48
-
Workspaces will automatically shut down after a period of inactivity. This can
49
-
be configured at the template level, but is visible in the autostop description
46
+
Workspaces automatically shut down after a period of inactivity. The **activity bump**
47
+
duration can be configured at the template level and is visible in the autostop description
50
48
for your workspace.
51
49
50
+
### What counts as workspace activity?
51
+
52
+
A workspace is considered "active" when Coder detects one or more active sessions with your workspace. Coder specifically tracks these session types:
53
+
54
+
-**VSCode sessions**: Using code-server or VS Code with a remote extension
55
+
-**JetBrains IDE sessions**: Using JetBrains Gateway or remote IDE plugins
56
+
-**Terminal sessions**: Using the web terminal (including reconnecting to the web terminal)
57
+
-**SSH sessions**: Connecting via `coder ssh` or SSH config integration
58
+
59
+
Activity is only detected when there is at least one active session. An open session will keep your workspace marked as active and prevent automatic shutdown.
60
+
61
+
The following actions do **not** count as workspace activity:
62
+
63
+
- Viewing workspace details in the dashboard
64
+
- Viewing or editing workspace settings
65
+
- Viewing build logs or audit logs
66
+
- Accessing ports through direct URLs without an active session
67
+
- Background agent statistics reporting
68
+
69
+
To avoid unexpected cloud costs, close your connections, this includes IDE windows, SSH sessions, and others, when you finish using your workspace.
70
+
52
71
## Autostop requirement
53
72
54
73
> [!NOTE]
@@ -79,13 +98,13 @@ stopped due to the policy at the **start** of the user's quiet hours.
79
98
80
99
## Scheduling configuration examples
81
100
82
-
The combination of autostart, autostop, and the inactivity timer create a
101
+
The combination of autostart, autostop, and the activity bump create a
83
102
powerful system for scheduling your workspace. However, synchronizing all of
84
103
them simultaneously can be somewhat challenging, here are a few example
85
104
configurations to better understand how they interact.
86
105
87
106
> [!NOTE]
88
-
> The inactivity timer must be configured by your template admin.
107
+
> The activity bump must be configured by your template admin.
89
108
90
109
### Working hours
91
110
@@ -95,14 +114,14 @@ a "working schedule" for your workspace. It's pretty intuitive:
95
114
If I want to use my workspace from 9 to 5 on weekdays, I would set my autostart
96
115
to 9:00 AM every day with an autostop of 9 hours. My workspace will always be
97
116
available during these hours, regardless of how long I spend away from my
98
-
laptop. If I end up working overtime and log off at 6:00 PM, the inactivity
99
-
timer will kick in, postponing the shutdown until 7:00 PM.
117
+
laptop. If I end up working overtime and log off at 6:00 PM, the activity bump
118
+
will kick in, postponing the shutdown until 7:00 PM.
100
119
101
-
#### Basing solely on inactivity
120
+
#### Basing solely on activity detection
102
121
103
122
If you'd like to ignore the TTL from autostop and have your workspace solely
104
-
function on inactivity, you can **set your autostop equal to inactivity
105
-
timeout**.
123
+
function on activity detection, you can set your autostop equal to activity
124
+
bump duration.
106
125
107
126
Let's say that both are set to 5 hours. When either your workspace autostarts or
108
127
you sign in, you will have confidence that the only condition for shutdown is 5
0 commit comments