Backport MongoDB hosts array support to 3.x #879
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
Backport MongoDB integration fix from main branch to resolve broken connection strings when using modern configuration format with hosts array instead of legacy host/port parameters. The current 3.x template generates malformed MongoDB URIs (mongodb://user:pass@:/admin with missing host:port) when users provide modern 'hosts' array parameters. This occurs because the template expects old-style 'host' and 'port' keys but receives 'hosts' array from modern configurations, causing nil values in the connection string. Changes: - Add dual-path template logic supporting both formats - Modern configs with 'hosts' array use hosts format (works correctly) - Legacy configs with 'host'/'port' use connection string (backward compatible) - Add support for new MongoDB monitoring parameters: - dbm: Database Monitoring feature - database_autodiscovery: Auto-discovery of databases - reported_database_hostname: Custom hostname for metrics - Update documentation to deprecate host/port in favor of hosts - Add RSpec tests for modern hosts array format - Update CHANGELOG for unreleased changes Template changes: - Check if server['hosts'] exists and has elements - If yes: render modern hosts array format with fields - If no: fall back to legacy connection string format - Add dbm, database_autodiscovery, reported_database_hostname rendering Documentation changes: - Move hosts, dbm, database_autodiscovery, reported_database_hostname to top - Mark host and port as deprecated with recommendation to use hosts - Update examples to show modern hosts array format - Add link to official Datadog MongoDB integration docs Test changes: - Add test context for hosts array configuration - Verify hosts array renders correctly - Verify all new parameters render correctly - Maintain backward compatibility with existing tests Tested: - pdk validate: PASSED - Full test suite: 4895 examples, 0 failures, 63 pending - Syntax validation: PASSED Refs: 9472fc7 Refs: DataDog#838 Signed-off-by: Jaremy Hatler <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What does this PR do?
Backports the MongoDB
hostsarray support frommainbranch (PR #838, commit 9472fc7) to the3.xbranch to fix broken connection strings when using modern MongoDB configuration format.This resolves the issue where users providing modern
hostsarray parameters get malformed MongoDB URIs likemongodb://user:pass@:/admin(missing host:port).Motivation
Problem:
Organizations running the 3.x branch experience broken MongoDB monitoring when using modern configuration format. The template expects legacy
host/portparameters but receiveshostsarray, causing nil values that produce malformed connection strings.Impact:
host/portformat (inconsistent with current Datadog documentation)Why backport:
mainbranch (merged Feb 26, 2025)Additional Notes
Changes included in this backport:
Template (
templates/agent-conf.d/mongo.yaml.erb):hostsparameter existsdbm,database_autodiscovery,reported_database_hostnameManifest (
manifests/integrations/mongo.pp):hosts,dbm,database_autodiscovery,reported_database_hostnamehostandportparameters in favor ofhostsarrayTests (
spec/classes/datadog_agent_integrations_mongo_spec.rb):CHANGELOG (
CHANGELOG.md):Backward Compatibility:
✅ Fully backward compatible - legacy
host/portconfigurations continue to work unchangedOriginal implementation:
Describe your test plan
Automated Testing:
pdk validate --parallel: PASSED (only expected warnings for undocumented classes)Test scenarios covered: