Skip to content

feat: add filecache prometheus metrics #18089

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

Merged
merged 8 commits into from
May 30, 2025
Merged

feat: add filecache prometheus metrics #18089

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
352cb4f
feat: add filecache prometheus metrics
Emyrk May 28, 2025
1bf620c
chore: add unit test to ensure metrics are correct
Emyrk May 28, 2025
3c45ef6
Merge branch 'main' into stevenmasley/file_cache_metrics
Emyrk May 28, 2025
9f8b244
rename metric
Emyrk May 28, 2025
253ddee
fixup! rename metric
Emyrk May 28, 2025
197472e
Merge branch 'main' into stevenmasley/file_cache_metrics
Emyrk May 29, 2025
e54e48a
address PR comments
Emyrk May 30, 2025
a9dbfe5
Merge branch 'main' into stevenmasley/file_cache_metrics
Emyrk May 30, 2025
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
Prev Previous commit
Next Next commit
rename metric
  • Loading branch information
@Emyrk
Emyrk committed May 28, 2025
commit 9f8b24447f6f9ea17c9c26b37af86e9d1ddc4ef0
16 changes: 8 additions & 8 deletions coderd/files/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,43 +47,43 @@ func (c *Cache) registerMetrics(registerer prometheus.Registerer) *Cache {
c.currentCacheSize = f.NewGauge(prometheus.GaugeOpts{
Namespace: "coderd",
Subsystem: subsystem,
Name: "open_files_size_current",
Help: "The current size of all files currently open in the file cache.",
Name: "open_files_size_bytes_current",
Help: "The current amount of memory of all files currently open in the file cache.",
})

c.totalCacheSize = f.NewCounter(prometheus.CounterOpts{
Namespace: "coderd",
Subsystem: subsystem,
Name: "open_files_size_total",
Help: "The total size of all files opened in the file cache.",
Name: "open_files_size_bytes_total",
Help: "The total amount of memory ever opened in the file cache. This number never decrements.",
})

c.currentOpenFiles = f.NewGauge(prometheus.GaugeOpts{
Namespace: "coderd",
Subsystem: subsystem,
Name: "open_files_current",
Help: "The number of unique files currently open in the file cache.",
Help: "The count of unique files currently open in the file cache.",
})

c.totalOpenedFiles = f.NewCounter(prometheus.CounterOpts{
Namespace: "coderd",
Subsystem: subsystem,
Name: "open_files_total",
Help: "The number of unique files opened in the file cache.",
Help: "The total count of unique files ever opened in the file cache.",
})

c.currentOpenFileReferences = f.NewGauge(prometheus.GaugeOpts{
Namespace: "coderd",
Subsystem: subsystem,
Name: "open_file_refs_current",
Help: "The number of file references currently open in the file cache.",
Help: "The count of file references currently open in the file cache. Multiple references can be held for the same file.",
})

c.totalOpenFileReferences = f.NewCounter(prometheus.CounterOpts{
Namespace: "coderd",
Subsystem: subsystem,
Name: "open_file_refs_total",
Help: "The number of file references currently open in the file cache.",
Help: "The total number of file references ever opened in the file cache.",
})

return c
Expand Down
4 changes: 2 additions & 2 deletions coderd/files/cache_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ func TestConcurrency(t *testing.T) {

// Verify all the counts & metrics are correct.
require.Equal(t, batches, c.Count())
require.Equal(t, batches*fileSize, promhelp.GaugeValue(t, reg, cachePromMetricName("open_files_size_current"), nil))
require.Equal(t, batches*fileSize, promhelp.CounterValue(t, reg, cachePromMetricName("open_files_size_total"), nil))
require.Equal(t, batches*fileSize, promhelp.GaugeValue(t, reg, cachePromMetricName("open_files_size_bytes_current"), nil))
require.Equal(t, batches*fileSize, promhelp.CounterValue(t, reg, cachePromMetricName("open_files_size_bytes_stotal"), nil))
require.Equal(t, batches, promhelp.GaugeValue(t, reg, cachePromMetricName("open_files_current"), nil))
require.Equal(t, batches, promhelp.CounterValue(t, reg, cachePromMetricName("open_files_total"), nil))
require.Equal(t, batches*batchSize, promhelp.GaugeValue(t, reg, cachePromMetricName("open_file_refs_current"), nil))
Expand Down
Loading