knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/logging/object_encoders.go (about)

     1  /*
     2  Copyright 2020 The Knative Authors
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package logging
    18  
    19  import (
    20  	"strings"
    21  
    22  	"go.uber.org/zap/zapcore"
    23  
    24  	"k8s.io/apimachinery/pkg/util/sets"
    25  )
    26  
    27  // This file contains the specific object encoders for use in Knative
    28  // to optimize logging experience and performance.
    29  
    30  // StringSet returns a marshaler for the set of strings.
    31  // To use this in sugared logger do:
    32  //
    33  //	logger.Infow("Revision State", zap.Object("healthy", logging.StringSet(healthySet)),
    34  //		zap.Object("unhealthy", logging.StringSet(unhealthySet)))
    35  //
    36  // To use with non-sugared logger do:
    37  //
    38  //	logger.Info("Revision State", zap.Object("healthy", logging.StringSet(healthySet)),
    39  //		zap.Object("unhealthy", logging.StringSet(unhealthySet)))
    40  func StringSet(s sets.Set[string]) zapcore.ObjectMarshalerFunc {
    41  	return func(enc zapcore.ObjectEncoder) error {
    42  		enc.AddString("keys", strings.Join(s.UnsortedList(), ","))
    43  		return nil
    44  	}
    45  }