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
Adds complete documentation for the Template Insights feature covering:
- Overview of active users, app usage, user activity, latency, and parameters
- Step-by-step access instructions with permission requirements
- Visual examples with three screenshots showing key metrics
- Use cases for template optimization, capacity planning, and user support
- Permission model and data privacy considerations
- API access documentation
Includes three new screenshots illustrating the insights interface and metrics.
Closes#21138
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
-**Template Parameters**: Understand which parameter values users are selecting
18
-
19
7
## Accessing Template Insights
20
8
21
9
To view Template Insights:
@@ -24,57 +12,28 @@ To view Template Insights:
24
12
2. Select a template from the list
25
13
3. Click the **Insights** tab
26
14
27
-
> **Note**: Template Insights requires the `view_insights` permission on the template. Template administrators and organization owners have this permission by default.
28
-
29
-
## Insights Data
30
-
31
-
### Active Users Chart
32
-
33
-
The Active Users chart displays the number of unique users who connected to workspaces from this template over time. You can view data by:
34
-
35
-
-**Daily intervals**: Shows activity for each day (default for templates less than 5 weeks old)
36
-
-**Weekly intervals**: Shows activity aggregated by week (default for templates 5 weeks or older)
15
+
> [!NOTE]
16
+
> Template Insights requires the `view_insights` permission on the template. Template administrators and organization owners have this permission.
37
17
38
-
Use the date range picker to analyze specific time periods.
39
-
40
-
### Application Usage
41
-
42
-
The Application Usage section shows which applications users are connecting through:
43
-
44
-
#### Built-in Applications
45
-
46
-
-**VS Code**: Includes VS Code web and desktop connections
If your template includes custom applications (defined via `coder_app` resources), they will appear in this section with their usage statistics.
55
-
56
-
For each application, you can see:
18
+
## Overview
57
19
58
-
- Total seconds of usage during the selected period
59
-
- Number of times the application was launched (for custom apps)
20
+
The Template Insights page displays usage analytics across several key areas:
60
21
61
-
### User Activity
22
+
<small>Template Insights showing weekly active users and connection latency metrics.</small>
62
23
63
-
The User Activity section lists users who have used workspaces from this template, sorted by total usage time. For each user, you can see:
24
+
### Active Users
64
25
65
-
- Username and avatar
66
-
- Total seconds of workspace usage
67
-
- Which templates they used (when viewing insights across multiple templates)
26
+
The Weekly Active Users chart tracks the number of unique users who connected to workspaces from this template over time. This metric helps you:
68
27
69
-
This helps identify:
28
+
- Monitor template adoption trends
29
+
- Identify usage patterns and peak periods
30
+
- Plan infrastructure capacity based on user growth
70
31
71
-
- Power users who may benefit from optimized resources
72
-
- Users who might need additional support or training
73
-
- Overall adoption of the template
32
+
You can view data by daily intervals (default for templates less than 5 weeks old) or weekly intervals (default for templates 5 weeks or older). Use the date range picker to analyze specific time periods.
74
33
75
34
### User Latency
76
35
77
-
The User Latency section displays connection performance metrics:
36
+
The connection latency table displays performance metrics for each user:
78
37
79
38
-**P50 (Median)**: The median connection latency experienced by users
80
39
-**P95**: The 95th percentile latency, indicating worst-case performance for most users
@@ -85,59 +44,57 @@ Latency is color-coded for quick assessment:
85
44
-**Yellow**: Moderate performance (150-300ms)
86
45
-**Red**: Poor performance (> 300ms)
87
46
88
-
High latency may indicate:
47
+
High latency may indicate network issues between users and workspaces, resource constraints on workspace hosts, or geographic distance between users and infrastructure.
89
48
90
-
- Network issues between users and workspaces
91
-
- Resource constraints on workspace hosts
92
-
- Geographic distance between users and infrastructure
49
+
## Application Usage and User Activity
93
50
94
-
### Template Parameters
51
+
Template Insights provides detailed metrics on how users interact with workspace applications and which users are most active.
95
52
96
-
The Template Parameters section shows which parameter values users are selecting when creating workspaces. This helps you:
53
+
97
54
98
-
- Understand common configuration choices
99
-
- Identify unused parameter options
100
-
- Optimize default values based on actual usage
55
+
<small>Application usage statistics and user activity rankings.</small>
101
56
102
-
For each parameter, you can see:
57
+
### App & IDE Usage
103
58
104
-
- Parameter name and type
105
-
- Distribution of selected values
106
-
- Number of workspaces using each value
59
+
The App & IDE Usage section shows which applications users are connecting through, ranked by total usage time.
107
60
108
-
##Use Cases
61
+
### Activity by User
109
62
110
-
### Capacity Planning
63
+
The Activity by user table lists users who have used workspaces from this template, sorted by total usage time. This information helps you:
111
64
112
-
Monitor active user trends to:
65
+
- Identify power users who may benefit from optimized resources
66
+
- Spot users who might need additional support or training
67
+
- Understand overall adoption of the template
68
+
- Plan resource allocation based on actual usage patterns
113
69
114
-
- Predict infrastructure capacity needs
115
-
- Plan for scaling during peak usage periods
116
-
- Identify underutilized templates that could be consolidated
70
+
## Template Parameters
117
71
118
-
### Template Optimization
72
+
Understanding which parameter values users select when creating workspaces helps you optimize template defaults and identify unused options.
- Adjust default parameters based on actual usage patterns
124
-
- Optimize resource allocations for common use cases
76
+
<small>Distribution of memory usage threshold and region parameter selections.</small>
125
77
126
-
### User Support
78
+
The Template Parameters section shows the distribution of values selected for each parameter in your template. In the example above:
127
79
128
-
Identify users with:
80
+
-**Memory usage threshold**: Shows that most workspaces (934) use the default 80% threshold, with only a few using higher thresholds
81
+
-**Region**: Displays geographic distribution of workspaces, with Pittsburgh being the most popular region (232 workspaces), followed by Falkenstein (137) and Cape Town (93)
129
82
130
-
- High latency connections who may need network troubleshooting
131
-
- Low usage who might need onboarding help
132
-
- Specific application preferences for targeted support
83
+
This information helps you:
84
+
85
+
- Understand common configuration choices
86
+
- Identify unused parameter options that could be removed
87
+
- Optimize default values based on actual usage patterns
88
+
- Plan regional infrastructure capacity
133
89
134
-
### ROI and Reporting
90
+
##Use Cases
135
91
136
-
Generate reports on:
92
+
Template Insights helps you make data-driven decisions about your Coder deployment:
137
93
138
-
- Developer productivity through usage metrics
139
-
- Template adoption rates
140
-
- Infrastructure utilization efficiency
94
+
-**Template Optimization**: Remove unused applications or features, adjust default parameters based on actual usage patterns, and optimize resource allocations for common use cases
95
+
-**Capacity Planning**: Monitor active user trends to predict infrastructure capacity needs, plan for scaling during peak usage periods, and identify underutilized templates that could be consolidated
96
+
-**User Support**: Identify users with high latency connections who may need network troubleshooting, low usage who might need onboarding help, or specific application preferences for targeted support
97
+
-**ROI and Reporting**: Generate reports on developer productivity through usage metrics, template adoption rates, and infrastructure utilization efficiency
To grant a user access to Template Insights for a specific template, assign them the `view_insights` permission through [template permissions](./template-permissions.md).
151
108
109
+
Access to insights data is controlled entirely through permissions. To prevent users from viewing insights for a template, do not grant them the `view_insights` permission.
110
+
152
111
## Data Privacy
153
112
154
113
Template Insights aggregates usage data while respecting user privacy:
@@ -166,33 +125,6 @@ Template Insights data is also available via the Coder API. See the [API documen
166
125
-`/api/v2/insights/user-activity` - User activity data
0 commit comments