diff --git a/.golangci.yml b/.golangci.yml index a94219817..8d0b72a6b 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -93,10 +93,6 @@ linters: - legacy - std-error-handling rules: - # Shutdown needs a fresh timeout after the server context is cancelled. - - path: ^base/utils/gin\.go$ - linters: [gosec] - text: "G118:" # The inline analyzer cannot handle generic type inference yet. - path: ^manager/middlewares/rbac\.go$ linters: [govet] diff --git a/Dockerfile b/Dockerfile index 9ad9c5af5..dccf65dc8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -48,7 +48,7 @@ RUN if [ "$INSTALL_TOOLS" == "yes" ] ; then \ go install github.com/swaggo/swag/cmd/swag@v1.16.4 && \ go install gotest.tools/gotestsum@v1.13.0 && \ curl -sSfL https://golangci-lint.run/install.sh \ - | sh -s -- -b $(go env GOPATH)/bin ; \ + | sh -s -- -b $(go env GOPATH)/bin v2.15.0 ; \ fi ADD --chown=insights:insights dev/kafka/secrets/ca.crt /opt/kafka/ diff --git a/base/metrics/certificate_expiry.go b/base/metrics/certificate_expiry.go index 899c23b42..0013186c5 100644 --- a/base/metrics/certificate_expiry.go +++ b/base/metrics/certificate_expiry.go @@ -14,8 +14,8 @@ const candlepinCertLabel = "candlepin" // It is registered only where metrics are pushed (e.g. vmaas_sync), not on every pod's default registry. var CertificateExpiryDays = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "Number of days until the certificate expires by the certificate label", - Namespace: "patchman_engine", - Subsystem: "core", + Namespace: Namespace, + Subsystem: SubsystemCore, Name: "certificate_expiry_days", }, []string{"certificate_label"}) diff --git a/base/metrics/certificate_expiry_test.go b/base/metrics/certificate_expiry_test.go index 0ec0b0143..47d8f1b0e 100644 --- a/base/metrics/certificate_expiry_test.go +++ b/base/metrics/certificate_expiry_test.go @@ -41,8 +41,8 @@ func testCandlepinPEMs(t *testing.T) (certPEM, keyPEM string) { func TestApplyCandlepinCertExpiry_setsGauge(t *testing.T) { gv := prometheus.NewGaugeVec(prometheus.GaugeOpts{ - Namespace: "patchman_engine", - Subsystem: "core", + Namespace: Namespace, + Subsystem: SubsystemCore, Name: "certificate_expiry_days_test_helper", Help: "test", }, []string{"certificate_label"}) @@ -57,8 +57,8 @@ func TestApplyCandlepinCertExpiry_setsGauge(t *testing.T) { func TestApplyCandlepinCertExpiry_badPEMDeletesSeries(t *testing.T) { gv := prometheus.NewGaugeVec(prometheus.GaugeOpts{ - Namespace: "patchman_engine", - Subsystem: "core", + Namespace: Namespace, + Subsystem: SubsystemCore, Name: "certificate_expiry_days_test_helper_bad", Help: "test", }, []string{"certificate_label"}) @@ -78,8 +78,8 @@ func TestApplyCandlepinCertExpiry_badPEMDeletesSeries(t *testing.T) { func TestApplyCandlepinCertExpiry_missingConfigDeletesSeries(t *testing.T) { gv := prometheus.NewGaugeVec(prometheus.GaugeOpts{ - Namespace: "patchman_engine", - Subsystem: "core", + Namespace: Namespace, + Subsystem: SubsystemCore, Name: "certificate_expiry_days_test_helper_clear", Help: "test", }, []string{"certificate_label"}) diff --git a/base/metrics/metrics.go b/base/metrics/metrics.go index f3e69602d..9a6635962 100644 --- a/base/metrics/metrics.go +++ b/base/metrics/metrics.go @@ -9,20 +9,33 @@ import ( "github.com/prometheus/client_golang/prometheus" ) +const ( + Namespace = "patchman_engine" + SubsystemCore = "core" + SubsystemEvaluator = "evaluator" + SubsystemListener = "listener" + SubsystemManager = "manager" + SubsystemTasks = "tasks" + SubsystemVmaasSync = "vmaas_sync" + LabelType = "type" + LabelVersion = "version" + LabelEvent = "event" +) + var ( KafkaConnectionErrorCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "Counter vector measuring Kafka connection issues when trying to read or write a message", - Namespace: "patchman_engine", - Subsystem: "core", + Namespace: Namespace, + Subsystem: SubsystemCore, Name: "kafka_connection_errors", - }, []string{"type"}) + }, []string{LabelType}) EngineVersion = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "Patchman project deployment information", - Namespace: "patchman_engine", - Subsystem: "core", + Namespace: Namespace, + Subsystem: SubsystemCore, Name: "info", - }, []string{"version"}) + }, []string{LabelVersion}) ) func init() { diff --git a/base/utils/gin.go b/base/utils/gin.go index d6b896444..3c28b14f1 100644 --- a/base/utils/gin.go +++ b/base/utils/gin.go @@ -120,7 +120,8 @@ func RunServer(ctx context.Context, handler http.Handler, port int) error { defer close(shutdownDone) <-ctx.Done() LogDebug("gracefully shutting down server...") - shutdownCtx, cancel := context.WithTimeout(context.Background(), serverShutdownTimeout) + // Parent ctx is already cancelled; WithoutCancel keeps values and gives Shutdown a fresh timeout budget. + shutdownCtx, cancel := context.WithTimeout(context.WithoutCancel(ctx), serverShutdownTimeout) defer cancel() err := srv.Shutdown(shutdownCtx) if err != nil { diff --git a/evaluator/metrics.go b/evaluator/metrics.go index 54f75b6c2..39285c548 100644 --- a/evaluator/metrics.go +++ b/evaluator/metrics.go @@ -3,6 +3,7 @@ package evaluator import ( "app/base" "app/base/core" + "app/base/metrics" "app/base/utils" "app/manager/middlewares" @@ -13,59 +14,59 @@ import ( var ( evaluationCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many systems were evaluated with which result", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "evaluation", - }, []string{"type"}) + }, []string{metrics.LabelType}) updatesCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many updates were found of which type", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "updates", - }, []string{"type"}) + }, []string{metrics.LabelType}) evaluationDuration = prometheus.NewHistogramVec(prometheus.HistogramOpts{ Help: "How long it took system evaluation of which type (upload, recalc)", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "evaluation_duration_seconds", - }, []string{"type"}) + }, []string{metrics.LabelType}) evaluationPartDuration = prometheus.NewHistogramVec(prometheus.HistogramOpts{ Help: "How long it took particular evaluation part", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "evaluation_part_duration_seconds", }, []string{"part"}) uploadEvaluationDelay = prometheus.NewHistogram(prometheus.HistogramOpts{ Help: "How long it takes from upload to evaluation", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "upload_evaluation_delay_seconds", Buckets: []float64{1, 5, 15, 30, 60, 300}, }) twoEvaluationsInterval = prometheus.NewHistogram(prometheus.HistogramOpts{ Help: "How long it takes between two evaluations", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "two_evaluations_interval_hours", Buckets: []float64{1, 2, 6, 24, 72, 168}, }) packageCacheCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many packages hit/miss package cache", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "package_cache", - }, []string{"type", "by"}) + }, []string{metrics.LabelType, "by"}) packageCacheGauge = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "Package cache size", - Namespace: "patchman_engine", - Subsystem: "evaluator", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemEvaluator, Name: "package_cache_size", }, []string{"by"}) ) diff --git a/listener/metrics.go b/listener/metrics.go index 759229a9d..e34119479 100644 --- a/listener/metrics.go +++ b/listener/metrics.go @@ -3,6 +3,7 @@ package listener import ( "app/base" "app/base/core" + "app/base/metrics" "app/base/utils" "app/manager/middlewares" @@ -30,49 +31,49 @@ const ( var ( eventMsgsReceivedCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many messages received by listener, which event type, which process result", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "kafka_message_received", - }, []string{"event", "type"}) + }, []string{metrics.LabelEvent, metrics.LabelType}) templateMsgReceivedCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "Number of template messages received by type", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "template_message_received", - }, []string{"event", "type"}) + }, []string{metrics.LabelEvent, metrics.LabelType}) messageHandlingDuration = prometheus.NewHistogramVec(prometheus.HistogramOpts{ Help: "How long it took to process the message", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "kafka_message_handling_duration_seconds", - }, []string{"event"}) + }, []string{metrics.LabelEvent}) templateMsgHandlingDuration = prometheus.NewHistogramVec(prometheus.HistogramOpts{ Help: "How long it took to process the message", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "template_message_handling_duration_seconds", - }, []string{"event"}) + }, []string{metrics.LabelEvent}) reposAddedCnt = prometheus.NewCounter(prometheus.CounterOpts{ Help: "How many repositories were added", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "repos_added", }) receivedFromReporter = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many messages were received from which reporter", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "received_from_reporter", }, []string{"reporter"}) messagePartDuration = prometheus.NewHistogramVec(prometheus.HistogramOpts{ Help: "How long particular listener part took", - Namespace: "patchman_engine", - Subsystem: "listener", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemListener, Name: "kafka_message_part_duration_seconds", }, []string{"part"}) ) diff --git a/manager/controllers/advisory_systems.go b/manager/controllers/advisory_systems.go index 6bf20be1f..85987c2b5 100644 --- a/manager/controllers/advisory_systems.go +++ b/manager/controllers/advisory_systems.go @@ -66,8 +66,8 @@ var AdvisorySystemOpts = ListOpts{ }, }, DefaultSort: "-last_upload", - StableSort: "si.id", - SearchFields: []string{"si.display_name"}, + StableSort: systemInventoryID, + SearchFields: []string{systemInventoryDisplayName}, } func advisorySystemsCommon(c *gin.Context) (*gorm.DB, *ListMeta, []string, error) { diff --git a/manager/controllers/advisory_systems_export.go b/manager/controllers/advisory_systems_export.go index f9488b336..fa73f8128 100644 --- a/manager/controllers/advisory_systems_export.go +++ b/manager/controllers/advisory_systems_export.go @@ -21,8 +21,8 @@ var AdvisorySystemExportOpts = ListOpts{ }, }, DefaultSort: "-last_upload", - StableSort: "si.id", - SearchFields: []string{"si.display_name"}, + StableSort: systemInventoryID, + SearchFields: []string{systemInventoryDisplayName}, } // @Summary Export systems for my account @@ -86,7 +86,7 @@ func AdvisorySystemsExportHandler(c *gin.Context) { } // Error handled in method itself query, _ = ApplyInventoryFilter(filters, query, "si.inventory_id") - query = query.Order("si.id") + query = query.Order(systemInventoryID) query, err = ExportListCommon(query, c, AdvisorySystemExportOpts) if err != nil { return diff --git a/manager/controllers/package_systems.go b/manager/controllers/package_systems.go index d9d3fea8e..f4846a504 100644 --- a/manager/controllers/package_systems.go +++ b/manager/controllers/package_systems.go @@ -18,8 +18,8 @@ var PackageSystemsOpts = ListOpts{ // By default, we show only fresh systems. If all systems are required, you must pass in:true,false filter into the api DefaultFilters: map[string]FilterData{}, DefaultSort: "inventory_id", - StableSort: "si.id", - SearchFields: []string{"si.display_name"}, + StableSort: systemInventoryID, + SearchFields: []string{systemInventoryDisplayName}, } //nolint:lll diff --git a/manager/controllers/systems.go b/manager/controllers/systems.go index 607c62674..2e4f1a049 100644 --- a/manager/controllers/systems.go +++ b/manager/controllers/systems.go @@ -22,8 +22,8 @@ var SystemsSelect = database.MustGetSelect(&SystemDBLookup{}) var SystemOpts = ListOpts{ Fields: SystemsFields, DefaultSort: "-last_upload", - StableSort: "si.id", - SearchFields: []string{"si.display_name"}, + StableSort: systemInventoryID, + SearchFields: []string{systemInventoryDisplayName}, } type SystemsID struct { diff --git a/manager/controllers/systems_export.go b/manager/controllers/systems_export.go index 668bebc5c..93e9d4428 100644 --- a/manager/controllers/systems_export.go +++ b/manager/controllers/systems_export.go @@ -72,7 +72,7 @@ func SystemsExportHandler(c *gin.Context) { var systems []SystemDBLookupExtended - query = query.Order("si.id") + query = query.Order(systemInventoryID) query, err = ExportListCommon(query, c, SystemOpts) if err != nil { return diff --git a/manager/controllers/template_systems.go b/manager/controllers/template_systems.go index 247cb7359..fa250e4e1 100644 --- a/manager/controllers/template_systems.go +++ b/manager/controllers/template_systems.go @@ -19,8 +19,8 @@ var TemplateSystemOpts = ListOpts{ Fields: templateSystemFields, DefaultFilters: map[string]FilterData{}, DefaultSort: "-display_name", - StableSort: "si.id", - SearchFields: []string{"si.display_name"}, + StableSort: systemInventoryID, + SearchFields: []string{systemInventoryDisplayName}, } type TemplateSystemsDBLookup struct { diff --git a/manager/controllers/utils.go b/manager/controllers/utils.go index 7dc94207c..d9d35bbd7 100644 --- a/manager/controllers/utils.go +++ b/manager/controllers/utils.go @@ -28,6 +28,8 @@ const InvalidFilter = "Invalid filter field: %v" const InvalidTagMsg = "Invalid tag '%s'. Use 'namespace/key=val format'" const InvalidNestedFilter = "Nested operators not yet implemented for standard filters" const FilterNotSupportedMsg = "filtering not supported on this endpoint" +const systemInventoryID = "si.id" +const systemInventoryDisplayName = "si.display_name" var tagRegex = regexp.MustCompile(`([^/=]+)/([^/=]+)(=([^/=]+))?`) diff --git a/manager/middlewares/prometheus.go b/manager/middlewares/prometheus.go index f7cca17e0..047988fb0 100644 --- a/manager/middlewares/prometheus.go +++ b/manager/middlewares/prometheus.go @@ -1,6 +1,7 @@ package middlewares import ( + "app/base/metrics" "app/base/utils" "strings" @@ -10,59 +11,59 @@ import ( ) var serviceErrorCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "dependency_call", }, []string{"name", "status"}) var requestDurations = prometheus.NewHistogramVec(prometheus.HistogramOpts{ Help: "Request Durations", - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "request_durations", Buckets: []float64{1, 1.5, 1.75, 2, 2.5, 3, 3.5, 4}, }, []string{"endpoint"}) var callerSourceCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "caller_source", }, []string{"source", "account"}) var AdvisoryDetailCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many advisories hit/miss cache", - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "advisory_detail_cache", -}, []string{"type"}) +}, []string{metrics.LabelType}) var AdvisoryDetailGauge = prometheus.NewGauge(prometheus.GaugeOpts{ Help: "Advisory detail cache size", - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "advisory_detail_cache_size", }) var AdvisoryAccountDataCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many requests hit/miss advisory_account_data", - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "advisory_account_data_cache", -}, []string{"type"}) +}, []string{metrics.LabelType}) var PackageAccountDataCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many requests hit/miss package_account_data", - Namespace: "patchman_engine", - Subsystem: "manager", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemManager, Name: "package_account_data_cache", -}, []string{"type"}) +}, []string{metrics.LabelType}) // Create and configure Prometheus middleware to expose metrics func Prometheus() *ginprometheus.Prometheus { prometheus.MustRegister(serviceErrorCnt, requestDurations, callerSourceCnt, AdvisoryDetailCnt, AdvisoryDetailGauge, AdvisoryAccountDataCnt, PackageAccountDataCnt) - p := ginprometheus.NewPrometheus("patchman_engine") + p := ginprometheus.NewPrometheus(metrics.Namespace) p.MetricsPath = utils.CoreCfg.MetricsPath unifyParametrizedUrlsCounters(p) return p diff --git a/tasks/vmaas_sync/metrics.go b/tasks/vmaas_sync/metrics.go index 686b995e3..2b9c5126a 100644 --- a/tasks/vmaas_sync/metrics.go +++ b/tasks/vmaas_sync/metrics.go @@ -24,78 +24,78 @@ const ( var ( vmaasCallCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many times vmaas was called with which result", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "vmaas_call", - }, []string{"type"}) + }, []string{metrics.LabelType}) storeAdvisoriesCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many advisories were loaded with which result", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "store_advisories", - }, []string{"type"}) + }, []string{metrics.LabelType}) storePackagesCnt = prometheus.NewCounterVec(prometheus.CounterOpts{ Help: "How many packages were loaded with which result", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "store_packages", - }, []string{"type"}) + }, []string{metrics.LabelType}) systemsCnt = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "How many systems are stored and how up-to-date they are", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "systems", }, []string{"opt_out", "last_upload"}) advisoriesCnt = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "How many advisories are stored of which type", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "advisories", - }, []string{"type"}) + }, []string{metrics.LabelType}) packageCnt = prometheus.NewGauge(prometheus.GaugeOpts{ Help: "How many packages are stored", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "packages", }) packageNameCnt = prometheus.NewGauge(prometheus.GaugeOpts{ Help: "How many package names are stored", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "package_names", }) systemAdvisoriesStats = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "Max advisories per system found of which type", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "system_advisories_stats", - }, []string{"type"}) + }, []string{metrics.LabelType}) syncDuration = prometheus.NewHistogram(prometheus.HistogramOpts{ Help: "How long it took to sync from vmaas service", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "sync_duration_seconds", }) messageSendDuration = prometheus.NewHistogram(prometheus.HistogramOpts{ Help: "How long it took to send message", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "message_send_duration_seconds", }) advisoriesCountMismatch = prometheus.NewCounter(prometheus.CounterOpts{ Help: "How many advisories were not synced after incremental sync", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "advisory_incermental_sync_mismatch", }) ) @@ -109,7 +109,7 @@ func Metrics() *push.Pusher { // update advanced metrics update() - pusher := push.New(utils.CoreCfg.PrometheusPushGateway, "vmaas_sync").Gatherer(registry) + pusher := push.New(utils.CoreCfg.PrometheusPushGateway, metrics.SubsystemVmaasSync).Gatherer(registry) return pusher } diff --git a/tasks/vmaas_sync/metrics_db.go b/tasks/vmaas_sync/metrics_db.go index 864f71c0c..e509ba13e 100644 --- a/tasks/vmaas_sync/metrics_db.go +++ b/tasks/vmaas_sync/metrics_db.go @@ -1,6 +1,7 @@ package vmaas_sync import ( + "app/base/metrics" "app/base/utils" "app/tasks" "fmt" @@ -11,15 +12,15 @@ import ( var ( databaseSizeBytesGaugeVec = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "Current database size and tables sizes in bytes", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "database_size_bytes", }, []string{"table"}) databaseProcessesGaugeVec = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "Database processes per particular use", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "database_processes", }, []string{"usename", "state"}) ) diff --git a/tasks/vmaas_sync/metrics_systems.go b/tasks/vmaas_sync/metrics_systems.go index e75a574bb..2bda1685b 100644 --- a/tasks/vmaas_sync/metrics_systems.go +++ b/tasks/vmaas_sync/metrics_systems.go @@ -2,6 +2,7 @@ package vmaas_sync import ( "app/base/database" + "app/base/metrics" "app/base/utils" "app/tasks" @@ -17,17 +18,17 @@ const ( var ( systemsCntByType = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "How many systems are stored and how up-to-date they are", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "systems_count_by_type", - }, []string{"type"}) + }, []string{metrics.LabelType}) tagsCntByType = prometheus.NewGaugeVec(prometheus.GaugeOpts{ Help: "How many inventory hosts and which tags are there", - Namespace: "patchman_engine", - Subsystem: "vmaas_sync", + Namespace: metrics.Namespace, + Subsystem: metrics.SubsystemVmaasSync, Name: "tags_count_by_type", - }, []string{"type"}) + }, []string{metrics.LabelType}) ) // nolint: lll diff --git a/turnpike/controllers/admin.go b/turnpike/controllers/admin.go index 25e421139..71579da2a 100644 --- a/turnpike/controllers/admin.go +++ b/turnpike/controllers/admin.go @@ -33,7 +33,7 @@ func Syncapi(c *gin.Context) { err := sync.SyncData(middlewares.DBWriter(c), nil, vmaasExportedTS) if err != nil { utils.LogError("err", err, "manual called syncing failed") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } utils.LogInfo("manual syncing finished successfully") @@ -54,7 +54,7 @@ func Recalc(c *gin.Context) { err := sync.SendReevaluationMessages(c.Request.Context()) if err != nil { utils.LogError("err", err, "manual re-calc msgs sending failed") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } utils.LogInfo("manual re-calc messages sent successfully") @@ -75,7 +75,7 @@ func CheckCaches(c *gin.Context) { valid, err := database.CheckCachesValidRet() if err != nil { utils.LogError("error", err, "Could not check validity of caches") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } @@ -102,7 +102,7 @@ func RefreshPackagesHandler(c *gin.Context) { err := caches.RefreshPackagesCaches(nil) if err != nil { utils.LogError("error", err, "Could not refresh package caches") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } @@ -134,7 +134,7 @@ func RefreshPackagesAccountHandler(c *gin.Context) { err = caches.RefreshPackagesCaches(&accID) if err != nil { utils.LogError("error", err, "Could not refresh package caches") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } @@ -171,7 +171,7 @@ func RepackHandler(c *gin.Context) { err := repack.Repack(tableName, columns) if err != nil { utils.LogError("err", err, "manual repack call failed") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } @@ -193,7 +193,7 @@ func CleanAADHandler(c *gin.Context) { err := cleaning.CleanAdvisoryAccountData() if err != nil { utils.LogError("error", err, "Could not clean advisory account data") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } diff --git a/turnpike/controllers/database.go b/turnpike/controllers/database.go index fd3d82f7d..b62da70ce 100644 --- a/turnpike/controllers/database.go +++ b/turnpike/controllers/database.go @@ -31,7 +31,7 @@ func RepackRecreateHandler(c *gin.Context) { } for _, query := range runSequence { if err := middlewares.DBWriter(c).Exec(query).Error; err != nil { - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } } @@ -59,7 +59,7 @@ func GetActiveSessionsHandler(c *gin.Context) { err := q.Find(&data).Error if err != nil { utils.LogError("error", err, "DB query failed") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } @@ -86,7 +86,7 @@ func TerminateSessionHandler(c *gin.Context) { err := middlewares.DBWriter(c).Exec("select pg_terminate_backend(?)", param).Error if err != nil { utils.LogError("error", err, "DB query failed") - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } diff --git a/turnpike/controllers/pprof.go b/turnpike/controllers/pprof.go index 1f0058d05..c44d17124 100644 --- a/turnpike/controllers/pprof.go +++ b/turnpike/controllers/pprof.go @@ -74,7 +74,7 @@ func pprofHandler(c *gin.Context, serviceName string) { } data, err := getPprof(serviceName, param, query) if err != nil { - c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) + respondInternalError(c, err) return } c.Header("Content-Disposition", fmt.Sprintf("attachment; filename=%s", param)) diff --git a/turnpike/controllers/response.go b/turnpike/controllers/response.go new file mode 100644 index 000000000..68406d7c9 --- /dev/null +++ b/turnpike/controllers/response.go @@ -0,0 +1,11 @@ +package controllers + +import ( + "net/http" + + "github.com/gin-gonic/gin" +) + +func respondInternalError(c *gin.Context, err error) { + c.JSON(http.StatusInternalServerError, gin.H{"err": err.Error()}) +}