Merge pull request #1056 from skmatti/be-logs-impl-1.9

Cherrypick #1041[Add support for Access Logs in BackendConfig] into release-1.9

pkg/apis/backendconfig/v1/types.go

@@ -44,7 +44,7 @@ type BackendConfigSpec struct {
 	SessionAffinity      *SessionAffinityConfig      `json:"sessionAffinity,omitempty"`
 	CustomRequestHeaders *CustomRequestHeadersConfig `json:"customRequestHeaders,omitempty"`
 	HealthCheck          *HealthCheckConfig          `json:"healthCheck,omitempty"`
-	// Log specifies logging specification for Backend Services.
+	// Logging specifies the configuration for access logs.
 	Logging *LogConfig `json:"log,omitempty"`
 }
 

pkg/backendconfig/validation.go

@@ -48,6 +48,10 @@ func Validate(kubeClient kubernetes.Interface, beConfig *backendconfigv1.Backend
 		return err
 	}
 
+	if err := validateLogging(beConfig); err != nil {
+		return err
+	}
+
 	return nil
 }
 
@@ -104,3 +108,16 @@ func validateSessionAffinity(kubeClient kubernetes.Interface, beConfig *backendc
 
 	return nil
 }
+
+func validateLogging(beConfig *backendconfigv1.BackendConfig) error {
+	if beConfig.Spec.Logging == nil || beConfig.Spec.Logging.SampleRate == nil {
+		return nil
+	}
+
+	if *beConfig.Spec.Logging.SampleRate < 0.0 || *beConfig.Spec.Logging.SampleRate > 1.0 {
+		return fmt.Errorf("unsupported SampleRate: %f, should be between 0.0 and 1.0",
+			*beConfig.Spec.Logging.SampleRate)
+	}
+
+	return nil
+}

pkg/backendconfig/validation_test.go

@@ -24,6 +24,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/kubernetes/fake"
 	backendconfigv1 "k8s.io/ingress-gce/pkg/apis/backendconfig/v1"
+	testutils "k8s.io/ingress-gce/pkg/test"
 )
 
 var (
@@ -239,3 +240,90 @@ func TestValidateSessionAffinity(t *testing.T) {
 		}
 	}
 }
+
+func TestValidateLogging(t *testing.T) {
+	for _, tc := range []struct {
+		desc        string
+		beConfig    *backendconfigv1.BackendConfig
+		expectError bool
+	}{
+		{
+			desc: "nil access log config",
+			beConfig: &backendconfigv1.BackendConfig{
+				ObjectMeta: meta_v1.ObjectMeta{
+					Namespace: "default",
+				},
+				Spec: backendconfigv1.BackendConfigSpec{},
+			},
+			expectError: false,
+		},
+		{
+			desc: "empty access log config",
+			beConfig: &backendconfigv1.BackendConfig{
+				ObjectMeta: meta_v1.ObjectMeta{
+					Namespace: "default",
+				},
+				Spec: backendconfigv1.BackendConfigSpec{
+					Logging: &backendconfigv1.LogConfig{},
+				},
+			},
+			expectError: false,
+		},
+		{
+			desc: "invalid sample rate",
+			beConfig: &backendconfigv1.BackendConfig{
+				ObjectMeta: meta_v1.ObjectMeta{
+					Namespace: "default",
+				},
+				Spec: backendconfigv1.BackendConfigSpec{
+					Logging: &backendconfigv1.LogConfig{
+						Enable:     false,
+						SampleRate: testutils.Float64ToPtr(1.01),
+					},
+				},
+			},
+			expectError: true,
+		},
+		{
+			desc: "valid sample rate",
+			beConfig: &backendconfigv1.BackendConfig{
+				ObjectMeta: meta_v1.ObjectMeta{
+					Namespace: "default",
+				},
+				Spec: backendconfigv1.BackendConfigSpec{
+					Logging: &backendconfigv1.LogConfig{
+						Enable:     true,
+						SampleRate: testutils.Float64ToPtr(0.5),
+					},
+				},
+			},
+			expectError: false,
+		},
+		{
+			desc: "valid integer sample rate",
+			beConfig: &backendconfigv1.BackendConfig{
+				ObjectMeta: meta_v1.ObjectMeta{
+					Namespace: "default",
+				},
+				Spec: backendconfigv1.BackendConfigSpec{
+					Logging: &backendconfigv1.LogConfig{
+						Enable:     true,
+						SampleRate: testutils.Float64ToPtr(1),
+					},
+				},
+			},
+			expectError: false,
+		},
+	} {
+		t.Run(tc.desc, func(t *testing.T) {
+			kubeClient := fake.NewSimpleClientset()
+			err := Validate(kubeClient, tc.beConfig)
+			if tc.expectError && err == nil {
+				t.Errorf("Expected error but got nil")
+			}
+			if !tc.expectError && err != nil {
+				t.Errorf("Did not expect error but got: %v", err)
+			}
+		})
+	}
+}

pkg/backends/backends.go

@@ -80,6 +80,10 @@ func (b *Backends) Create(sp utils.ServicePort, hcLink string) (*composite.Backe
 		Port:         namedPort.Port,
 		PortName:     namedPort.Name,
 		HealthChecks: []string{hcLink},
+		// LogConfig is using GA API so this is not considered for computing API version.
+		LogConfig: &composite.BackendServiceLogConfig{
+			Enable: true,
+		},
 	}
 
 	if sp.L7ILBEnabled {

pkg/backends/features/logging.go

@@ -0,0 +1,63 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package features
+
+import (
+	"fmt"
+
+	"k8s.io/ingress-gce/pkg/composite"
+	"k8s.io/ingress-gce/pkg/utils"
+	"k8s.io/klog"
+)
+
+// EnsureLogging reads the log configurations specified in the ServicePort.BackendConfig
+// and applies it to the BackendService. It returns true if there were existing settings
+// on the BackendService that were overwritten.
+func EnsureLogging(sp utils.ServicePort, be *composite.BackendService) bool {
+	if sp.BackendConfig.Spec.Logging == nil {
+		return false
+	}
+	svcKey := fmt.Sprintf("%s/%s", sp.ID.Service.Namespace, sp.ID.Service.Name)
+	expectedLogConfig := expectedBackendServiceLogConfig(sp)
+	if !expectedLogConfig.Enable && !be.LogConfig.Enable {
+		klog.V(3).Infof("Logging continues to stay disabled for service %s, skipping update", svcKey)
+		return false
+	}
+	if be.LogConfig == nil || expectedLogConfig.Enable != be.LogConfig.Enable ||
+		expectedLogConfig.SampleRate != be.LogConfig.SampleRate {
+		be.LogConfig = expectedLogConfig
+		klog.V(2).Infof("Updated Logging settings for service %s", svcKey)
+		return true
+	}
+	return false
+}
+
+// expectedBackendServiceLogConfig returns composite.BackendServiceLogConfig for
+// the access log settings specified in the BackendConfig to the passed in
+// service port.
+// This method assumes that sp.BackendConfig.Spec.Logging is not nil.
+func expectedBackendServiceLogConfig(sp utils.ServicePort) *composite.BackendServiceLogConfig {
+	logConfig := &composite.BackendServiceLogConfig{
+		Enable: sp.BackendConfig.Spec.Logging.Enable,
+	}
+	// Ignore sample rate if logging is not enabled.
+	if !sp.BackendConfig.Spec.Logging.Enable || sp.BackendConfig.Spec.Logging.SampleRate == nil {
+		return logConfig
+	}
+	logConfig.SampleRate = *sp.BackendConfig.Spec.Logging.SampleRate
+	return logConfig
+}