add doc for disabling log opts (#680)

Signed-off-by: Coleen Iona Quadros <coleen.quadros27@gmail.com>
grpc-ecosystem · Nov 20, 2023 · 9e92fd5 · 9e92fd5
1 parent 3ade00c
commit 9e92fd5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/interceptors/logging/options.go b/interceptors/logging/options.go
@@ -208,6 +208,14 @@ func WithTimestampFormat(format string) Option {
 }
 
 // WithDisableLoggingFields disables logging of gRPC fields provided.
+// The following are the default logging fields:
+//   - SystemTag[0]
+//   - ComponentFieldKey
+//   - ServiceFieldKey
+//   - MethodFieldKey
+//   - MethodTypeFieldKey
+//
+// Usage example - WithDisableLoggingFields(logging.MethodFieldKey, logging.MethodTypeFieldKey)
 func WithDisableLoggingFields(disableGrpcLogFields ...string) Option {
 	return func(o *options) {
 		o.disableGrpcLogFields = disableGrpcLogFields