Update Instrumentation for MongoDB

[tippmar-nr]

Describe the story, please be clear on scope of the story.

Please be concise with the scope for the story.

Acceptance Criteria

We currently instrument several MongoDb APIs that have been marked as Obsolete in all but the oldest version we currently support. Among those APIs are CountDocuments and CountDocumentsAsync as well as a some significant changes to MapReduce.

Review the current MongoDB API surface and update our instrumentation to cover new methods where appropriate. Refactor test fixtures, helpers and tests as appropriate to exercise the newly-instrumented APIs. We should continue to test the obsolete methods as well, but only on Framework462, since that's the only version where they're not marked obsolete.

Estimates

Please provide initial t-shirt size
S

[workato-integration]

https://issues.newrelic.com/browse/NEWRELIC-8701

[workato-integration]

Jira CommentId: 215544
Commented by ahemsath:

Notes on what I've found so far in reviewing the 2.19 C# driver documentation ([https://mongodb.github.io/mongo-csharp-driver/2.19/apidocs/html/R_Project_CSharpDriverDocs.htm):]

• IMongoCollection methods:
  ** MapReduce(Async) methods are obsoleted in favor of Aggregate(Async), which we already instrument and test.
  ** There are some (new?) methods AggregateToCollection(Async) which we do not instrument or test
  ** Count(Async) is obsoleted in favor of CountDocuments(Async) which we do not instrument or test
  *** There are also new EstimatedDocumentCount(Async) methods which we do not instrument or test
  ** There is an "OfType" collection operation that we don't instrument, but it doesn't appear to actually make a database call, it just happens to be a method defined on the IMongoCollection interface alongside other methods which do, so I'm not sure we'd want to instrument it
• IAsyncCursor methods:
  ** We currently instrument GetNextBatch(Async), which doesn't appear to exist in 2.12
  **  

[workato-integration]

Jira CommentId: 215544
Commented by ahemsath:

Notes on what I've found so far in reviewing the 2.19 C# driver documentation ([https://mongodb.github.io/mongo-csharp-driver/2.19/apidocs/html/R_Project_CSharpDriverDocs.htm):]

• IMongoCollection methods:
  ** MapReduce(Async) methods are obsoleted in favor of Aggregate(Async), which we already instrument and test.
  ** There are some (new?) methods AggregateToCollection(Async) which we do not instrument or test
  ** Count(Async) is obsoleted in favor of CountDocuments(Async) which we do not instrument or test
  *** There are also new EstimatedDocumentCount(Async) methods which we do not instrument or test
  ** There is an "OfType" collection operation that we don't instrument, but it doesn't appear to actually make a database call, it just happens to be a method defined on the IMongoCollection interface alongside other methods which do, so I'm not sure we'd want to instrument it
• IMongoDatabase methods:
  ** ListCollectionNames(Async) is not instrumented or tested
  ** This interface (and its implementation) has its own Aggregate(Async), AggregateToCollection(Async), and Watch(Async) methods.  From examining dissassembly they appear to be separate implementations from the collection-level methods with the same names.  So this appears to be an instrumentation gap.
• IMongoIndexManager methods:
  ** These all appear to be instrumented

[workato-integration]

Jira CommentId: 215544
Commented by ahemsath:

Notes on what I've found so far in reviewing the 2.19 C# driver documentation ([https://mongodb.github.io/mongo-csharp-driver/2.19/apidocs/html/R_Project_CSharpDriverDocs.htm):]

• IMongoCollection methods:
  ** MapReduce(Async) methods are obsoleted in favor of Aggregate(Async), which we already instrument and test. (y)
  ** There are some (new?) methods AggregateToCollection(Async) which we do not instrument or test (/)
  ** Count(Async) is obsoleted in favor of CountDocuments(Async) which we do not instrument or test (/)
  *** There are also new EstimatedDocumentCount(Async) methods which we do not instrument or test (/)
  ** There is an "OfType" collection operation that we don't instrument, but it doesn't appear to actually make a database call, it just happens to be a method defined on the IMongoCollection interface alongside other methods which do, so I'm not sure we'd want to instrument it (i)
