Add envoy stat_prefix support for httpproxy

apis/projectcontour/v1alpha1/contourconfig.go

@@ -312,6 +312,10 @@ type EnvoyConfig struct {
 	// Network holds various configurable Envoy network values.
 	// +optional
 	Network *NetworkParameters `json:"network,omitempty"`
+
+	// Set StatPrefix on envoy routes
+	// +optional
+	EnableStatPrefix *bool `json:"enableStatPrefix"`
 }
 
 // DebugConfig contains Contour specific troubleshooting options.

changelogs/unreleased/5535-therealak12-small.md

@@ -0,0 +1 @@
+Adds `stat_prefix` support. if `envoy.enableStatPrefix` configuration is true, contour will automatically set `stat_prefix` on each route.

cmd/contour/serve.go

@@ -33,6 +33,7 @@
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/apimachinery/pkg/util/wait"
+
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/cache"
@@ -565,6 +566,7 @@
 			MaximumProtocolVersion: annotation.TLSVersion(contourConfiguration.Envoy.Cluster.UpstreamTLS.MaximumProtocolVersion, "1.3"),
 			CipherSuites:           contourConfiguration.Envoy.Cluster.UpstreamTLS.SanitizedCipherSuites(),
 		},
+		enableStatPrefix: *contourConfiguration.Envoy.EnableStatPrefix,
 	})
 
 	// Build the core Kubernetes event handler.
@@ -1123,6 +1125,7 @@
 	perConnectionBufferLimitBytes      *uint32
 	globalRateLimitService             *contour_api_v1alpha1.RateLimitServiceConfig
 	upstreamTLS                        *dag.UpstreamTLS
+	enableStatPrefix                   bool
 }
 
 func (s *Server) getDAGBuilder(dbc dagBuilderConfig) *dag.Builder {
@@ -1194,6 +1197,7 @@
 			PerConnectionBufferLimitBytes: dbc.perConnectionBufferLimitBytes,
 			SetSourceMetadataOnRoutes:     true,
 			UpstreamTLS:                   dbc.upstreamTLS,
+			EnableStatPrefix:              dbc.enableStatPrefix,
 		},
 		&dag.ExtensionServiceProcessor{
 			// Note that ExtensionService does not support ExternalName, if it does get added,
@@ -1218,6 +1222,7 @@
 			PerConnectionBufferLimitBytes: dbc.perConnectionBufferLimitBytes,
 			SetSourceMetadataOnRoutes:     true,
 			UpstreamTLS:                   dbc.upstreamTLS,
+			EnableStatPrefix:              dbc.enableStatPrefix,
 		},
 	}
 
@@ -1229,6 +1234,7 @@
 			MaxRequestsPerConnection:      dbc.maxRequestsPerConnection,
 			PerConnectionBufferLimitBytes: dbc.perConnectionBufferLimitBytes,
 			SetSourceMetadataOnRoutes:     true,
+			EnableStatPrefix:              dbc.enableStatPrefix,
 		})
 	}
 

cmd/contour/servecontext.go

