chore: add connection metadata to telemetry #716
+216
−27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 19166075826Details
💛 - Coveralls |
This reverts commit c5ec47e.
blva
commented
Nov 6, 2025
|
|
||
| export type ConnectionMetadata = AtlasMetadata & | ||
| AtlasLocalToolMetadata & { | ||
| connection_auth_type?: string; |
There was a problem hiding this comment.
planning to add host info here - starting with connection auth type as an example of something we can capture
blva
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds connection authentication type metadata to telemetry events for improved tracking and analytics. The changes rename AtlasToolMetadata to AtlasMetadata for clarity and introduce ConnectionMetadata that captures both Atlas cluster information and connection authentication type across MongoDB and Atlas tools.
Key Changes:
- Introduced
ConnectionMetadatatype that combines Atlas metadata with connection auth type tracking - Added
getConnectionInfoMetadata()helper method inToolBaseto extract connection metadata from session state - Updated MongoDB and Atlas tools to report connection authentication type in telemetry
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/telemetry/types.ts | Renamed AtlasToolMetadata to AtlasMetadata, introduced ConnectionMetadata type combining Atlas and connection auth metadata |
| src/tools/tool.ts | Added getConnectionInfoMetadata() helper method to extract connection metadata from session |
| src/common/session.ts | Added getter for connectionStringAuthType from connection manager |
| src/tools/mongodb/mongodbTool.ts | Updated resolveTelemetryMetadata() to use new getConnectionInfoMetadata() helper |
| src/tools/atlas/atlasTool.ts | Updated return type from AtlasToolMetadata to AtlasMetadata |
| src/tools/atlas/connect/connectCluster.ts | Override resolveTelemetryMetadata() to include connection metadata after cluster connection |
| src/tools/atlasLocal/atlasLocalTool.ts | Updated return type to ConnectionMetadata |
| src/tools/atlasLocal/connect/connectDeployment.ts | Override resolveTelemetryMetadata() to include connection metadata after deployment connection |
| tests/unit/toolBase.test.ts | Added comprehensive unit tests for getConnectionInfoMetadata() method |
| tests/integration/tools/mongodb/mongodbTool.test.ts | Added integration tests verifying connection auth type is captured in telemetry metadata |
Comment on lines
39
to
44
| protected override resolveTelemetryMetadata(result: CallToolResult): ConnectionMetadata { | ||
| return { | ||
| ...super.resolveTelemetryMetadata(result), | ||
| ...this.getConnectionInfoMetadata(), | ||
| }; | ||
| } |
There was a problem hiding this comment.
The spread operation on line 42 may overwrite properties from super.resolveTelemetryMetadata(result) since both return ConnectionMetadata objects that could contain overlapping keys like project_id. Consider making the precedence explicit or documenting which values should take priority.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Checklist