Bytecode instrumentation MongoDB #3845

ysolomchenko · 2024-12-02T13:28:12Z

Why

Transitioning to bytecode instrumentation because the MongoDB.Driver and MongoDB.Driver.Core libraries are being merged into a single MongoDB.Driver library starting from version 3.0.0

Fixes #3738

What

Bytecode instrumentation for MongoDB with following attributes:

db.system
db.collection.name
db.namespace
db.operation.name
server.address
server.port
network.peer.address
network.peer.port

The implementation targets MongoDB.Driver and MongoDB.Driver.Core versions from 2.7.0 to the latest.

Tests

Manual + CI

Checklist

CHANGELOG.md is updated.
Documentation is updated.
New features are covered by tests.

Kielek · 2024-12-03T07:20:11Z

You might be interested in following pieces of code:

opentelemetry-dotnet-instrumentation/src/CommonExcludedAssets.props

Lines 16 to 49 in 01c5800

    
           <ItemGroup> 
        
             <!-- MongoDB.Driver.Core is required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="MongoDB.Driver.Core" ExcludeAssets="all" /> 
        
             <!-- AWSSDK.Core is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="AWSSDK.Core" ExcludeAssets="all" /> 
        
             <!-- "AWSSDK.SecurityToken is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="AWSSDK.SecurityToken" ExcludeAssets="all" /> 
        
             <!-- DnsClient is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="DnsClient" ExcludeAssets="all" /> 
        
             <!-- MongoDB.Bson is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="MongoDB.Bson" ExcludeAssets="all" /> 
        
             <!-- MongoDB.Libmongocrypt is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="MongoDB.Libmongocrypt" ExcludeAssets="all" /> 
        
             <!-- Snappier is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="Snappier" ExcludeAssets="all" /> 
        
             <!-- System.Net.Http is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Net.Http" ExcludeAssets="all" /> 
        
             <!-- System.Runtime.InteropServices.RuntimeInformation is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Runtime.InteropServices.RuntimeInformation" ExcludeAssets="all" /> 
        
             <!-- System.Security.Cryptography.Algorithms is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Security.Cryptography.Algorithms" ExcludeAssets="all" /> 
        
             <!-- System.Security.Cryptography.Encoding is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Security.Cryptography.Encoding" ExcludeAssets="all" /> 
        
             <!-- System.Security.Cryptography.Primitives is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Security.Cryptography.Primitives" ExcludeAssets="all" /> 
        
             <!-- System.Security.Cryptography.X509Certificates is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Security.Cryptography.X509Certificates" ExcludeAssets="all" /> 
        
             <!-- System.Text.Encoding.CodePages is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="System.Text.Encoding.CodePages" ExcludeAssets="all" /> 
        
             <!-- SharpCompress is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="SharpCompress" ExcludeAssets="all" /> 
        
             <!-- ZstdSharp.Port is tranistive dependency required by MongoDB.Driver.Core.Extensions.DiagnosticSources. --> 
        
             <PackageReference Include="ZstdSharp.Port" ExcludeAssets="all" /> 
        
           </ItemGroup>

opentelemetry-dotnet-instrumentation/src/Directory.Packages.props

Lines 41 to 64 in 01c5800

    
           <!-- Versions from CommonExcludedAssets.props --> 
        
           <ItemGroup> 
        
             <PackageVersion Include="AWSSDK.Core" Version="3.7.100.14" /> 
        
             <PackageVersion Include="AWSSDK.SecurityToken" Version="3.7.100.14" /> 
        
             <PackageVersion Include="DnsClient" Version="1.6.1" /> 
        
             <PackageVersion Include="Microsoft.Win32.SystemEvents" Version="4.7.0" /> 
        
             <PackageVersion Include="MongoDB.Bson" Version="2.28.0" /> 
        
             <PackageVersion Include="MongoDB.Driver.Core" Version="2.28.0" /> 
        
             <PackageVersion Include="MongoDB.Libmongocrypt" Version="1.11.0" /> 
        
             <PackageVersion Include="Pipelines.Sockets.Unofficial" Version="2.2.8" /> 
        
             <PackageVersion Include="SharpCompress" Version="0.30.1" /> 
        
             <PackageVersion Include="Snappier" Version="1.0.0" /> 
        
             <PackageVersion Include="StackExchange.Redis" Version="2.6.122" /> 
        
             <PackageVersion Include="System.Drawing.Common" Version="4.7.2" /> 
        
             <PackageVersion Include="System.Net.Http" Version="4.3.4" /> 
        
             <PackageVersion Include="System.Runtime.InteropServices.RuntimeInformation" Version="4.3.0" /> 
        
             <PackageVersion Include="System.Security.Cryptography.Algorithms" Version="4.3.0" /> 
        
             <PackageVersion Include="System.Security.Cryptography.Encoding" Version="4.3.0" /> 
        
             <PackageVersion Include="System.Security.Cryptography.Primitives" Version="4.3.0" /> 
        
             <PackageVersion Include="System.Security.Cryptography.X509Certificates" Version="4.3.0" /> 
        
             <PackageVersion Include="System.Text.Encoding.CodePages" Version="5.0.0" /> 
        
             <PackageVersion Include="System.Windows.Extensions" Version="4.7.0" /> 
        
             <PackageVersion Include="ZstdSharp.Port" Version="0.7.3" /> 
        
           </ItemGroup>

opentelemetry-dotnet-instrumentation/src/OpenTelemetry.AutoInstrumentation.BuildTasks/OpenTelemetry.AutoInstrumentation.BuildTasks.targets

Lines 5 to 10 in 01c5800

    
           <InstrumentationTarget 
        
             Include="MongoDB.Driver.Core" 
        
             Condition="!$(SkippedInstrumentations.Contains('MongoDB.Driver.Core'))" 
        
             TargetNuGetPackageVersionRange="[2.28.0, 3.0.0)" 
        
             InstrumentationNuGetPackageId="MongoDB.Driver.Core.Extensions.DiagnosticSources" 
        
             InstrumentationNuGetPackageVersion="1.5.0" />

opentelemetry-dotnet-instrumentation/LICENSE

Lines 295 to 298 in 01c5800

    
           Library MongoDB.Driver.Core.Extensions.DiagnosticSources is under the following copyright: 
        
           Copyright MongoDB.Driver.Core.Extensions.DiagnosticSources Authors under Apache 
        
           License Version 2.0 
        
           (<https://github.com/jbogard/MongoDB.Driver.Core.Extensions.DiagnosticSources/blob/master/LICENSE>).

Changelog, full doc review (search MongoDB in md files).

…pentelemetry-dotnet-instrumentation into mongo-db-bytecode

…>=3.0.0

…ansitive dependencies

zacharycmontoya · 2024-12-06T21:47:10Z

test/IntegrationTests/MongoDBTests.cs

+            collector.Expect(MongoDBInstrumentationScopeName);
        }

+        collector.Expect(MongoDBInstrumentationScopeName, span => ValidateSpan(span));


For older versions of MongoDb, is all of the data the same before and after this change? If not, are we concerned about any attributes changing?

Here is example for operation: find

Attributes for older version:

db.system: mongodb

db.connection_id: { ServerId : { ClusterId : 1, EndPoint : "Unspecified/localhost:27017" }, LocalValue : 3, ServerValue : "12" }

db.name: test-db

db.mongodb.collection: employees

db.operation: find

network.transport: tcp

server.address: localhost

server.port: 27017

db.statement: { "find" : "employees", "filter" : { }, "$db" : "test-db", "lsid" : { "id" : CSUUID("a3dc2d19-04fe-43f9-9b88-24a1ddd6af2a") } }

Attributes for new bytecode instrumentation:

db.system: mongodb

db.collection.name: employees

db.namespace: test-db

db.operation.name: find

network.peer.address: ::1

server.address: localhost

server.port: 27017

network.peer.port: 27017

db.connection_id and db.statement are not part of the latest semantic conventions. The only difference is that we currently don't have network.transport for this case, but I will add it in the next version of the bytecode MongoDB instrumentation.

Some attribute names have been updated to align with the latest semantic conventions

db.name -> db.namespace

db.mongodb.collection -> db.collection.name

db.operation -> db.operation.name

zacharycmontoya

LGTM

ysolomchenko added 11 commits November 7, 2024 10:27

wp

907e352

wp

4bd262d

Merge branch 'main' into mongo-db-bytecode

23f3070

bytecode instrumentation mongoDB v1

b21ff46

merge to .net 9

392ddd0

bytecode .net9

f8c8b9d

update MongoDB Test app

1335176

wp

c816588

mongo db-bytecode

744e1fa

minimum version to 2.7.0

9131161

Merge branch 'main' into mongo-db-bytecode

31976a2

ysolomchenko added 6 commits December 3, 2024 10:27

cleanup

413e842

Merge branch 'mongo-db-bytecode' of https://github.com/ysolomchenko/o…

a5f3941

…pentelemetry-dotnet-instrumentation into mongo-db-bytecode

CommonExcludedAssets.props remove required by MongoDB.DiagnosticSources

8244b01

fix GenerateNetFxTransientDependencies & override net462 for MongoDB …

e32860a

…>=3.0.0

update CHANGELOG

7d9b4a8

BuildTests.DistributionStructure verified fix

2d6b081

ysolomchenko marked this pull request as ready for review December 5, 2024 08:57

ysolomchenko requested a review from a team as a code owner December 5, 2024 08:57

Kielek added 10 commits December 5, 2024 11:05

Merge branch 'main' into mongo-db-bytecode

a804618

add upper boundaries to the documentation

94f638d

changelog update

716231b

document vulnerabilities in generator

7baac59

partial revert launchSettings.json

0212ab2

partial revert config.md

18e4fb7

Fix version in nuget instruction

7f2972a

Bump System.Runtime.InteropServices.RuntimeInformation to 4.3.0 in tr…

6d94e46

…ansitive dependencies

Merge branch 'main' into mongo-db-bytecode

7119946

Fix build for .NET Framework

2fd20b1

Merge branch 'main' into mongo-db-bytecode

e2f50e5

zacharycmontoya reviewed Dec 6, 2024

View reviewed changes

zacharycmontoya approved these changes Dec 6, 2024

View reviewed changes

nrcventura approved these changes Dec 10, 2024

View reviewed changes

Kielek added 2 commits December 10, 2024 06:44

Merge branch 'main' into mongo-db-bytecode

bdcbb69

Merge branch 'main' into mongo-db-bytecode

c60f412

Kielek merged commit 253f173 into open-telemetry:main Dec 10, 2024
38 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Bytecode instrumentation MongoDB #3845

Bytecode instrumentation MongoDB #3845

Uh oh!

ysolomchenko commented Dec 2, 2024 •

edited

Loading

Uh oh!

Kielek commented Dec 3, 2024

Uh oh!

zacharycmontoya Dec 6, 2024

Uh oh!

ysolomchenko Dec 9, 2024 •

edited

Loading

Uh oh!

zacharycmontoya left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Bytecode instrumentation MongoDB #3845

Bytecode instrumentation MongoDB #3845

Uh oh!

Conversation

ysolomchenko commented Dec 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

What

Tests

Checklist

Uh oh!

Kielek commented Dec 3, 2024

Uh oh!

zacharycmontoya Dec 6, 2024

Choose a reason for hiding this comment

Uh oh!

ysolomchenko Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zacharycmontoya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ysolomchenko commented Dec 2, 2024 •

edited

Loading

ysolomchenko Dec 9, 2024 •

edited

Loading