@@ -520,6 +520,7 @@ func (ctx *serveContext) convertToContourConfigurationSpec() contour_api_v1alpha
 			Port:    ctx.healthPort,
 		},
 		Envoy: &contour_api_v1alpha1.EnvoyConfig{
+			EnableStatPrefix: &ctx.Config.EnvoyEnableStatPrefix,
 			Listener: &contour_api_v1alpha1.EnvoyListenerConfig{
 				UseProxyProto:                 &ctx.useProxyProto,
 				DisableAllowChunkedLength:     &ctx.Config.DisableAllowChunkedLength,

cmd/contour/servecontext_test.go

@@ -404,6 +404,7 @@ func TestConvertServeContext(t *testing.T) {
 					Name:      "envoy",
 					Namespace: "projectcontour",
 				},
+				EnableStatPrefix: ref.To(false),
 				Listener: &contour_api_v1alpha1.EnvoyListenerConfig{
 					UseProxyProto:              ref.To(false),
 					DisableAllowChunkedLength:  ref.To(false),

examples/contour/01-crds.yaml

@@ -165,6 +165,9 @@ spec:
                         version.
                       type: string
                     type: array
+                  enableStatPrefix:
+                    description: Set StatPrefix on envoy routes
+                    type: boolean
                   health:
                     description: "Health defines the endpoint Envoy uses to serve
                       health checks. \n Contour's default is { address: \"0.0.0.0\",
@@ -3778,6 +3781,9 @@ spec:
                             HTTP version.
                           type: string
                         type: array
+                      enableStatPrefix:
+                        description: Set StatPrefix on envoy routes
+                        type: boolean
                       health:
                         description: "Health defines the endpoint Envoy uses to serve
                           health checks. \n Contour's default is { address: \"0.0.0.0\",

examples/render/contour-deployment.yaml

@@ -384,6 +384,9 @@ spec:
                         version.
                       type: string
                     type: array
+                  enableStatPrefix:
+                    description: Set StatPrefix on envoy routes
+                    type: boolean
                   health:
                     description: "Health defines the endpoint Envoy uses to serve
                       health checks. \n Contour's default is { address: \"0.0.0.0\",
@@ -3997,6 +4000,9 @@ spec:
                             HTTP version.
                           type: string
                         type: array
+                      enableStatPrefix:
+                        description: Set StatPrefix on envoy routes
+                        type: boolean
                       health:
                         description: "Health defines the endpoint Envoy uses to serve
                           health checks. \n Contour's default is { address: \"0.0.0.0\",

examples/render/contour-gateway-provisioner.yaml

@@ -176,6 +176,9 @@ spec:
                         version.
                       type: string
                     type: array
+                  enableStatPrefix:
+                    description: Set StatPrefix on envoy routes
+                    type: boolean
                   health:
                     description: "Health defines the endpoint Envoy uses to serve
                       health checks. \n Contour's default is { address: \"0.0.0.0\",
@@ -3789,6 +3792,9 @@ spec:
                             HTTP version.
                           type: string
                         type: array
+                      enableStatPrefix:
+                        description: Set StatPrefix on envoy routes
+                        type: boolean
                       health:
                         description: "Health defines the endpoint Envoy uses to serve
                           health checks. \n Contour's default is { address: \"0.0.0.0\",

examples/render/contour-gateway.yaml

@@ -387,6 +387,9 @@ spec:
                         version.
                       type: string
                     type: array
+                  enableStatPrefix:
+                    description: Set StatPrefix on envoy routes
+                    type: boolean
                   health:
                     description: "Health defines the endpoint Envoy uses to serve
                       health checks. \n Contour's default is { address: \"0.0.0.0\",
@@ -4000,6 +4003,9 @@ spec:
                             HTTP version.
                           type: string
                         type: array
+                      enableStatPrefix:
+                        description: Set StatPrefix on envoy routes
+                        type: boolean
                       health:
                         description: "Health defines the endpoint Envoy uses to serve
                           health checks. \n Contour's default is { address: \"0.0.0.0\",

examples/render/contour.yaml

@@ -384,6 +384,9 @@ spec:
                         version.
                       type: string
                     type: array
+                  enableStatPrefix:
+                    description: Set StatPrefix on envoy routes
+                    type: boolean
                   health:
                     description: "Health defines the endpoint Envoy uses to serve
                       health checks. \n Contour's default is { address: \"0.0.0.0\",
@@ -3997,6 +4000,9 @@ spec:
                             HTTP version.
                           type: string
                         type: array
+                      enableStatPrefix:
+                        description: Set StatPrefix on envoy routes
+                        type: boolean
                       health:
                         description: "Health defines the endpoint Envoy uses to serve
                           health checks. \n Contour's default is { address: \"0.0.0.0\",

internal/contourconfig/contourconfiguration.go

@@ -18,6 +18,7 @@ import (
 	"time"
 
 	"dario.cat/mergo"
+
 	contour_api_v1alpha1 "github.com/projectcontour/contour/apis/projectcontour/v1alpha1"
 	"github.com/projectcontour/contour/internal/ref"
 	"github.com/projectcontour/contour/internal/timeout"
@@ -130,6 +131,7 @@ func Defaults() contour_api_v1alpha1.ContourConfigurationSpec {
 				XffNumTrustedHops: ref.To(uint32(0)),
 				EnvoyAdminPort:    ref.To(9001),
 			},
+			EnableStatPrefix: ref.To(false),
 		},
 		Gateway: nil,
 		HTTPProxy: &contour_api_v1alpha1.HTTPProxyConfig{

internal/contourconfig/contourconfiguration_test.go

@@ -17,13 +17,14 @@ import (
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
 	contour_api_v1 "github.com/projectcontour/contour/apis/projectcontour/v1"
 	contour_api_v1alpha1 "github.com/projectcontour/contour/apis/projectcontour/v1alpha1"
 	"github.com/projectcontour/contour/internal/contourconfig"
 	"github.com/projectcontour/contour/internal/ref"
 	"github.com/projectcontour/contour/internal/timeout"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 )
 
 func TestOverlayOnDefaults(t *testing.T) {
@@ -133,6 +134,7 @@ func TestOverlayOnDefaults(t *testing.T) {
 				XffNumTrustedHops: ref.To(uint32(77)),
 				EnvoyAdminPort:    ref.To(9997),
 			},
+			EnableStatPrefix: ref.To(false),
 		},
 		Gateway: &contour_api_v1alpha1.GatewayConfig{
 			ControllerName: "gatewaycontroller",

internal/dag/dag.go

@@ -24,10 +24,11 @@ import (
 	"strings"
 	"time"
 
-	"github.com/projectcontour/contour/internal/status"
-	"github.com/projectcontour/contour/internal/timeout"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
+
+	"github.com/projectcontour/contour/internal/status"
+	"github.com/projectcontour/contour/internal/timeout"
 )
 
 // Observer is an interface for receiving notification of DAG updates.
@@ -373,6 +374,9 @@ type Route struct {
 	Kind      string
 	Namespace string
 	Name      string
+
+	// The stat_prefix to set on envoy route
+	StatPrefix *string
 }
 
 // HasPathPrefix returns whether this route has a PrefixPathCondition.

internal/dag/gatewayapi_processor.go

@@ -74,6 +74,9 @@
 	// configurable and off by default in order to support the feature
 	// without requiring all existing test cases to change.
 	SetSourceMetadataOnRoutes bool
+
+	// Whether to set StatPrefix on envoy routes or not
+	EnableStatPrefix bool
 }
 
 // matchConditions holds match rules.
@@ -2175,6 +2178,10 @@
 			route.Name = name
 		}
 
+		if p.EnableStatPrefix {
+			route.StatPrefix = ref.To(fmt.Sprintf("%s_%s", namespace, name))
+		}
+
 		routes = append(routes, route)
 	}
 
@@ -2243,6 +2250,10 @@
 			route.Name = name
 		}
 
+		if p.EnableStatPrefix {
+			route.StatPrefix = ref.To(fmt.Sprintf("%s_%s", namespace, name))
+		}
+
 		routes = append(routes, route)
 	}
 

internal/dag/httpproxy_processor.go

@@ -25,14 +25,16 @@
 	"strings"
 	"time"
 
+	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/sets"
+
 	contour_api_v1 "github.com/projectcontour/contour/apis/projectcontour/v1"
 	contour_api_v1alpha1 "github.com/projectcontour/contour/apis/projectcontour/v1alpha1"
 	"github.com/projectcontour/contour/internal/annotation"
 	"github.com/projectcontour/contour/internal/k8s"
+	"github.com/projectcontour/contour/internal/ref"
 	"github.com/projectcontour/contour/internal/status"
 	"github.com/projectcontour/contour/internal/timeout"
-	"k8s.io/apimachinery/pkg/types"
-	"k8s.io/apimachinery/pkg/util/sets"
 )
 
 // defaultMaxRequestBytes specifies default value maxRequestBytes for AuthorizationServer
@@ -116,6 +118,9 @@
 	// UpstreamTLS defines the TLS settings like min/max version
 	// and cipher suites for upstream connections.
 	UpstreamTLS *UpstreamTLS
+
+	// Whether to set StatPrefix on envoy routes or not
+	EnableStatPrefix bool
 }
 
 // Run translates HTTPProxies into DAG objects and
@@ -638,6 +643,10 @@
 			route.Name = proxy.Name
 		}
 
+		if p.EnableStatPrefix {
+			route.StatPrefix = ref.To(fmt.Sprintf("%s_%s", proxy.Namespace, proxy.Name))
+		}
+
 		routes = append(routes, route)
 	}
 	return routes
@@ -843,6 +852,10 @@
 			r.Name = proxy.Name
 		}
 
+		if p.EnableStatPrefix {
+			r.StatPrefix = ref.To(fmt.Sprintf("%s_%s", proxy.Namespace, proxy.Name))
+		}
+
 		// If the enclosing root proxy enabled authorization,
 		// enable it on the route and propagate defaults
 		// downwards.

internal/dag/ingress_processor.go

@@ -14,18 +14,20 @@
 package dag
 
 import (
+	"fmt"
 	"strconv"
 	"strings"
 	"time"
 
 	"k8s.io/apimachinery/pkg/util/intstr"
 
-	"github.com/projectcontour/contour/internal/annotation"
-	"github.com/projectcontour/contour/internal/k8s"
-	"github.com/projectcontour/contour/internal/ref"
 	"github.com/sirupsen/logrus"
 	networking_v1 "k8s.io/api/networking/v1"
 	"k8s.io/apimachinery/pkg/types"
+
+	"github.com/projectcontour/contour/internal/annotation"
+	"github.com/projectcontour/contour/internal/k8s"
+	"github.com/projectcontour/contour/internal/ref"
 )
 
 // IngressProcessor translates Ingresses into DAG
@@ -69,6 +71,9 @@
 	// UpstreamTLS defines the TLS settings like min/max version
 	// and cipher suites for upstream connections.
 	UpstreamTLS *UpstreamTLS
+
+	// Whether to set StatPrefix on envoy routes or not
+	EnableStatPrefix bool
 }
 
 // Run translates Ingresses into DAG objects and
@@ -308,6 +313,10 @@
 		r.Name = ingress.Name
 	}
 
+	if p.EnableStatPrefix {
+		r.StatPrefix = ref.To(fmt.Sprintf("%s_%s", ingress.Namespace, ingress.Name))
+	}
+
 	switch pathType {
 	case networking_v1.PathTypePrefix:
 		prefixMatchType := PrefixMatchSegment