add option to redact protobuf fields (#1284)

* add option to redact protobuf fields

* Create sharp-dolphins-help.md

* generated protobuf

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: paulwe

.changeset/sharp-dolphins-help.md

@@ -0,0 +1,5 @@
+---
+"@livekit/protocol": patch
+---
+
+add option to redact protobuf fields

livekit/logger/options.pb.go

@@ -22,6 +22,8 @@ import (
 	"go.uber.org/zap/zapcore"
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/reflect/protoreflect"
+
+	"github.com/livekit/protocol/livekit/logger"
 )
 
 func Proto(val proto.Message) zapcore.ObjectMarshaler {
@@ -46,6 +48,11 @@ func (p protoMarshaller) MarshalLogObject(e zapcore.ObjectEncoder) error {
 		k := f.JSONName()
 		v := p.m.Get(f)
 
+		if proto.HasExtension(f.Options(), logger.E_Redact) {
+			e.AddString(k, "<redacted>")
+			continue
+		}
+
 		if f.IsMap() {
 			if m := v.Map(); m.IsValid() {
 				e.AddObject(k, protoMapMarshaller{f, m})

logger/proto.go

@@ -68,6 +68,7 @@ func Proto() error {
 		"livekit_webhook.proto",
 		"livekit_metrics.proto",
 		"livekit_token_source.proto",
+		"logger/options.proto",
 	}
 	grpcProtoFiles := []string{
 		"infra/link.proto",

magefile.go

@@ -0,0 +1,10 @@
+syntax = "proto3";
+package logger;
+
+option go_package = "github.com/livekit/protocol/logger";
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FieldOptions {
+  bool redact = 50001;
+}