feat: supports custom metrics sink export period and timeout

api/v1alpha1/envoygateway_metrics_types.go

@@ -5,6 +5,8 @@
 
 package v1alpha1
 
+import gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
+
 // EnvoyGatewayMetrics defines control plane push/pull metrics configurations.
 type EnvoyGatewayMetrics struct {
 	// Sinks defines the metric sinks where metrics are sent to.
@@ -38,6 +40,18 @@ type EnvoyGatewayOpenTelemetrySink struct {
 	// +kubebuilder:validation:Minimum=0
 	// +kubebuilder:default=4317
 	Port int32 `json:"port,omitempty"`
+	// ExportInterval configures the intervening time between exports for a
+	// Sink. This option overrides any value set for the
+	// OTEL_METRIC_EXPORT_INTERVAL environment variable.
+	// If ExportInterval is less than or equal to zero, 60 seconds
+	// is used as the default.
+	ExportInterval *gatewayv1.Duration `json:"exportInterval"`
+	// ExportTimeout configures the time a Sink waits for an export to
+	// complete before canceling it. This option overrides any value set for the
+	// OTEL_METRIC_EXPORT_TIMEOUT environment variable.
+	// If ExportTimeout is less than or equal to zero, 30 seconds
+	// is used as the default.
+	ExportTimeout *gatewayv1.Duration `json:"exportTimeout"`
 }
 
 // EnvoyGatewayPrometheusProvider will expose prometheus endpoint in pull mode.

internal/metrics/register.go

@@ -31,7 +31,11 @@
 
 // Init initializes and registers the global metrics server.
 func Init(cfg *config.Server) error {
-	options := newOptions(cfg)
+	options, err := newOptions(cfg)
+	if err != nil {
+		return err
+	}
+
 	handler, err := registerForHandler(options)
 	if err != nil {
 		return err
@@ -71,7 +75,7 @@
 	return nil
 }
 
-func newOptions(svr *config.Server) registerOptions {
+func newOptions(svr *config.Server) (registerOptions, error) {
 	newOpts := registerOptions{}
 	newOpts.address = net.JoinHostPort(v1alpha1.GatewayMetricsHost, fmt.Sprint(v1alpha1.GatewayMetricsPort))
 
@@ -84,14 +88,37 @@
 	}
 
 	for _, config := range svr.EnvoyGateway.GetEnvoyGatewayTelemetry().Metrics.Sinks {
-		newOpts.pushOptions.sinks = append(newOpts.pushOptions.sinks, metricsSink{
+		sink := metricsSink{
 			host:     config.OpenTelemetry.Host,
 			port:     config.OpenTelemetry.Port,
 			protocol: config.OpenTelemetry.Protocol,
-		})
+		}
+
+		// we do not explicitly set default values for ExporterInterval and ExporterTimeout
+		// instead, let the upstream repository set default values for it
+		if config.OpenTelemetry.ExportInterval != nil && len(*config.OpenTelemetry.ExportInterval) != 0 {
+			interval, err := time.ParseDuration(string(*config.OpenTelemetry.ExportInterval))
+			if err != nil {
+				metricsLogger.Error(err, "failed to parse exporter interval time format")
+				return newOpts, err
+			}
+
+			sink.exporterInterval = interval
+		}
+		if config.OpenTelemetry.ExportTimeout != nil && len(*config.OpenTelemetry.ExportTimeout) != 0 {
+			timeout, err := time.ParseDuration(string(*config.OpenTelemetry.ExportTimeout))
+			if err != nil {
+				metricsLogger.Error(err, "failed to parse exporter timeout time format")
+				return newOpts, err
+			}
+
+			sink.exporterTimeout = timeout
+		}
+
+		newOpts.pushOptions.sinks = append(newOpts.pushOptions.sinks, sink)
 	}
 
-	return newOpts
+	return newOpts, nil
 }
 
 // registerForHandler sets the global metrics registry to the provided Prometheus registerer.
@@ -155,7 +182,17 @@
 				return err
 			}
 
-			otelreader := metric.NewPeriodicReader(httpexporter)
+			periodOpts := []metric.PeriodicReaderOption{}
+			// If we do not set the interval or timeout for the exporter,
+			// we let the upstream set the default value for it.
+			if sink.exporterInterval != 0 {
+				periodOpts = append(periodOpts, metric.WithInterval(sink.exporterInterval))
+			}
+			if sink.exporterTimeout != 0 {
+				periodOpts = append(periodOpts, metric.WithTimeout(sink.exporterTimeout))
+			}
+
+			otelreader := metric.NewPeriodicReader(httpexporter, periodOpts...)
 			*otelOpts = append(*otelOpts, metric.WithReader(otelreader))
 			metricsLogger.Info("initialized otel http metrics push endpoint", "address", address)
 		}
@@ -178,7 +215,17 @@
 				return err
 			}
 
-			otelreader := metric.NewPeriodicReader(httpexporter)
+			periodOpts := []metric.PeriodicReaderOption{}
+			// If we do not set the interval or timeout for the exporter,
+			// we let the upstream set the default value for it.
+			if sink.exporterInterval != 0 {
+				periodOpts = append(periodOpts, metric.WithInterval(sink.exporterInterval))
+			}
+			if sink.exporterTimeout != 0 {
+				periodOpts = append(periodOpts, metric.WithTimeout(sink.exporterTimeout))
+			}
+
+			otelreader := metric.NewPeriodicReader(httpexporter, periodOpts...)
 			*otelOpts = append(*otelOpts, metric.WithReader(otelreader))
 			metricsLogger.Info("initialized otel grpc metrics push endpoint", "address", address)
 		}
@@ -200,7 +247,9 @@
 }
 
 type metricsSink struct {
-	protocol string
-	host     string
-	port     int32
+	protocol         string
+	host             string
+	port             int32
+	exporterTimeout  time.Duration
+	exporterInterval time.Duration
 }

site/content/en/latest/api/extension_types.md

@@ -1034,6 +1034,8 @@ _Appears in:_
 | `host` | _string_ |  true  | Host define the sink service hostname. |
 | `protocol` | _string_ |  true  | Protocol define the sink service protocol. |
 | `port` | _integer_ |  false  | Port defines the port the sink service is exposed on. |
+| `exportInterval` | _[Duration](#duration)_ |  true  | ExportInterval configures the intervening time between exports for a<br />Sink. This option overrides any value set for the<br />OTEL_METRIC_EXPORT_INTERVAL environment variable.<br />If ExportInterval is less than or equal to zero, 60 seconds<br />is used as the default. |
+| `exportTimeout` | _[Duration](#duration)_ |  true  | ExportTimeout configures the time a Sink waits for an export to<br />complete before canceling it. This option overrides any value set for the<br />OTEL_METRIC_EXPORT_TIMEOUT environment variable.<br />If ExportTimeout is less than or equal to zero, 30 seconds<br />is used as the default. |
 
 
 #### EnvoyGatewayPrometheusProvider