Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MongoDB] Update the Kibana version condition for multi-host fix and documentation #9189

Merged
merged 4 commits into from Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions packages/mongodb/_dev/build/docs/README.md
Expand Up @@ -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:
shmsr marked this conversation as resolved.
Show resolved Hide resolved

- Simple: `[mongodb://][user:pass@]host[:port][?options]`
aliabbas-elastic marked this conversation as resolved.
Show resolved Hide resolved
- Complex: `mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]`

Examples of URLs can vary from simple to complex:

- Basic: `localhost`
shmsr marked this conversation as resolved.
Show resolved Hide resolved
- Complex: `mongodb://myuser:mypass@localhost:40001", "otherhost:40001`
aliabbas-elastic marked this conversation as resolved.
Show resolved Hide resolved

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.
shmsr marked this conversation as resolved.
Show resolved Hide resolved

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.
shmsr marked this conversation as resolved.
Show resolved Hide resolved

## Compatibility

The `log` dataset is tested with logs from versions v3.2.11 and v4.4.4 in
Expand Down
5 changes: 5 additions & 0 deletions 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: https://github.com/elastic/integrations/pull/9189
- version: 1.13.0
changes:
- description: Enable 'secret' for the sensitive fields, supported from 8.12.
Expand Down
25 changes: 25 additions & 0 deletions packages/mongodb/docs/README.md
Expand Up @@ -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`
aliabbas-elastic marked this conversation as resolved.
Show resolved Hide resolved
- 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:

- `mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs`
aliabbas-elastic marked this conversation as resolved.
Show resolved Hide resolved

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
Expand Down
4 changes: 2 additions & 2 deletions 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:
Expand All @@ -14,7 +14,7 @@ icons:
format_version: "3.0.2"
conditions:
kibana:
version: "^8.8.0"
version: "^8.9.0"
elastic:
subscription: basic
screenshots:
Expand Down