Merge pull request #6466 from liwang0513/lwang/karmada_search_json_logging

JSON logging support for Karmada Search component

Author: karmada-bot

artifacts/deploy/karmada-search.yaml

@@ -48,6 +48,7 @@ spec:
             - --audit-log-maxbackup=0
             - --tls-min-version=VersionTLS13
             - --bind-address=$(POD_IP)
+            - --logging-format=json
           livenessProbe:
             httpGet:
               path: /livez

cmd/karmada-search/app/karmada-search.go

@@ -34,6 +34,8 @@ import (
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/util/flowcontrol"
 	cliflag "k8s.io/component-base/cli/flag"
+	"k8s.io/component-base/logs"
+	logsv1 "k8s.io/component-base/logs/api/v1"
 	"k8s.io/component-base/term"
 	cbversion "k8s.io/component-base/version"
 	"k8s.io/klog/v2"
@@ -42,6 +44,7 @@ import (
 
 	"github.com/karmada-io/karmada/cmd/karmada-search/app/options"
 	searchscheme "github.com/karmada-io/karmada/pkg/apis/search/scheme"
+	"github.com/karmada-io/karmada/pkg/features"
 	karmadaclientset "github.com/karmada-io/karmada/pkg/generated/clientset/versioned"
 	informerfactory "github.com/karmada-io/karmada/pkg/generated/informers/externalversions"
 	generatedopenapi "github.com/karmada-io/karmada/pkg/generated/openapi"
@@ -62,7 +65,17 @@ type Option func(*runtime.Registry)
 
 // NewKarmadaSearchCommand creates a *cobra.Command object with default parameters
 func NewKarmadaSearchCommand(ctx context.Context, registryOptions ...Option) *cobra.Command {
+	logConfig := logsv1.NewLoggingConfiguration()
+	fss := cliflag.NamedFlagSets{}
+
+	logsFlagSet := fss.FlagSet("logs")
+	logs.AddFlags(logsFlagSet, logs.SkipLoggingConfigurationFlags())
+	logsv1.AddFlags(logConfig, logsFlagSet)
+	klogflag.Add(logsFlagSet)
+
+	genericFlagSet := fss.FlagSet("generic")
 	opts := options.NewOptions()
+	opts.AddFlags(genericFlagSet)
 
 	cmd := &cobra.Command{
 		Use: names.KarmadaSearchComponentName,
@@ -80,17 +93,15 @@ capabilities such as global search and resource proxy in a multi-cloud environme
 			}
 			return nil
 		},
+		PersistentPreRunE: func(_ *cobra.Command, _ []string) error {
+			if err := logsv1.ValidateAndApply(logConfig, features.FeatureGate); err != nil {
+				return err
+			}
+			logs.InitLogs()
+			return nil
+		},
 	}
 
-	fss := cliflag.NamedFlagSets{}
-
-	genericFlagSet := fss.FlagSet("generic")
-	opts.AddFlags(genericFlagSet)
-
-	// Set klog flags
-	logsFlagSet := fss.FlagSet("logs")
-	klogflag.Add(logsFlagSet)
-
 	cmd.AddCommand(sharedcommand.NewCmdVersion(names.KarmadaSearchComponentName))
 	cmd.Flags().AddFlagSet(genericFlagSet)
 	cmd.Flags().AddFlagSet(logsFlagSet)

cmd/karmada-search/main.go

@@ -20,6 +20,7 @@ import (
 	"os"
 
 	"k8s.io/component-base/cli"
+	"k8s.io/component-base/logs"
 	_ "k8s.io/component-base/logs/json/register" // for JSON log format registration
 	controllerruntime "sigs.k8s.io/controller-runtime"
 
@@ -29,6 +30,7 @@ import (
 func main() {
 	ctx := controllerruntime.SetupSignalHandler()
 	cmd := app.NewKarmadaSearchCommand(ctx)
-	code := cli.Run(cmd)
-	os.Exit(code)
+	exitCode := cli.Run(cmd)
+	logs.FlushLogs()
+	os.Exit(exitCode)
 }