[CASSANDRA-16749] DiagnosticEventService.publish logging logs events without an overridden toString causing less useful debug logs

• Type: Improvement
• Status: Resolved
• Priority: Low
• Resolution: Fixed
• Fix Version/s: 4.0.1, 4.1-alpha1, 4.1
• Component/s: Observability/Logging
• Change Category: Operability
• Complexity: Low Hanging Fruit
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/6c8f6bd663fea4b909f0e5723dbf7f181dd70487

Test and Documentation Plan

Ran DiagnosticEventServiceTest and checked the output. 

• Assignee: Zoltan Ersek
• Reporter: David Capwell

Authors

Zoltan Ersek

Reviewers

Michael Semb Wever

• Created: 17/Jun/21 17:48
• Updated: 27/May/22 19:24
• Resolved: 20/Jun/21 16:13

Description

The DiagnosticEventService logs each publish (if the event is enabled) using a logger, but the different events do not override the toString; this leaves the following logs

Publishing: org.apache.cassandra.gms.GossiperEvent@3cadeef2
Publishing: org.apache.cassandra.gms.GossiperEvent@6159419d
Publishing: org.apache.cassandra.service.PendingRangeCalculatorServiceEvent@18e52b1
Publishing: org.apache.cassandra.locator.TokenMetadataEvent@43a76a1a
etc.

To make these logs more meaningful, we might want to consider matching the persistent logic and convert the event to a map and then logging the map