From 734bd5a0359751663a55ba0da7e59eaabc565014 Mon Sep 17 00:00:00 2001 From: ritalwar Date: Mon, 19 Feb 2024 12:17:38 +0530 Subject: [PATCH 1/4] Update the Kibana version condition for multihost fix support and add MongoDB field examples to the documentation. --- packages/mongodb/_dev/build/docs/README.md | 25 ++++++++++++++++++++++ packages/mongodb/changelog.yml | 5 +++++ packages/mongodb/docs/README.md | 25 ++++++++++++++++++++++ packages/mongodb/manifest.yml | 4 ++-- 4 files changed, 57 insertions(+), 2 deletions(-) diff --git a/packages/mongodb/_dev/build/docs/README.md b/packages/mongodb/_dev/build/docs/README.md index 5055fbf4f72..a5978ef35e9 100644 --- a/packages/mongodb/_dev/build/docs/README.md +++ b/packages/mongodb/_dev/build/docs/README.md @@ -2,6 +2,31 @@ This integration is used to fetch logs and metrics from [MongoDB](https://www.mongodb.com/). +## Configuration Notes + +When configuring the `hosts` option, MongoDB URLs should adhere to the following formats: + +- Simple: `[mongodb://][user:pass@]host[:port][?options]` +- Complex: `mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]` + +Examples of URLs can vary from simple to complex: + +- Basic: `localhost` +- Complex: `mongodb://myuser:mypass@localhost:40001", "otherhost:40001` + +Additional supported URL examples include: + +- Replica set: `mongodb://localhost:27017,localhost:27022,localhost:27023` +- Direct connection: `mongodb://localhost:27017/?directConnection=true` + +When utilizing the parameter `directConnection=true` in the connection URI, all operations are executed on the specified host. It's important to explicitly include `directConnection=true` in the URI, as it won't be automatically added. + +Example with replica set specified: + +- Replica set with specified username and password: `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` + +The username and password can either be included in the URL or set using the respective configuration options. If included in the URL, the credentials take precedence over the username and password configuration options. + ## Compatibility The `log` dataset is tested with logs from versions v3.2.11 and v4.4.4 in diff --git a/packages/mongodb/changelog.yml b/packages/mongodb/changelog.yml index 14a0bf3ec53..8e4b4a300a3 100644 --- a/packages/mongodb/changelog.yml +++ b/packages/mongodb/changelog.yml @@ -1,3 +1,8 @@ +- version: 1.13.1 + changes: + - description: Update the Kibana version condition for multihost fix support and add MongoDB `hosts` field examples to the documentation. + type: bugfix + link: tba - version: 1.13.0 changes: - description: Enable 'secret' for the sensitive fields, supported from 8.12. diff --git a/packages/mongodb/docs/README.md b/packages/mongodb/docs/README.md index c7cf73d6ed0..747fcaa7771 100644 --- a/packages/mongodb/docs/README.md +++ b/packages/mongodb/docs/README.md @@ -2,6 +2,31 @@ This integration is used to fetch logs and metrics from [MongoDB](https://www.mongodb.com/). +## Configuration Notes + +When configuring the `hosts` option, MongoDB URLs should adhere to the following formats: + +- Simple: `[mongodb://][user:pass@]host[:port][?options]` +- Complex: `mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]` + +Examples of URLs can vary from simple to complex: + +- Basic: `localhost` +- Complex: `mongodb://myuser:mypass@localhost:40001", "otherhost:40001` + +Additional supported URL examples include: + +- Replica set: `mongodb://localhost:27017,localhost:27022,localhost:27023` +- Direct connection: `mongodb://localhost:27017/?directConnection=true` + +When utilizing the parameter `directConnection=true` in the connection URI, all operations are executed on the specified host. It's important to explicitly include `directConnection=true` in the URI, as it won't be automatically added. + +Example with replica set specified: + +- Replica set with specified username and password: `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` + +The username and password can either be included in the URL or set using the respective configuration options. If included in the URL, the credentials take precedence over the username and password configuration options. + ## Compatibility The `log` dataset is tested with logs from versions v3.2.11 and v4.4.4 in diff --git a/packages/mongodb/manifest.yml b/packages/mongodb/manifest.yml index 48da94a0854..68062470e8e 100644 --- a/packages/mongodb/manifest.yml +++ b/packages/mongodb/manifest.yml @@ -1,6 +1,6 @@ name: mongodb title: MongoDB -version: "1.13.0" +version: "1.13.1" description: Collect logs and metrics from MongoDB instances with Elastic Agent. type: integration categories: @@ -14,7 +14,7 @@ icons: format_version: "3.0.2" conditions: kibana: - version: "^8.8.0" + version: "^8.9.0" elastic: subscription: basic screenshots: From 61752649943dea737cf91e833b1fe7e0ab1d2ca2 Mon Sep 17 00:00:00 2001 From: ritalwar Date: Mon, 19 Feb 2024 12:22:28 +0530 Subject: [PATCH 2/4] Update changelog.yml --- packages/mongodb/changelog.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mongodb/changelog.yml b/packages/mongodb/changelog.yml index 8e4b4a300a3..d818357ad1e 100644 --- a/packages/mongodb/changelog.yml +++ b/packages/mongodb/changelog.yml @@ -2,7 +2,7 @@ changes: - description: Update the Kibana version condition for multihost fix support and add MongoDB `hosts` field examples to the documentation. type: bugfix - link: tba + link: https://github.com/elastic/integrations/pull/9189 - version: 1.13.0 changes: - description: Enable 'secret' for the sensitive fields, supported from 8.12. From 5dd187c85eedd4c1bfc46ae73394d3e195f1bf1d Mon Sep 17 00:00:00 2001 From: ritalwar Date: Mon, 19 Feb 2024 12:27:04 +0530 Subject: [PATCH 3/4] Update README.md --- packages/mongodb/_dev/build/docs/README.md | 2 +- packages/mongodb/docs/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/mongodb/_dev/build/docs/README.md b/packages/mongodb/_dev/build/docs/README.md index a5978ef35e9..6e08bf05b1c 100644 --- a/packages/mongodb/_dev/build/docs/README.md +++ b/packages/mongodb/_dev/build/docs/README.md @@ -23,7 +23,7 @@ When utilizing the parameter `directConnection=true` in the connection URI, all Example with replica set specified: -- Replica set with specified username and password: `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` +- `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` The username and password can either be included in the URL or set using the respective configuration options. If included in the URL, the credentials take precedence over the username and password configuration options. diff --git a/packages/mongodb/docs/README.md b/packages/mongodb/docs/README.md index 747fcaa7771..ed3589abb78 100644 --- a/packages/mongodb/docs/README.md +++ b/packages/mongodb/docs/README.md @@ -23,7 +23,7 @@ When utilizing the parameter `directConnection=true` in the connection URI, all Example with replica set specified: -- Replica set with specified username and password: `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` +- `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` The username and password can either be included in the URL or set using the respective configuration options. If included in the URL, the credentials take precedence over the username and password configuration options. From 5b952676c090204a19de97c73b10f7826719cacb Mon Sep 17 00:00:00 2001 From: ritalwar Date: Wed, 21 Feb 2024 14:14:27 +0530 Subject: [PATCH 4/4] Address review comments --- packages/mongodb/_dev/build/docs/README.md | 20 ++++++++------------ packages/mongodb/docs/README.md | 20 ++++++++------------ 2 files changed, 16 insertions(+), 24 deletions(-) diff --git a/packages/mongodb/_dev/build/docs/README.md b/packages/mongodb/_dev/build/docs/README.md index 6e08bf05b1c..a2ded4477a5 100644 --- a/packages/mongodb/_dev/build/docs/README.md +++ b/packages/mongodb/_dev/build/docs/README.md @@ -4,28 +4,24 @@ This integration is used to fetch logs and metrics from [MongoDB](https://www.mo ## Configuration Notes -When configuring the `hosts` option, MongoDB URLs should adhere to the following formats: +When configuring the `hosts` option, MongoDB URIs must adhere to the following formats: -- Simple: `[mongodb://][user:pass@]host[:port][?options]` +- Simple: `mongodb://[user:pass@]host[:port][?options]` - Complex: `mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]` -Examples of URLs can vary from simple to complex: +Examples of URIs can vary from simple to complex: -- Basic: `localhost` +- Simple: `localhost` - Complex: `mongodb://myuser:mypass@localhost:40001", "otherhost:40001` -Additional supported URL examples include: +Additional supported URI examples include: -- Replica set: `mongodb://localhost:27017,localhost:27022,localhost:27023` +- Replica set: `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` - Direct connection: `mongodb://localhost:27017/?directConnection=true` -When utilizing the parameter `directConnection=true` in the connection URI, all operations are executed on the specified host. It's important to explicitly include `directConnection=true` in the URI, as it won't be automatically added. +When using the `directConnection=true` parameter in the connection URI, all operations are executed on the specified host. It's important to explicitly include `directConnection=true` in the URI as it won't be automatically added. -Example with replica set specified: - -- `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` - -The username and password can either be included in the URL or set using the respective configuration options. If included in the URL, the credentials take precedence over the username and password configuration options. +The username and password can either be included in the URI or set using the respective configuration options. If included in the URI, these credentials take precedence over any configured username and password configuration options. ## Compatibility diff --git a/packages/mongodb/docs/README.md b/packages/mongodb/docs/README.md index ed3589abb78..aad1432c3b4 100644 --- a/packages/mongodb/docs/README.md +++ b/packages/mongodb/docs/README.md @@ -4,28 +4,24 @@ This integration is used to fetch logs and metrics from [MongoDB](https://www.mo ## Configuration Notes -When configuring the `hosts` option, MongoDB URLs should adhere to the following formats: +When configuring the `hosts` option, MongoDB URIs must adhere to the following formats: -- Simple: `[mongodb://][user:pass@]host[:port][?options]` +- Simple: `mongodb://[user:pass@]host[:port][?options]` - Complex: `mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]` -Examples of URLs can vary from simple to complex: +Examples of URIs can vary from simple to complex: -- Basic: `localhost` +- Simple: `localhost` - Complex: `mongodb://myuser:mypass@localhost:40001", "otherhost:40001` -Additional supported URL examples include: +Additional supported URI examples include: -- Replica set: `mongodb://localhost:27017,localhost:27022,localhost:27023` +- Replica set: `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` - Direct connection: `mongodb://localhost:27017/?directConnection=true` -When utilizing the parameter `directConnection=true` in the connection URI, all operations are executed on the specified host. It's important to explicitly include `directConnection=true` in the URI, as it won't be automatically added. +When using the `directConnection=true` parameter in the connection URI, all operations are executed on the specified host. It's important to explicitly include `directConnection=true` in the URI as it won't be automatically added. -Example with replica set specified: - -- `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs` - -The username and password can either be included in the URL or set using the respective configuration options. If included in the URL, the credentials take precedence over the username and password configuration options. +The username and password can either be included in the URI or set using the respective configuration options. If included in the URI, these credentials take precedence over any configured username and password configuration options. ## Compatibility