mirror of
https://github.com/openfaas/faas.git
synced 2025-06-08 16:26:47 +00:00
1d10e89aa2
The histogram for gateway_functions_seconds excluded the status code that gives important information for setting up SLOs. Fixes: #1725 Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alex@openfaas.com>
105 lines
3.1 KiB
Go
105 lines
3.1 KiB
Go
package handlers
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/openfaas/faas/gateway/metrics"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
// HTTPNotifier notify about HTTP request/response
|
|
type HTTPNotifier interface {
|
|
Notify(method string, URL string, originalURL string, statusCode int, event string, duration time.Duration)
|
|
}
|
|
|
|
// PrometheusServiceNotifier notifier for core service endpoints
|
|
type PrometheusServiceNotifier struct {
|
|
ServiceMetrics *metrics.ServiceMetricOptions
|
|
}
|
|
|
|
// Notify about service metrics
|
|
func (psn PrometheusServiceNotifier) Notify(method string, URL string, originalURL string, statusCode int, event string, duration time.Duration) {
|
|
code := fmt.Sprintf("%d", statusCode)
|
|
path := urlToLabel(URL)
|
|
|
|
psn.ServiceMetrics.Counter.WithLabelValues(method, path, code).Inc()
|
|
psn.ServiceMetrics.Histogram.WithLabelValues(method, path, code).Observe(duration.Seconds())
|
|
}
|
|
|
|
func urlToLabel(path string) string {
|
|
if len(path) > 0 {
|
|
path = strings.TrimRight(path, "/")
|
|
}
|
|
if path == "" {
|
|
path = "/"
|
|
}
|
|
return path
|
|
}
|
|
|
|
// PrometheusFunctionNotifier records metrics to Prometheus
|
|
type PrometheusFunctionNotifier struct {
|
|
Metrics *metrics.MetricOptions
|
|
//FunctionNamespace default namespace of the function
|
|
FunctionNamespace string
|
|
}
|
|
|
|
// Notify records metrics in Prometheus
|
|
func (p PrometheusFunctionNotifier) Notify(method string, URL string, originalURL string, statusCode int, event string, duration time.Duration) {
|
|
serviceName := getServiceName(originalURL)
|
|
if len(p.FunctionNamespace) > 0 {
|
|
if !strings.Contains(serviceName, ".") {
|
|
serviceName = fmt.Sprintf("%s.%s", serviceName, p.FunctionNamespace)
|
|
}
|
|
}
|
|
|
|
code := strconv.Itoa(statusCode)
|
|
labels := prometheus.Labels{"function_name": serviceName, "code": code}
|
|
|
|
if event == "completed" {
|
|
seconds := duration.Seconds()
|
|
p.Metrics.GatewayFunctionsHistogram.
|
|
With(labels).
|
|
Observe(seconds)
|
|
|
|
p.Metrics.GatewayFunctionInvocation.
|
|
With(labels).
|
|
Inc()
|
|
} else if event == "started" {
|
|
p.Metrics.GatewayFunctionInvocationStarted.WithLabelValues(serviceName).Inc()
|
|
}
|
|
|
|
}
|
|
|
|
func getServiceName(urlValue string) string {
|
|
var serviceName string
|
|
forward := "/function/"
|
|
if strings.HasPrefix(urlValue, forward) {
|
|
// With a path like `/function/xyz/rest/of/path?q=a`, the service
|
|
// name we wish to locate is just the `xyz` portion. With a positive
|
|
// match on the regex below, it will return a three-element slice.
|
|
// The item at index `0` is the same as `urlValue`, at `1`
|
|
// will be the service name we need, and at `2` the rest of the path.
|
|
matcher := functionMatcher.Copy()
|
|
matches := matcher.FindStringSubmatch(urlValue)
|
|
if len(matches) == hasPathCount {
|
|
serviceName = matches[nameIndex]
|
|
}
|
|
}
|
|
return strings.Trim(serviceName, "/")
|
|
}
|
|
|
|
// LoggingNotifier notifies a log about a request
|
|
type LoggingNotifier struct {
|
|
}
|
|
|
|
// Notify the LoggingNotifier about a request
|
|
func (LoggingNotifier) Notify(method string, URL string, originalURL string, statusCode int, event string, duration time.Duration) {
|
|
if event == "completed" {
|
|
log.Printf("Forwarded [%s] to %s - [%d] - %fs seconds", method, originalURL, statusCode, duration.Seconds())
|
|
}
|
|
}
|