feat: Support logging of tenant ID (#580)

Similar to cloudquery/cloudquery#21675, this adds support for logging tenant id at the plugin level.

Author: hermanschaaf

internal/env/env.go

@@ -0,0 +1,7 @@
+package env
+
+import "os"
+
+func TenantID() string {
+	return os.Getenv("_CQ_TENANT_ID")
+}

managedplugin/logging.go

@@ -2,10 +2,15 @@ package managedplugin
 
 import "github.com/rs/zerolog"
 
-func (c *Client) jsonToLog(l zerolog.Logger, msg map[string]any) {
+func (c *Client) jsonToLog(l zerolog.Logger, msg map[string]any, protectedFields []string) {
 	level := msg["level"]
 	// The log level is part of the log message received from the plugin, so we need to remove it before logging
 	delete(msg, "level")
+
+	// Remove protected fields from log message to avoid duplication
+	for _, field := range protectedFields {
+		delete(msg, field)
+	}
 	switch level {
 	case "trace":
 		l.Trace().Fields(msg).Msg("")

managedplugin/plugin.go

@@ -17,6 +17,7 @@ import (
 	"time"
 
 	"github.com/avast/retry-go/v4"
+	"github.com/cloudquery/plugin-pb-go/internal/env"
 	pbBase "github.com/cloudquery/plugin-pb-go/pb/base/v0"
 	pbDiscovery "github.com/cloudquery/plugin-pb-go/pb/discovery/v0"
 	pbDiscoveryV1 "github.com/cloudquery/plugin-pb-go/pb/discovery/v1"
@@ -557,6 +558,12 @@ func (c *Client) readLogLines(reader io.ReadCloser) {
 	lr := NewLogReader(reader)
 	// reset the context to avoid duplicate fields in the logs when streaming logs from plugins
 	pluginsLogger := c.logger.With().Reset().Timestamp().Logger()
+	protectedFields := make([]string, 0)
+	tenantID := env.TenantID()
+	if tenantID != "" {
+		pluginsLogger = pluginsLogger.With().Str("tenant_id", tenantID).Logger()
+		protectedFields = append(protectedFields, "tenant_id")
+	}
 	for {
 		line, err := lr.NextLine()
 		if errors.Is(err, io.EOF) {
@@ -574,7 +581,7 @@ func (c *Client) readLogLines(reader io.ReadCloser) {
 		if err := json.Unmarshal(line, &structuredLogLine); err != nil {
 			c.logger.Info().Str("level", "unknown").Msg(string(line))
 		} else {
-			c.jsonToLog(pluginsLogger, structuredLogLine)
+			c.jsonToLog(pluginsLogger, structuredLogLine, protectedFields)
 		}
 	}
 }