DOC-1246 Add aggregate option to mongodb output and processor (#224)

Author: asimms41

modules/components/pages/outputs/mongodb.adoc

@@ -21,30 +21,30 @@ Common::
 --
 
 ```yml
-# Common config fields, showing default values
+# Common configuration fields, showing default values
 output:
   label: ""
   mongodb:
     url: mongodb://localhost:27017 # No default (required)
     database: "" # No default (required)
-    username: ""
-    password: ""
+    username: "" # No default (optional)
+    password: "" # No default (optional)
     collection: "" # No default (required)
     operation: update-one
     write_concern:
-      w: ""
+      w: "" # No default (optional)
       j: false
-      w_timeout: ""
-    document_map: ""
-    filter_map: ""
-    hint_map: ""
+      w_timeout: "" # No default (optional)
+    document_map: "" # No default (optional)
+    filter_map: "" # No default (optional)
+    hint_map: "" # No default (optional)
     upsert: false
     max_in_flight: 64
     batching:
       count: 0
       byte_size: 0
-      period: ""
-      check: ""
+      period: "" # No default (optional)
+      check: "" # No default (optional)
 ```
 
 --
@@ -53,31 +53,31 @@ Advanced::
 --
 
 ```yml
-# All config fields, showing default values
+# All configuration fields, showing default values
 output:
   label: ""
   mongodb:
     url: mongodb://localhost:27017 # No default (required)
     database: "" # No default (required)
-    username: ""
-    password: ""
+    username: "" # No default (optional)
+    password: "" # No default (optional)
     app_name: benthos
     collection: "" # No default (required)
     operation: update-one
     write_concern:
-      w: ""
+      w: "" # No default (optional)
       j: false
-      w_timeout: ""
-    document_map: ""
-    filter_map: ""
-    hint_map: ""
+      w_timeout: "" # No default (optional)
+    document_map: "" # No default (optional)
+    filter_map: "" # No default (optional)
+    hint_map: "" # No default (optional)
     upsert: false
     max_in_flight: 64
     batching:
       count: 0
       byte_size: 0
-      period: ""
-      check: ""
+      period: "" # No default (optional)
+      check: "" # No default (optional)
       processors: [] # No default (optional)
 ```
 
@@ -87,9 +87,9 @@ output:
 
 == Performance
 
-This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field `max_in_flight`.
+This output benefits from sending multiple messages in flight, in parallel, for improved performance. You can tune the maximum number of in flight messages (or message batches) using the `max_in_flight` field.
 
-This output benefits from sending messages as a batch for improved performance. Batches can be formed at both the input and output level. You can find out more xref:configuration:batching.adoc[in this doc].
+This output benefits from sending messages as a batch for improved performance. Batches can be formed at both the input and output level. For more information, see xref:configuration:batching.adoc[Message Batching].
 
 == Fields
 
@@ -117,7 +117,7 @@ The name of the target MongoDB database.
 
 === `username`
 
-The username to connect to the database.
+The username required to connect to the database.
 
 
 *Type*: `string`
@@ -126,12 +126,11 @@ The username to connect to the database.
 
 === `password`
 
-The password to connect to the database.
+The password required to connect to the database.
 
 include::components:partial$secret_warning.adoc[]
 
 
-
 *Type*: `string`
 
 *Default*: `""`
@@ -140,10 +139,10 @@ include::components:partial$secret_warning.adoc[]
 
 The client application name.
 
-
 *Type*: `string`
 
-*Default*: `"benthos"`
+*Default*: `benthos`
+
 
 === `collection`
 
@@ -155,32 +154,29 @@ The name of the target collection. This field supports xref:configuration:interp
 
 === `operation`
 
-The mongodb operation to perform.
-
+The MongoDB database operation to perform.
 
 *Type*: `string`
 
-*Default*: `"update-one"`
+*Default*: `update-one`
 
 Options:
 `insert-one`
 , `delete-one`
 , `delete-many`
 , `replace-one`
 , `update-one`
-.
 
 === `write_concern`
 
-The write concern settings for the mongo connection.
-
+The https://www.mongodb.com/docs/manual/reference/write-concern/[write concern settings^] for the MongoDB connection.
 
 *Type*: `object`
 
 
 === `write_concern.w`
 
-W requests acknowledgement that write operations propagate to the specified number of mongodb instances.
+The `w` requests acknowledgement, which write operations propagate to the specified number of MongoDB instances.
 
 
 *Type*: `string`
@@ -189,8 +185,7 @@ W requests acknowledgement that write operations propagate to the specified numb
 
 === `write_concern.j`
 
-J requests acknowledgement from MongoDB that write operations are written to the journal.
-
+The `j` requests acknowledgement from MongoDB, which is created when write operations are written to the journal.
 
 *Type*: `bool`
 
@@ -207,7 +202,7 @@ The write concern timeout.
 
 === `document_map`
 
-A bloblang map representing a document to store within MongoDB, expressed as https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/[extended JSON in canonical form^]. The document map is required for the operations insert-one, replace-one and update-one.
+A Bloblang map that represents a document to store in MongoDB, expressed as https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/[extended JSON in canonical form^]. The `document_map` parameter is required for the following database operations: `insert-one`, `replace-one`, and `update-one`.
 
 
 *Type*: `string`
@@ -224,8 +219,9 @@ document_map: |-
 
 === `filter_map`
 
-A bloblang map representing a filter for a MongoDB command, expressed as https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/[extended JSON in canonical form^]. The filter map is required for all operations except insert-one. It is used to find the document(s) for the operation. For example in a delete-one case, the filter map should have the fields required to locate the document to delete.
+A Bloblang map that represents a filter for a MongoDB command, expressed as https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/[extended JSON in canonical form^]. The `filter_map` parameter is required for all database operations except `insert-one`. 
 
+This output uses `filter_map` to find documents for the specified operation. For example, for a `delete-one` operation, the filter map should include the fields required to locate the document for deletion.
 
 *Type*: `string`
 
@@ -241,8 +237,9 @@ filter_map: |-
 
 === `hint_map`
 
-A bloblang map representing the hint for the MongoDB command, expressed as https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/[extended JSON in canonical form^]. This map is optional and is used with all operations except insert-one. It is used to improve performance of finding the documents in the mongodb.
+A Bloblang map that represents a hint or index for a MongoDB command to use, expressed as https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/[extended JSON in canonical form^]. This map is optional, and is used with all operations except `insert-one`. 
 
+Define a `hint_map` to improve performance when finding documents in the MongoDB database.
 
 *Type*: `string`
 
@@ -258,17 +255,17 @@ hint_map: |-
 
 === `upsert`
 
-The upsert setting is optional and only applies for update-one and replace-one operations. If the filter specified in filter_map matches, the document is updated or replaced accordingly, otherwise it is created.
-
+The `upsert` parameter is optional, and only applies for `update-one` and `replace-one` operations. If the filter specified in `filter_map` matches an existing document, this operation updates or replaces the document, otherwise a new document is created.
 
 *Type*: `bool`
 
 *Default*: `false`
+
 Requires version 3.60.0 or newer
 
 === `max_in_flight`
 
-The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
+The maximum number of messages to have in flight at a given time. Increase this number to improve throughput.
 
 
 *Type*: `int`
@@ -303,25 +300,23 @@ batching:
 
 === `batching.count`
 
-A number of messages at which the batch should be flushed. If `0` disables count based batching.
-
+The number of messages after which the batch is flushed. Set to `0` to disable count-based batching.
 
 *Type*: `int`
 
 *Default*: `0`
 
 === `batching.byte_size`
 
-An amount of bytes at which the batch should be flushed. If `0` disables size based batching.
-
+The number of bytes at which the batch is flushed. Set to `0` to disable size-based batching.
 
 *Type*: `int`
 
 *Default*: `0`
 
 === `batching.period`
 
-A period in which an incomplete batch should be flushed regardless of its size.
+The period after which an incomplete batch is flushed regardless of its size.
 
 
 *Type*: `string`
@@ -355,7 +350,7 @@ check: this.type == "end_of_transaction"
 
 === `batching.processors`
 
-A list of xref:components:processors/about.adoc[processors] to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.
+For aggregating and archiving message batches, you can add a list of xref:components:processors/about.adoc[processors] to apply to a batch as it is flushed. All resulting messages are flushed as a single batch even when you configure processors to split the batch into smaller batches.
 
 
 *Type*: `array`