feat: implement grpc-observability logging via binarylog

observability/config.go

@@ -0,0 +1,97 @@
+/*
+ *
+ * Copyright 2022 gRPC 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 observability
+
+import (
+	"context"
+	"encoding/json"
+	"os"
+
+	coptlogging "cloud.google.com/go/logging"
+	"golang.org/x/oauth2/google"
+	configpb "google.golang.org/grpc/observability/internal/config"
+	"google.golang.org/protobuf/encoding/protojson"
+)
+
+const (
+	envKeyObservabilityConfig = "GRPC_OBSERVABILITY_CONFIG"
+)
+
+// gcpDefaultCredentials is the JSON loading struct used to get project id.
+type gcpDefaultCredentials struct {
+	QuotaProjectID string `json:"quota_project_id"`
+}
+
+// fetchDefaultProjectID fetches the default GCP project id from environment.
+func fetchDefaultProjectID(ctx context.Context) string {
+	// Step 1: Check ENV var
+	if s := os.Getenv("GCLOUD_PROJECT_ID"); s != "" {
+		return s
+	}
+	// Step 2: Check default credential
+	if credentials, err := google.FindDefaultCredentials(ctx, coptlogging.WriteScope); err == nil {
+		logger.Infof("found Google Default Credential")
+		// Step 2.1: Check if the ProjectID is in the plain view
+		if credentials.ProjectID != "" {
+			return credentials.ProjectID
+		} else if len(credentials.JSON) > 0 {
+			// Step 2.2: Check if the JSON form of the credentials has it
+			var d gcpDefaultCredentials
+			if err := json.Unmarshal(credentials.JSON, &d); err != nil {
+				logger.Infof("failed to parse default credentials JSON")
+			} else if d.QuotaProjectID != "" {
+				return d.QuotaProjectID
+			}
+		}
+	} else {
+		logger.Info("failed to locate Google Default Credential: %v", err)
+	}
+	// No default project ID found
+	return ""
+}
+
+// parseObservabilityConfig parses and processes the config for observability,
+// currently, we only support loading config from static ENV var. But we might
+// support dynamic configuration with control plane in future.
+func parseObservabilityConfig(ctx context.Context) *configpb.ObservabilityConfig {
+	// Parse the config from ENV var
+	var config configpb.ObservabilityConfig
+	content := os.Getenv(envKeyObservabilityConfig)
+	if content != "" {
+		if err := protojson.Unmarshal([]byte(content), &config); err != nil {
+			logger.Warningf("failed to load observability config from env GRPC_OBSERVABILITY_CONFIG: %s", err)
+		}
+	}
+	// Fill in GCP project id if not present
+	if config.ExporterConfig == nil {
+		config.ExporterConfig = &configpb.ObservabilityConfig_ExporterConfig{
+			ProjectId: fetchDefaultProjectID(ctx),
+		}
+	} else {
+		// If any default exporter is required, fill the default project id
+		if !config.ExporterConfig.DisableDefaultLoggingExporter || !config.ExporterConfig.DisableDefaultTracingExporter || !config.ExporterConfig.DisableDefaultMetricsExporter {
+			if config.ExporterConfig.ProjectId == "" {
+				config.ExporterConfig.ProjectId = fetchDefaultProjectID(ctx)
+			}
+		}
+	}
+	configJSON, _ := protojson.Marshal(&config)
+	logger.Infof("Using ObservabilityConfig: %v", string(configJSON))
+	return &config
+}

observability/exporting.go

@@ -0,0 +1,147 @@
+/*
+ *
+ * Copyright 2022 gRPC 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 observability
+
+import (
+	"context"
+	"encoding/json"
+
+	coptlogging "cloud.google.com/go/logging"
+	grpclogrecordpb "google.golang.org/grpc/observability/internal/logging"
+	"google.golang.org/protobuf/encoding/protojson"
+)
+
+// genericLoggingExporter is the interface of logging exporter for gRPC
+// Observability. Ideally, we should use what OTEL provides, but their Golang
+// implementation is in "frozen" state. So, this plugin provides a minimum
+// interface to satisfy testing purposes.
+type genericLoggingExporter interface {
+	// EmitGrpcLogRecord writes a gRPC LogRecord to cache without blocking.
+	EmitGrpcLogRecord(*grpclogrecordpb.GrpcLogRecord)
+	// Close flushes all pending data and closes the exporter.
+	Close() error
+}
+
+var (
+	// loggingExporter is the global logging exporter, may be nil.
+	loggingExporter genericLoggingExporter
+)
+
+// cloudLoggingExporter is the exporter for CloudLogging.
+type cloudLoggingExporter struct {
+	client *coptlogging.Client
+	logger *coptlogging.Logger
+}
+
+func newCloudLoggingExporter(ctx context.Context, projectID string) *cloudLoggingExporter {
+	c, err := coptlogging.NewClient(ctx, projectID)
+	if err != nil {
+		logger.Errorf("failed to create cloudLoggingExporter: %v", err)
+		return nil
+	}
+	logger.Infof("successfully created cloudLoggingExporter")
+	return &cloudLoggingExporter{
+		client: c,
+		logger: c.Logger("observability"),
+	}
+}
+
+// mapLogLevelToSeverity maps the gRPC defined log level to Cloud Logging's
+// Severity. The canonical definition can be found at
+// https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#LogSeverity.
+func mapLogLevelToSeverity(l grpclogrecordpb.GrpcLogRecord_LogLevel) coptlogging.Severity {
+	switch l {
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_UNKNOWN:
+		return 0
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_TRACE:
+		// Cloud Logging doesn't have a trace level, treated as DEBUG.
+		return 100
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_DEBUG:
+		return 100
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_INFO:
+		return 200
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_WARN:
+		return 400
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_ERROR:
+		return 500
+	case grpclogrecordpb.GrpcLogRecord_LOG_LEVEL_CRITICAL:
+		return 600
+	default:
+		logger.Errorf("unknown LogLevel: %v", l)
+		return -1
+	}
+}
+
+func (cle *cloudLoggingExporter) EmitGrpcLogRecord(l *grpclogrecordpb.GrpcLogRecord) {
+	body, err := protojson.Marshal(l)
+	if err != nil {
+		logger.Errorf("failed to marshal GrpcLogRecord: %v", l)
+		return
+	}
+	entry := coptlogging.Entry{
+		Timestamp: l.Timestamp.AsTime(),
+		Severity:  mapLogLevelToSeverity(l.LogLevel),
+		Payload:   string(body),
+	}
+	cle.logger.Log(entry)
+	if logger.V(2) {
+		eventJSON, _ := json.Marshal(&entry)
+		logger.Infof("Uploading event to CloudLogging: %s", eventJSON)
+	}
+}
+
+func (cle *cloudLoggingExporter) Close() error {
+	if cle.logger != nil {
+		if err := cle.logger.Flush(); err != nil {
+			return err
+		}
+	}
+	if cle.client != nil {
+		if err := cle.client.Close(); err != nil {
+			return err
+		}
+	}
+	logger.Infof("closed CloudLogging exporter")
+	return nil
+}
+
+func createDefaultLoggingExporter(ctx context.Context, projectID string) {
+	loggingExporter = newCloudLoggingExporter(ctx, projectID)
+}
+
+func closeLoggingExporter() {
+	if loggingExporter != nil {
+		if err := loggingExporter.Close(); err != nil {
+			logger.Infof("failed to close logging exporter: %v", err)
+		}
+	}
+}
+
+// registerLoggingExporter allows custom logging exporter, currently only
+// available to testing inside this package.
+func registerLoggingExporter(e genericLoggingExporter) {
+	loggingExporter = e
+}
+
+// emit is the wrapper for producing a log entry, hiding all the abstraction details.
+func emit(l *grpclogrecordpb.GrpcLogRecord) {
+	if loggingExporter != nil {
+		loggingExporter.EmitGrpcLogRecord(l)
+	}
+}

observability/go.mod

@@ -0,0 +1,14 @@
+module google.golang.org/grpc/observability
+
+go 1.14
+
+require (
+	cloud.google.com/go/logging v1.4.2
+	github.com/golang/protobuf v1.5.2
+	github.com/google/go-cmp v0.5.6 // indirect
+	golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8
+	google.golang.org/grpc v1.43.0
+	google.golang.org/protobuf v1.27.1
+)
+
+replace google.golang.org/grpc => ../