• IMongoDatabase methods:
  ** ListCollectionNames(Async) is not instrumented or tested
  ** This interface (and its implementation) has its own Aggregate(Async), AggregateToCollection(Async), and Watch(Async) methods.  From examining dissassembly they appear to be separate implementations from the collection-level methods with the same names.  So this appears to be an instrumentation gap.
• IMongoIndexManager methods:
  ** These all appear to be instrumented

[workato-integration]

Jira CommentId: 215544
Commented by ahemsath:

Notes on what I've found so far in reviewing the 2.19 C# driver documentation ([https://mongodb.github.io/mongo-csharp-driver/2.19/apidocs/html/R_Project_CSharpDriverDocs.htm):]

• IMongoCollection methods:
  ** MapReduce(Async) methods are obsoleted in favor of Aggregate(Async), which we already instrument and test. (y)
  ** There are some (new?) methods AggregateToCollection(Async) which we do not instrument or test (/)
  ** Count(Async) is obsoleted in favor of CountDocuments(Async) which we do not instrument or test (/)
  *** There are also new EstimatedDocumentCount(Async) methods which we do not instrument or test (/)
  ** There is an "OfType" collection operation that we don't instrument, but it doesn't appear to actually make a database call, it just happens to be a method defined on the IMongoCollection interface alongside other methods which do, so I'm not sure we'd want to instrument it (i)
• IMongoDatabase methods:
  ** ListCollectionNames(Async) is not instrumented or tested (/)
  ** This interface (and its implementation) has its own Aggregate(Async), AggregateToCollection(Async), and Watch(Async) methods.  From examining dissassembly they appear to be separate implementations from the collection-level methods with the same names.  So this appears to be an instrumentation gap.
• IMongoIndexManager methods:
  ** These all appear to be instrumented

[workato-integration]

Jira CommentId: 215544
Commented by ahemsath:

Notes on what I've found so far in reviewing the 2.19 C# driver documentation ([https://mongodb.github.io/mongo-csharp-driver/2.19/apidocs/html/R_Project_CSharpDriverDocs.htm):]

• IMongoCollection methods:
  ** MapReduce(Async) methods are obsoleted in favor of Aggregate(Async), which we already instrument and test. (y)
  ** There are some (new?) methods AggregateToCollection(Async) which we do not instrument or test (/)
  ** Count(Async) is obsoleted in favor of CountDocuments(Async) which we do not instrument or test (/)
  *** There are also new EstimatedDocumentCount(Async) methods which we do not instrument or test (/)
  ** There is an "OfType" collection operation that we don't instrument, but it doesn't appear to actually make a database call, it just happens to be a method defined on the IMongoCollection interface alongside other methods which do, so I'm not sure we'd want to instrument it (i)
• IMongoDatabase methods:
  ** ListCollectionNames(Async) is not instrumented or tested (/)
  ** This interface (and its implementation) has its own Aggregate(Async) (/), AggregateToCollection(Async) (/), and Watch(Async) (/) methods.  From examining dissassembly they appear to be separate implementations from the collection-level methods with the same names.  So this appears to be an instrumentation gap. (/)
• IMongoIndexManager methods:
  ** These all appear to be instrumented

[workato-integration]

Jira CommentId: 219052
Commented by ahemsath:

Link to PR: [https://github.com//pull/1732]

All of the methods in the above comment with a (/) will now be instrumented by the agent when this PR is merged.

[workato-integration]

Jira CommentId: 219599
Commented by ahemsath:

Docs update branch to be PRed when 10.12 is released: https://github.com/nr-ahemsath/docs-website/tree/add-new-mongodb-instrumented-methods-10-12-0