[RHCLOUD-30651] Independently log cloud-connector dispatchers map

[jessicarod7]

What?

https://issues.redhat.com/browse/RHCLOUD-30651

Why?

Dispatcher entries can be pulled directly from debug log messages for alternative parsing and application.

How?

The dispatcher map is marshalled to JSON and printed.

Testing

Tested with TestProcessDispatchers(). Example output:

=== RUN   TestProcessDispatchers
time="2024-10-31T12:26:30-04:00" level=debug msg="Dispatchers found: {\"catalog\":{\"ApplicationType\":\"ima_app_type\",\"SourceRef\":\"ima_source_ref\",\"SrcName\":\"ima_source_name\",\"SrcType\":\"ima_source_type\"}}" func=github.com/RedHatInsights/cloud-connector/internal/cloud_connector.processDispatchers file="/home/jrodri/develop/cloud-connector/internal/cloud_connector/message_handlers.go:224" account=12345 client_id=98765 org_id=54321
--- PASS: TestProcessDispatchers (0.00s)
PASS

Secure Coding Practices Checklist Link

• https://github.com/RedHatInsights/secure-coding-checklist

Secure Coding Checklist

• Input Validation
• Output Encoding
• Authentication and Password Management
• Session Management
• Access Control
• Cryptographic Practices
• Error Handling and Logging
• Data Protection
• Communication Security
• System Configuration
• Database Security
• File Management
• Memory Management
• General Coding Practices

[dehort]

Looking good. I left a comment.

[dehort]

I think this might be a little easier to read if we take this out of the if/else statement.

Let's add dispatchers as a logging field like this:

logger = logger.WithFields(logrus.Fields{"dispatchers": dispatchers})

How does the log message look if we do not marshal the dispatchers field and just log it as a field?

[jessicarod7]

It works, but it's not pretty. Running TestProcessDispatchers(), this is marshalled:

time="2024-11-08T09:53:31-05:00" level=debug msg="Dispatchers found: {\"catalog\":{\"ApplicationType\":\"ima_app_type\",\"SourceRef\":\"ima_source_ref\",\"SrcName\":\"ima_source_name\",\"SrcType\":\"ima_source_type\"}}" func=github.com/RedHatInsights/cloud-connector/internal/cloud_connector.processDispatchers file="/home/jrodri/develop/cloud-connector/internal/cloud_connector/message_handlers.go:224" account=12345 client_id=98765 org_id=54321

And this is with the logging field:

time="2024-11-08T09:53:31-05:00" level=debug msg="dispatchers found:" func=github.com/RedHatInsights/cloud-connector/internal/cloud_connector.processDispatchers file="/home/jrodri/develop/cloud-connector/internal/cloud_connector/message_handlers.go:226" account=12345 client_id=98765 dispatchers="map[catalog:map[ApplicationType:ima_app_type SourceRef:ima_source_ref SrcName:ima_source_name SrcType:ima_source_type]]" org_id=54321