mirror of
https://github.com/coder/coder.git
synced 2026-06-06 14:38:23 +00:00
Marcin Tojek
04b0253e8a
Fixes: coder/internal#767 Adds two new Prometheus metrics for license health monitoring: - `coderd_license_warnings` - count of active license warnings - `coderd_license_errors` - count of active license errors Metrics endpoint after startup of a deployment with license enabled: ``` ... # HELP coderd_license_errors The number of active license errors. # TYPE coderd_license_errors gauge coderd_license_errors 0 ... # HELP coderd_license_warnings The number of active license warnings. # TYPE coderd_license_warnings gauge coderd_license_warnings 0 ... ```
70 lines
2.5 KiB
Go
70 lines
2.5 KiB
Go
package license
|
|
|
|
import (
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
|
|
"github.com/coder/coder/v2/coderd/entitlements"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
)
|
|
|
|
var (
|
|
activeUsersDesc = prometheus.NewDesc("coderd_license_active_users", "The number of active users.", nil, nil)
|
|
limitUsersDesc = prometheus.NewDesc("coderd_license_limit_users", "The user seats limit based on the active Coder license.", nil, nil)
|
|
userLimitEnabledDesc = prometheus.NewDesc("coderd_license_user_limit_enabled", "Returns 1 if the current license enforces the user limit.", nil, nil)
|
|
|
|
// Metrics for license warnings and errors.
|
|
licenseWarningsDesc = prometheus.NewDesc("coderd_license_warnings", "The number of active license warnings.", nil, nil)
|
|
licenseErrorsDesc = prometheus.NewDesc("coderd_license_errors", "The number of active license errors.", nil, nil)
|
|
)
|
|
|
|
type MetricsCollector struct {
|
|
Entitlements *entitlements.Set
|
|
}
|
|
|
|
var _ prometheus.Collector = new(MetricsCollector)
|
|
|
|
func (*MetricsCollector) Describe(descCh chan<- *prometheus.Desc) {
|
|
descCh <- activeUsersDesc
|
|
descCh <- limitUsersDesc
|
|
descCh <- userLimitEnabledDesc
|
|
descCh <- licenseWarningsDesc
|
|
descCh <- licenseErrorsDesc
|
|
}
|
|
|
|
func (mc *MetricsCollector) Collect(metricsCh chan<- prometheus.Metric) {
|
|
// Collect user limit metrics.
|
|
mc.collectUserLimit(metricsCh)
|
|
|
|
// Collect license warnings and errors metrics.
|
|
mc.collectWarningsAndErrors(metricsCh)
|
|
}
|
|
|
|
func (mc *MetricsCollector) collectUserLimit(metricsCh chan<- prometheus.Metric) {
|
|
userLimitEntitlement, ok := mc.Entitlements.Feature(codersdk.FeatureUserLimit)
|
|
if !ok {
|
|
return
|
|
}
|
|
|
|
var enabled float64
|
|
if userLimitEntitlement.Enabled {
|
|
enabled = 1
|
|
}
|
|
metricsCh <- prometheus.MustNewConstMetric(userLimitEnabledDesc, prometheus.GaugeValue, enabled)
|
|
|
|
if userLimitEntitlement.Actual != nil {
|
|
metricsCh <- prometheus.MustNewConstMetric(activeUsersDesc, prometheus.GaugeValue, float64(*userLimitEntitlement.Actual))
|
|
}
|
|
|
|
if userLimitEntitlement.Limit != nil {
|
|
metricsCh <- prometheus.MustNewConstMetric(limitUsersDesc, prometheus.GaugeValue, float64(*userLimitEntitlement.Limit))
|
|
}
|
|
}
|
|
|
|
func (mc *MetricsCollector) collectWarningsAndErrors(metricsCh chan<- prometheus.Metric) {
|
|
warnings := mc.Entitlements.Warnings()
|
|
errors := mc.Entitlements.Errors()
|
|
|
|
metricsCh <- prometheus.MustNewConstMetric(licenseWarningsDesc, prometheus.GaugeValue, float64(len(warnings)))
|
|
metricsCh <- prometheus.MustNewConstMetric(licenseErrorsDesc, prometheus.GaugeValue, float64(len(errors)))
|
|
}
|