From 8f6da545578fc1872dd0e96dbef185f2ac73fe06 Mon Sep 17 00:00:00 2001 From: Pavan Date: Wed, 13 Nov 2024 21:28:57 +0100 Subject: [PATCH] [Misc] Operator: minor fixes Correct minor typos --- internal/controller/metrics.go | 2 +- internal/util/metrics-server.go | 110 ++++++++++++++++---------------- 2 files changed, 56 insertions(+), 56 deletions(-) diff --git a/internal/controller/metrics.go b/internal/controller/metrics.go index 6a08d3c..33f2266 100644 --- a/internal/controller/metrics.go +++ b/internal/controller/metrics.go @@ -122,7 +122,7 @@ var ( }, []string{"name"}) ) -// Create a varaible to hold all the collectors +// Create a variable to hold all the collectors var collectors = []prometheus.Collector{ReconcileErrors, Panics, TenantOperations, depth, adds, latency, workDuration, unfinished, longestRunningProcessor, retries} // #region capOperatorMetricsProvider diff --git a/internal/util/metrics-server.go b/internal/util/metrics-server.go index c17df73..1add4c6 100644 --- a/internal/util/metrics-server.go +++ b/internal/util/metrics-server.go @@ -1,55 +1,55 @@ -/* -SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and cap-operator contributors -SPDX-License-Identifier: Apache-2.0 -*/ - -package util - -import ( - "net/http" - "os" - - "github.com/prometheus/client_golang/prometheus" - "github.com/prometheus/client_golang/prometheus/promauto" - "github.com/prometheus/client_golang/prometheus/promhttp" - "k8s.io/klog/v2" -) - -// Initalizes the metrics server with default port 9090 and path /metrics based on default prometheus client -func InitMetricsServer() { - // Expose /metrics HTTP endpoint - go func() { - // Default port - metricsPort := "9090" - - // Get Port from env - portEnv := os.Getenv("METRICS_PORT") - if portEnv != "" { - metricsPort = portEnv - } - http.Handle("/metrics", promhttp.Handler()) - klog.Fatal(http.ListenAndServe(":"+metricsPort, nil)) - }() -} - -// Instruments the given HTTP handler with counter (total requests) and gauge (in flight requests) metrics -func InstrumentHttpHandler(handler func(http.ResponseWriter, *http.Request), metricNamePrefix string, helpTextSuffix string) http.HandlerFunc { - klog.InfoS("Instrumenting HTTP handler", "metricPrefix", metricNamePrefix, "helpSuffix", helpTextSuffix) - return promhttp.InstrumentHandlerCounter( - promauto.NewCounterVec( - prometheus.CounterOpts{ - Name: metricNamePrefix + "_total", - Help: "Total " + helpTextSuffix, - }, - []string{"code", "method"}, - ), - promhttp.InstrumentHandlerInFlight(promauto.NewGauge( - prometheus.GaugeOpts{ - Name: metricNamePrefix + "_in_flight", - Help: "Current " + helpTextSuffix, - }, - ), - http.HandlerFunc(handler), - ), - ) -} +/* +SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and cap-operator contributors +SPDX-License-Identifier: Apache-2.0 +*/ + +package util + +import ( + "net/http" + "os" + + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/promauto" + "github.com/prometheus/client_golang/prometheus/promhttp" + "k8s.io/klog/v2" +) + +// Initializes the metrics server with default port 9090 and path /metrics based on default prometheus client +func InitMetricsServer() { + // Expose /metrics HTTP endpoint + go func() { + // Default port + metricsPort := "9090" + + // Get Port from env + portEnv := os.Getenv("METRICS_PORT") + if portEnv != "" { + metricsPort = portEnv + } + http.Handle("/metrics", promhttp.Handler()) + klog.Fatal(http.ListenAndServe(":"+metricsPort, nil)) + }() +} + +// Instruments the given HTTP handler with counter (total requests) and gauge (in flight requests) metrics +func InstrumentHttpHandler(handler func(http.ResponseWriter, *http.Request), metricNamePrefix string, helpTextSuffix string) http.HandlerFunc { + klog.InfoS("Instrumenting HTTP handler", "metricPrefix", metricNamePrefix, "helpSuffix", helpTextSuffix) + return promhttp.InstrumentHandlerCounter( + promauto.NewCounterVec( + prometheus.CounterOpts{ + Name: metricNamePrefix + "_total", + Help: "Total " + helpTextSuffix, + }, + []string{"code", "method"}, + ), + promhttp.InstrumentHandlerInFlight(promauto.NewGauge( + prometheus.GaugeOpts{ + Name: metricNamePrefix + "_in_flight", + Help: "Current " + helpTextSuffix, + }, + ), + http.HandlerFunc(handler), + ), + ) +}