GODRIVER-2586 Add log messages to CMAP spec

event/monitoring.go

@@ -63,14 +63,17 @@ type CommandMonitor struct {
 	Failed    func(context.Context, *CommandFailedEvent)
 }
 
+// Reason represents the reason a connection was closed.
+type Reason string
+
 // strings for pool command monitoring reasons
 const (
-	ReasonIdle              = "idle"
-	ReasonPoolClosed        = "poolClosed"
-	ReasonStale             = "stale"
-	ReasonConnectionErrored = "connectionError"
-	ReasonTimedOut          = "timeout"
-	ReasonError             = "error"
+	ReasonIdle              Reason = "idle"
+	ReasonPoolClosed        Reason = "poolClosed"
+	ReasonStale             Reason = "stale"
+	ReasonConnectionErrored Reason = "connectionError"
+	ReasonTimedOut          Reason = "timeout"
+	ReasonError             Reason = "error"
 )
 
 // strings for pool command monitoring types
@@ -101,7 +104,7 @@ type PoolEvent struct {
 	Address      string              `json:"address"`
 	ConnectionID uint64              `json:"connectionId"`
 	PoolOptions  *MonitorPoolOptions `json:"options"`
-	Reason       string              `json:"reason"`
+	Reason       Reason              `json:"reason"`
 	// ServiceID is only set if the Type is PoolCleared and the server is deployed behind a load balancer. This field
 	// can be used to distinguish between individual servers in a load balanced deployment.
 	ServiceID *primitive.ObjectID `json:"serviceId"`

examples/_logger/custom/main.go

@@ -4,7 +4,7 @@
 // not use this file except in compliance with the License. You may obtain
 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
-//go:build logrus
+//go:build customlog
 
 package main
 
@@ -46,6 +46,7 @@ func main() {
 		SetLoggerOptions(loggerOptions)
 
 	client, err := mongo.Connect(context.TODO(), clientOptions)
+
 	if err != nil {
 		log.Fatalf("error connecting to MongoDB: %v", err)
 	}

internal/logger/component.go

@@ -14,9 +14,56 @@ import (
 )
 
 const (
-	CommandFailed    = "Command failed"
-	CommandStarted   = "Command started"
-	CommandSucceeded = "Command succeeded"
+	CommandFailed             = "Command failed"
+	CommandStarted            = "Command started"
+	CommandSucceeded          = "Command succeeded"
+	ConnectionPoolCreated     = "Connection pool created"
+	ConnectionPoolReady       = "Connection pool ready"
+	ConnectionPoolCleared     = "Connection pool cleared"
+	ConnectionPoolClosed      = "Connection pool closed"
+	ConnectionCreated         = "Connection created"
+	ConnectionReady           = "Connection ready"
+	ConnectionClosed          = "Connection closed"
+	ConnectionCheckoutStarted = "Connection checkout started"
+	ConnectionCheckoutFailed  = "Connection checkout failed"
+	ConnectionCheckedOut      = "Connection checked out"
+	ConnectionCheckedIn       = "Connection checked in"
+)
+
+const (
+	KeyCommand            = "command"
+	KeyCommandName        = "commandName"
+	KeyDatabaseName       = "databaseName"
+	KeyDriverConnectionID = "driverConnectionId"
+	KeyDurationMS         = "durationMS"
+	KeyError              = "error"
+	KeyFailure            = "failure"
+	KeyMaxConnecting      = "maxConnecting"
+	KeyMaxIdleTimeMS      = "maxIdleTimeMS"
+	KeyMaxPoolSize        = "maxPoolSize"
+	KeyMessage            = "message"
+	KeyMinPoolSize        = "minPoolSize"
+	KeyOperationID        = "operationId"
+	KeyReason             = "reason"
+	KeyReply              = "reply"
+	KeyRequestID          = "requestId"
+	KeyServerConnectionID = "serverConnectionId"
+	KeyServerHost         = "serverHost"
+	KeyServerPort         = "serverPort"
+	KeyServiceID          = "serviceId"
+)
+
+// Reason represents why a connection was closed.
+type Reason string
+
+const (
+	ReasonConnClosedStale              Reason = "Connection became stale because the pool was cleared"
+	ReasonConnClosedIdle               Reason = "Connection has been available but unused for longer than the configured max idle time"
+	ReasonConnClosedError              Reason = "An error occurred while using the connection"
+	ReasonConnClosedPoolClosed         Reason = "Connection pool was closed"
+	ReasonConnCheckoutFailedTimout     Reason = "Wait queue timeout elapsed without a connection becoming available"
+	ReasonConnCheckoutFailedError      Reason = "An error occurred while trying to establish a new connection"
+	ReasonConnCheckoutFailedPoolClosed Reason = "Connection pool was closed"
 )
 
 // Component is an enumeration representing the "components" which can be
@@ -88,30 +135,52 @@ type Command struct {
 func SerializeCommand(cmd Command, extraKeysAndValues ...interface{}) []interface{} {
 	// Initialize the boilerplate keys and values.
 	keysAndValues := append([]interface{}{
-		"commandName", cmd.Name,
-		"driverConnectionId", cmd.DriverConnectionID,
-		"message", cmd.Message,
-		"operationId", cmd.OperationID,
-		"requestId", cmd.RequestID,
-		"serverHost", cmd.ServerHost,
+		KeyCommandName, cmd.Name,
+		KeyDriverConnectionID, cmd.DriverConnectionID,
+		KeyMessage, cmd.Message,
+		KeyOperationID, cmd.OperationID,
+		KeyRequestID, cmd.RequestID,
+		KeyServerHost, cmd.ServerHost,
 	}, extraKeysAndValues...)
 
 	// Add the optional keys and values.
 	port, err := strconv.ParseInt(cmd.ServerPort, 0, 32)
 	if err == nil {
-		keysAndValues = append(keysAndValues, "serverPort", port)
+		keysAndValues = append(keysAndValues, KeyServerPort, port)
 	}
 
 	// Add the "serverConnectionId" if it is not nil.
 	if cmd.ServerConnectionID != nil {
-		keysAndValues = append(keysAndValues,
-			"serverConnectionId", *cmd.ServerConnectionID)
+		keysAndValues = append(keysAndValues, KeyServerConnectionID, *cmd.ServerConnectionID)
 	}
 
 	// Add the "serviceId" if it is not nil.
 	if cmd.ServiceID != nil {
-		keysAndValues = append(keysAndValues,
-			"serviceId", cmd.ServiceID.Hex())
+		keysAndValues = append(keysAndValues, KeyServiceID, cmd.ServiceID.Hex())
+	}
+
+	return keysAndValues
+}
+
+// Connection contains data that all connection log messages MUST contain.
+type Connection struct {
+	Message    string // Message associated with the connection
+	ServerHost string // Hostname or IP address for the server
+	ServerPort string // Port for the server
+}
+
+// SerializeConnection serializes a ConnectionMessage into a slice of keys
+// and values that can be passed to a logger.
+func SerializeConnection(conn Connection, extraKeysAndValues ...interface{}) []interface{} {
+	keysAndValues := append([]interface{}{
+		KeyMessage, conn.Message,
+		KeyServerHost, conn.ServerHost,
+	}, extraKeysAndValues...)
+
+	// Convert the ServerPort into an integer.
+	port, err := strconv.ParseInt(conn.ServerPort, 0, 32)
+	if err == nil {
+		keysAndValues = append(keysAndValues, KeyServerPort, port)
 	}
 
 	return keysAndValues