mirror of
https://github.com/openfaas/faas.git
synced 2025-06-09 08:46:48 +00:00
96812d2cd8
* This experimental patch records metrics as invocations start so that the metrics can be used to make better scale to zero decisions in faas-idler. Tested with Kubernetes on a single-node cluster, metrics reported as expected. Existing metrics still report. Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
110 lines
3.0 KiB
Go
110 lines
3.0 KiB
Go
// Copyright (c) Alex Ellis 2017. All rights reserved.
|
|
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
|
|
package metrics
|
|
|
|
import (
|
|
"net/http"
|
|
"sync"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
|
)
|
|
|
|
// MetricOptions to be used by web handlers
|
|
type MetricOptions struct {
|
|
GatewayFunctionInvocation *prometheus.CounterVec
|
|
GatewayFunctionsHistogram *prometheus.HistogramVec
|
|
ServiceReplicasGauge *prometheus.GaugeVec
|
|
ServiceMetrics *ServiceMetricOptions
|
|
StartedCounter *prometheus.CounterVec
|
|
}
|
|
|
|
// ServiceMetricOptions provides RED metrics
|
|
type ServiceMetricOptions struct {
|
|
Histogram *prometheus.HistogramVec
|
|
Counter *prometheus.CounterVec
|
|
}
|
|
|
|
// Synchronize to make sure MustRegister only called once
|
|
var once = sync.Once{}
|
|
|
|
// RegisterExporter registers with Prometheus for tracking
|
|
func RegisterExporter(exporter *Exporter) {
|
|
once.Do(func() {
|
|
prometheus.MustRegister(exporter)
|
|
})
|
|
}
|
|
|
|
// PrometheusHandler Bootstraps prometheus for metrics collection
|
|
func PrometheusHandler() http.Handler {
|
|
return promhttp.Handler()
|
|
}
|
|
|
|
// BuildMetricsOptions builds metrics for tracking functions in the API gateway
|
|
func BuildMetricsOptions() MetricOptions {
|
|
gatewayFunctionsHistogram := prometheus.NewHistogramVec(prometheus.HistogramOpts{
|
|
Name: "gateway_functions_seconds",
|
|
Help: "Function time taken",
|
|
}, []string{"function_name"})
|
|
|
|
gatewayFunctionInvocation := prometheus.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gateway_function_invocation_total",
|
|
Help: "Individual function metrics",
|
|
},
|
|
[]string{"function_name", "code"},
|
|
)
|
|
|
|
serviceReplicas := prometheus.NewGaugeVec(
|
|
prometheus.GaugeOpts{
|
|
Name: "gateway_service_count",
|
|
Help: "Docker service replicas",
|
|
},
|
|
[]string{"function_name"},
|
|
)
|
|
|
|
// For automatic monitoring and alerting (RED method)
|
|
histogram := prometheus.NewHistogramVec(prometheus.HistogramOpts{
|
|
Subsystem: "http",
|
|
Name: "request_duration_seconds",
|
|
Help: "Seconds spent serving HTTP requests.",
|
|
Buckets: prometheus.DefBuckets,
|
|
}, []string{"method", "path", "status"})
|
|
|
|
// Can be used Kubernetes HPA v2
|
|
counter := prometheus.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Subsystem: "http",
|
|
Name: "requests_total",
|
|
Help: "The total number of HTTP requests.",
|
|
},
|
|
[]string{"method", "path", "status"},
|
|
)
|
|
|
|
startedCounter := prometheus.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Namespace: "gateway",
|
|
Subsystem: "function",
|
|
Name: "invocation_started",
|
|
Help: "The total number of function HTTP requests started.",
|
|
},
|
|
[]string{"function_name"},
|
|
)
|
|
|
|
serviceMetricOptions := &ServiceMetricOptions{
|
|
Counter: counter,
|
|
Histogram: histogram,
|
|
}
|
|
|
|
metricsOptions := MetricOptions{
|
|
GatewayFunctionsHistogram: gatewayFunctionsHistogram,
|
|
GatewayFunctionInvocation: gatewayFunctionInvocation,
|
|
ServiceReplicasGauge: serviceReplicas,
|
|
ServiceMetrics: serviceMetricOptions,
|
|
StartedCounter: startedCounter,
|
|
}
|
|
|
|
return metricsOptions
|
|
}
|