|
| 1 | +/* |
| 2 | +Copyright 2017 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +// Package metrics creates and registers metrics objects with Prometheus |
| 18 | +// and sets the Prometheus HTTP handler for /metrics |
| 19 | +package metrics |
| 20 | + |
| 21 | +import ( |
| 22 | + "net/http" |
| 23 | + "sync" |
| 24 | + |
| 25 | + "github.com/golang/glog" |
| 26 | + "github.com/prometheus/client_golang/prometheus" |
| 27 | + "github.com/prometheus/client_golang/prometheus/promhttp" |
| 28 | +) |
| 29 | + |
| 30 | +var registerMetrics sync.Once |
| 31 | + |
| 32 | +const ( |
| 33 | + catalogNamespace = "servicecatalog" // Prometheus namespace (nothing to do with k8s namespace) |
| 34 | +) |
| 35 | + |
| 36 | +var ( |
| 37 | + // Metrics are identified in Prometheus by concatinating Namespace, |
| 38 | + // Subsystem and Name while omitting any nulls and separating each key with |
| 39 | + // an underscore. Note that in this context, Namespace is the Prometheus |
| 40 | + // Namespace and there is no correlation with Kubernetes Namespace. |
| 41 | + |
| 42 | + // BrokerServiceClassCount exposes the number of Service Classes registered |
| 43 | + // per broker. |
| 44 | + BrokerServiceClassCount = prometheus.NewGaugeVec( |
| 45 | + prometheus.GaugeOpts{ |
| 46 | + Namespace: catalogNamespace, |
| 47 | + Name: "broker_service_class_count", |
| 48 | + Help: "Number of services classes by Broker.", |
| 49 | + }, |
| 50 | + []string{"broker"}, |
| 51 | + ) |
| 52 | + |
| 53 | + // BrokerServicePlanCount exposes the number of Service Plans registered |
| 54 | + // per broker. |
| 55 | + BrokerServicePlanCount = prometheus.NewGaugeVec( |
| 56 | + prometheus.GaugeOpts{ |
| 57 | + Namespace: catalogNamespace, |
| 58 | + Name: "broker_service_plan_count", |
| 59 | + Help: "Number of services classes by Broker.", |
| 60 | + }, |
| 61 | + []string{"broker"}, |
| 62 | + ) |
| 63 | +) |
| 64 | + |
| 65 | +func register() { |
| 66 | + registerMetrics.Do(func() { |
| 67 | + prometheus.MustRegister(BrokerServiceClassCount) |
| 68 | + prometheus.MustRegister(BrokerServicePlanCount) |
| 69 | + }) |
| 70 | +} |
| 71 | + |
| 72 | +// RegisterMetricsAndInstallHandler registers the Service Catalog metrics |
| 73 | +// objects with Prometheus and installs the Prometheus http handler at the |
| 74 | +// default context. |
| 75 | +func RegisterMetricsAndInstallHandler(m *http.ServeMux) { |
| 76 | + register() |
| 77 | + m.Handle("/metrics", promhttp.Handler()) |
| 78 | + glog.V(4).Info("Registered /metrics with promhttp") |
| 79 | +} |
0 commit comments