Skip to content

chore: add properties to CNS logger calls #4059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore: add properties to CNS logger calls #4059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54e33a2
initial commit
peterfelts Sep 30, 2025
a042925
add properties to the return log call in unpublishNetworkContainer
peterfelts Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions cns/logger/cnslogger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,21 +148,28 @@ func (c *logger) Request(tag string, request any, err error) {
c.sendTraceInternal(msg, lvl)
}

func (c *logger) Response(tag string, response any, returnCode types.ResponseCode, err error) {
c.logger.Response(tag, response, int(returnCode), returnCode.String(), err)
func (c *logger) Response(tag string, response any, returnCode types.ResponseCode, properties any, err error) {
c.logger.Response(tag, response, int(returnCode), returnCode.String(), properties, err)
if c.th == nil || c.disableTraceLogging {
return
}
var msg string
lvl := ai.InfoLevel

// Create a string for properties if they exist
props := ""
if properties != nil {
props = fmt.Sprintf(" Properties: %+v", properties)
}

switch {
case err == nil && returnCode == 0:
msg = fmt.Sprintf("[%s] Sent %T %+v.", tag, response, response)
msg = fmt.Sprintf("[%s] Sent %T %+v.%s", tag, response, response, props)
case err != nil:
msg = fmt.Sprintf("[%s] Code:%s, %+v %s.", tag, returnCode.String(), response, err.Error())
msg = fmt.Sprintf("[%s] Code:%s, %+v %s.%s", tag, returnCode.String(), response, err.Error(), props)
lvl = ai.ErrorLevel
default:
msg = fmt.Sprintf("[%s] Code:%s, %+v.", tag, returnCode.String(), response)
msg = fmt.Sprintf("[%s] Code:%s, %+v.%s", tag, returnCode.String(), response, props)
}
c.sendTraceInternal(msg, lvl)
}
Comment on lines +151 to 175
Copy link

Copilot AI Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The properties formatting logic is duplicated from log/logger.go. Consider extracting this into a shared helper function to avoid code duplication.

Copilot uses AI. Check for mistakes.

Expand Down
6 changes: 3 additions & 3 deletions cns/logger/log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type loggershim interface {
LogEvent(aitelemetry.Event)
Errorf(string, ...any)
Request(string, any, error)
Response(string, any, types.ResponseCode, error)
Response(string, any, types.ResponseCode, any, error)
ResponseEx(string, any, any, types.ResponseCode, error)
SendMetric(aitelemetry.Metric)
}
Expand Down Expand Up @@ -85,8 +85,8 @@ func Request(tag string, request any, err error) {
}

// Deprecated: The global logger is deprecated. Migrate to zap using the cns/logger/v2 package and pass the logger instead.
func Response(tag string, response any, returnCode types.ResponseCode, err error) {
Log.Response(tag, response, returnCode, err)
func Response(tag string, response any, returnCode types.ResponseCode, properties any, err error) {
Log.Response(tag, response, returnCode, properties, err)
}

// Deprecated: The global logger is deprecated. Migrate to zap using the cns/logger/v2 package and pass the logger instead.
Expand Down
4 changes: 2 additions & 2 deletions cns/logger/v2/shim.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ func (s *shim) Request(msg string, data any, err error) {
s.z.Sugar().Infow("Request", "message", msg, "data", data, "error", err)
}

func (s *shim) Response(msg string, data any, code types.ResponseCode, err error) {
s.z.Sugar().Infow("Response", "message", msg, "data", data, "code", code, "error", err)
func (s *shim) Response(msg string, data any, code types.ResponseCode, properties any, err error) {
s.z.Sugar().Infow("Response", "message", msg, "data", data, "code", code, "properties", properties, "error", err)
}

func (s *shim) ResponseEx(msg string, request, response any, code types.ResponseCode, err error) {
Expand Down
Loading
Loading