Uploaded image for project: 'Ruby Driver'
  1. Ruby Driver
  2. RUBY-3296

Log informational message client-side based on detected environment (DocumentDB or CosmosDB)

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 2.19.1
    • Affects Version/s: None
    • Component/s: None
    • Labels:
      None
    • Hide

      DRIVERS-2583:
      Drivers should detect Cosmos and DocumentDB servers by examining host names added to a topology during MongoClient construction. If SRV is used, this check should be done on the SRV URI's `{hostname}.{domainname}` prior to SRV lookup (ex: xyz.mongodb.net).

      If one or more host names end with ".cosmos.azure.com" (case-insensitive), log the following message using an "info" level:

      You appear to be connected to a CosmosDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/cosmosdb

      If one or more host names end with ".docdb.amazonaws.com" or ".docdb-elastic.amazonaws.com" (case-insensitive), log the following message using an "info" level:

      You appear to be connected to a DocumentDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/documentdb

      Drivers should not emit more than one log message per MongoClient construction.

      Note: there are no spec/prose tests for this ticket. Each driver should implement its own set of tests for this behavior. The libmongoc tests from mongodb/mongo-c-driver#1374 may be used as a reference.
      Note#2: Refer to DRIVERS-2753 if using standardized logging.

      Show
      DRIVERS-2583: Drivers should detect Cosmos and DocumentDB servers by examining host names added to a topology during MongoClient construction. If SRV is used, this check should be done on the SRV URI's `{hostname}.{domainname}` prior to SRV lookup (ex: xyz.mongodb.net). If one or more host names end with ".cosmos.azure.com" (case-insensitive), log the following message using an "info" level: You appear to be connected to a CosmosDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/cosmosdb If one or more host names end with ".docdb.amazonaws.com" or ".docdb-elastic.amazonaws.com" (case-insensitive), log the following message using an "info" level: You appear to be connected to a DocumentDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/documentdb Drivers should not emit more than one log message per MongoClient construction. Note: there are no spec/prose tests for this ticket. Each driver should implement its own set of tests for this behavior. The libmongoc tests from mongodb/mongo-c-driver#1374 may be used as a reference. Note#2: Refer to DRIVERS-2753 if using standardized logging.

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

            Assignee:
            jamis.buck@mongodb.com Jamis Buck
            Reporter:
            dbeng-pm-bot PM Bot
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: