[CXX-2626] Misc Updates to Logging Spec Created: 12/Dec/22  Updated: 08/Feb/23

Status: Backlog
Project: C++ Driver
Component/s: Logging
Affects Version/s: None
Fix Version/s: None

Type: Spec Change Priority: Major - P3
Reporter: PM Bot Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split from DRIVERS-2516 Misc Updates to Logging Spec Implementing
Epic Link: Easier debugging with standardized logging
Upstream Changes Summary:

DRIVERS-2516:
If a driver has not started implementing logging yet, this ticket could be closed in favor of the original tickets around implementing the logging spec and adding log messages for other specs. All possible changes required by this ticket are captured in the text of the relevant specs.

Drivers who have already implemented or are in the process of implementing logging should review the changes in this commit and ensure their implementations comply. To summarize what changed:

  • For command log messages, when the user does not specify a port for a host and is therefore relying on the default 27017, the driver SHOULD include that default in log messages.
  • The suggested unstructured representations for command log messages have been slightly modified to match the CMAP log messages.
  • It's no longer a strict requirement that drivers support logging directly to a file. Instead, it is sufficient to provide a straightforward API that would allow a user to direct log messages to a file.
  • Clarify that drivers MAY attempt to warn users about invalid values of environment variables, but MUST NOT throw an error.
  • Require that if a driver supports configuring logging both via environment variables and programmatically, the programmatic configuration should take precedence.
  • Rationale sections were added for the previous two bullet points.

 Description   

This ticket was split from DRIVERS-2516, please see that ticket for a detailed description.


Generated at Wed Feb 07 22:06:31 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.