From d57f76fbefd6d3dbfd6e1e5965c01fc503613198 Mon Sep 17 00:00:00 2001 From: David Zhao Date: Mon, 7 Mar 2022 21:02:08 -0800 Subject: [PATCH] Use trackID consistently as log key (#491) * Use trackID consistently as log key * more useful logging for track published --- pkg/rtc/participant.go | 18 +++++++++--------- pkg/rtc/room.go | 4 ++-- pkg/rtc/signalhandler.go | 2 +- pkg/rtc/uptrackmanager.go | 2 +- pkg/service/roommanager.go | 2 +- test/client/client.go | 6 +++--- test/client/trackwriter.go | 2 +- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/pkg/rtc/participant.go b/pkg/rtc/participant.go index b162d7601..c0b6032e9 100644 --- a/pkg/rtc/participant.go +++ b/pkg/rtc/participant.go @@ -857,7 +857,7 @@ func (p *ParticipantImpl) AddSubscribedTrack(subTrack types.SubscribedTrack) { p.params.Logger.Debugw("added subscribedTrack", "publisherID", subTrack.PublisherID(), "publisherIdentity", subTrack.PublisherIdentity(), - "track", subTrack.ID()) + "trackID", subTrack.ID()) p.lock.Lock() p.subscribedTracks[subTrack.ID()] = subTrack settings := p.subscribedTracksSettings[subTrack.ID()] @@ -879,7 +879,7 @@ func (p *ParticipantImpl) RemoveSubscribedTrack(subTrack types.SubscribedTrack) p.params.Logger.Debugw("removed subscribedTrack", "publisherID", subTrack.PublisherID(), "publisherIdentity", subTrack.PublisherIdentity(), - "track", subTrack.ID(), "kind", subTrack.DownTrack().Kind()) + "trackID", subTrack.ID(), "kind", subTrack.DownTrack().Kind()) p.subscriber.RemoveTrack(subTrack) @@ -1063,18 +1063,18 @@ func (p *ParticipantImpl) onMediaTrack(track *webrtc.TrackRemote, rtpReceiver *w return } - p.params.Logger.Debugw("mediaTrack added", - "kind", track.Kind().String(), - "track", track.ID(), - "rid", track.RID(), - "SSRC", track.SSRC()) - if !p.CanPublish() { p.params.Logger.Warnw("no permission to publish mediaTrack", nil) return } publishedTrack, isNewTrack := p.mediaTrackReceived(track, rtpReceiver) + + p.params.Logger.Infow("mediaTrack published", + "kind", track.Kind().String(), + "trackID", publishedTrack.ID(), + "rid", track.RID(), + "SSRC", track.SSRC()) if !isNewTrack && publishedTrack != nil && p.IsReady() && p.onTrackUpdated != nil { p.onTrackUpdated(p, publishedTrack) } @@ -1378,7 +1378,7 @@ func (p *ParticipantImpl) setTrackMuted(trackID livekit.TrackID, muted bool) { p.pendingTracksLock.RUnlock() if !isPending { - p.params.Logger.Warnw("could not locate track", nil, "track", trackID) + p.params.Logger.Warnw("could not locate track", nil, "trackID", trackID) } } diff --git a/pkg/rtc/room.go b/pkg/rtc/room.go index ba77a1231..b14a089af 100644 --- a/pkg/rtc/room.go +++ b/pkg/rtc/room.go @@ -612,12 +612,12 @@ func (r *Room) onTrackPublished(participant types.LocalParticipant, track types. r.Logger.Debugw("subscribing to new track", "participants", []livekit.ParticipantIdentity{participant.Identity(), existingParticipant.Identity()}, "pIDs", []livekit.ParticipantID{participant.ID(), existingParticipant.ID()}, - "track", track.ID()) + "trackID", track.ID()) if _, err := participant.AddSubscriber(existingParticipant, types.AddSubscriberParams{TrackIDs: []livekit.TrackID{track.ID()}}); err != nil { r.Logger.Errorw("could not subscribe to remoteTrack", err, "participants", []livekit.ParticipantIdentity{participant.Identity(), existingParticipant.Identity()}, "pIDs", []livekit.ParticipantID{participant.ID(), existingParticipant.ID()}, - "track", track.ID()) + "trackID", track.ID()) } } diff --git a/pkg/rtc/signalhandler.go b/pkg/rtc/signalhandler.go index 64d95bf32..7b0cfa17d 100644 --- a/pkg/rtc/signalhandler.go +++ b/pkg/rtc/signalhandler.go @@ -16,7 +16,7 @@ func HandleParticipantSignal(room types.Room, participant types.LocalParticipant return err } case *livekit.SignalRequest_AddTrack: - pLogger.Debugw("add track request", "track", msg.AddTrack.Cid) + pLogger.Debugw("add track request", "trackID", msg.AddTrack.Cid) participant.AddTrack(msg.AddTrack) case *livekit.SignalRequest_Answer: sd := FromProtoSessionDescription(msg.Answer) diff --git a/pkg/rtc/uptrackmanager.go b/pkg/rtc/uptrackmanager.go index 0c735699d..bd24b459a 100644 --- a/pkg/rtc/uptrackmanager.go +++ b/pkg/rtc/uptrackmanager.go @@ -149,7 +149,7 @@ func (u *UpTrackManager) SetPublishedTrackMuted(trackID livekit.TrackID, muted b track.SetMuted(muted) if currentMuted != track.IsMuted() { - u.params.Logger.Debugw("mute status changed", "track", trackID, "muted", track.IsMuted()) + u.params.Logger.Debugw("mute status changed", "trackID", trackID, "muted", track.IsMuted()) if u.onTrackUpdated != nil { u.onTrackUpdated(track, false) } diff --git a/pkg/service/roommanager.go b/pkg/service/roommanager.go index a102578dc..170fc35fc 100644 --- a/pkg/service/roommanager.go +++ b/pkg/service/roommanager.go @@ -462,7 +462,7 @@ func (r *RoomManager) handleRTCMessage(_ context.Context, roomName livekit.RoomN return } pLogger.Debugw("setting track muted", - "track", rm.MuteTrack.TrackSid, "muted", rm.MuteTrack.Muted) + "trackID", rm.MuteTrack.TrackSid, "muted", rm.MuteTrack.Muted) if !rm.MuteTrack.Muted && !r.config.Room.EnableRemoteUnmute { pLogger.Errorw("cannot unmute track, remote unmute is disabled", nil) return diff --git a/test/client/client.go b/test/client/client.go index 8195e27d8..3ecee6497 100644 --- a/test/client/client.go +++ b/test/client/client.go @@ -320,7 +320,7 @@ func (c *RTCClient) Run() error { c.lock.Unlock() case *livekit.SignalResponse_TrackPublished: - logger.Debugw("track published", "track", msg.TrackPublished.Track.Name, "participant", c.localParticipant.Sid, + logger.Debugw("track published", "trackID", msg.TrackPublished.Track.Name, "participant", c.localParticipant.Sid, "cid", msg.TrackPublished.Cid, "trackSid", msg.TrackPublished.Track.Sid) c.lock.Lock() c.pendingPublishedTracks[msg.TrackPublished.Cid] = msg.TrackPublished.Track @@ -690,7 +690,7 @@ func (c *RTCClient) processTrack(track *webrtc.TrackRemote) { logger.Infow("client added track", "participant", c.localParticipant.Identity, "pID", pId, - "track", trackId, + "trackID", trackId, ) defer func() { @@ -719,7 +719,7 @@ func (c *RTCClient) processTrack(track *webrtc.TrackRemote) { numBytes += pkt.MarshalSize() if time.Since(lastUpdate) > 30*time.Second { logger.Infow("consumed from participant", - "track", trackId, "pID", pId, + "trackID", trackId, "pID", pId, "size", numBytes) lastUpdate = time.Now() } diff --git a/test/client/trackwriter.go b/test/client/trackwriter.go index 21dc2cd4d..8e9841d66 100644 --- a/test/client/trackwriter.go +++ b/test/client/trackwriter.go @@ -54,7 +54,7 @@ func (w *TrackWriter) Start() error { } logger.Debugw("starting track writer", - "track", w.track.ID(), + "trackID", w.track.ID(), "mime", w.mime) switch w.mime { case webrtc.MimeTypeOpus: