Aggregation Pipeline Builder¶

The Data Explorer provides an aggregation pipeline builder to process your data. Aggregation pipelines transform your documents into aggregated results based on selected pipeline stages.

The MongoDB Atlas aggregation pipeline builder is primarily designed for building pipelines, rather than executing them. The pipeline builder provides an easy way to export your pipeline to execute in a driver.

To interact with data in the Cloud Manager UI:

1. Click Deployment in the left navigation.
2. Select the desired MongoDB deployment.
3. Select the Data tab.

Access the Aggregation Pipeline Builder¶

1

Select the database for the collection.¶

The main panel and Namespaces on the left side list the collections in the database.

click to enlarge

2

Select the collection on the left-hand side or in the main panel.¶

The main panel displays the Find , Indexes , and Aggregation views.

3

Select the Aggregation view.¶

When you first open the Aggregation view, the Data Explorer displays an empty aggregation pipeline.

click to enlarge

Create an Aggregation Pipeline¶

1

Select an aggregation stage.¶

Select an aggregation stage from the Select dropdown in the bottom-left panel.

click to enlarge

The toggle to the right of the dropdown dictates whether the stage is enabled.

2

Fill in your aggregation stage.¶

Fill in your stage with the appropriate values. If Comment Mode is enabled, the pipeline builder provides syntactic guidelines for your selected stage.

As you modify your stage, the Data Explorer updates the preview documents on the right based on the results of the current stage.

click to enlarge

3

Add additional stages to your pipeline as desired.¶

There are two ways to add additional stages to your pipeline:

• Click the Add Stage button at the bottom of the pipeline to add a new stage at the end of your pipeline:
• Click the plus icon button on a stage to add a new stage directly after the stage where the button was clicked.

To delete a pipeline stage, click the trash icon icon on the desired stage.

4

Repeat steps 1 and 2 for each additional stage.¶

Collation¶

Use collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

To specify a collation document, click Collation at the top of the pipeline builder.

A collation document has the following fields:

copy

copied

{
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

The locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.

Import an Aggregation Pipeline from Text¶

You can import aggregation pipelines from plain text into the pipeline builder to easily modify and verify your pipelines.

To import a pipeline from plain text:

1

Open the New Pipeline from Text dialog.¶

1. Click the arrow next to the plus icon at the top of the pipeline builder.

2. Click New Pipeline from Text .

   

   click to enlarge

2

Type or paste your pipeline in the dialog.¶

Your pipeline must match the syntax of the pipeline parameter of the db.collection.aggregate() method.

3

Click Create New .¶

4

Click Confirm in the ensuing dialog.¶

Reset Your Pipeline¶

To return your pipeline to the initial blank state, click the plus icon at the top of the pipeline builder.

Aggregation Pipeline Settings¶

To modify the aggregation pipeline builder settings:

1

Click the settings icon icon at the top-right of the pipeline builder.¶

2

Modify pipeline settings as desired.¶

You can modify the following settings:

Setting	Description	Default
Comment Mode	When enabled, the Data Explorer adds helper comments to each stage. Note Changing this setting only affects new stages and does not modify stages which have already been added to your pipeline.	On
Number of Preview Documents	Number of documents to show in the preview for each stage.	20

3

Click Apply to save your changes.¶

MongoDB Agent¶

Before the introduction of the MongoDB Agent, each function – Automation, Backup, and Monitoring – ran as a separate agent binary in your project.

The MongoDB Agent runs as a single binary that can perform any – or all – of the three functions depending upon what you need.

• Activate the monitoring and/or backup functions using Cloud Manager UI.
• Activate automation when you create a new cluster or import an existing one.

MongoDB Agent Prerequisites

Configure MongoDB Agent prerequisites.

Install MongoDB Agent

Install the MongoDB Agent.

Update to the MongoDB Agent

Update the MongoDB Agent.

Restart the MongoDB Agent

Restart the MongoDB Agent.

Manage the MongoDB Agent Functions

Activate or deactivate all functions of the MongoDB Agent.

MongoDB Agent Settings

Find all possible settings available in the MongoDB Agent configuration file.

Required Access for MongoDB Agent

Details the permissions required for MongoDB Agent to use with MongoDB instances that enforce access control.

Configure the MongoDB Agent for Access Control

If MongoDB uses Access Control, create a MongoDB user for the MongoDB Agent to use to authenticate and to determine the Agent’s access.

Configure MongoDB Agent to Use TLS

Configure the MongoDB Agent for TLS.

Configure How the MongoDB Agent Manages Config Files and Passwords

Configure how the MongoDB Agent stores its configuration and manages its passwords.

Remove Legacy Agents

Remove the legacy Backup and Monitoring Agents.

View Agent Status

View the status of a project’s agents.

Manage Agent API Keys

Manage project’s agent API keys.

Get All Projects in an Organization¶

Base URL: https://cloud.mongodb.com/api/public/v1.0

GET /orgs/{ORG-ID}/groups

curl --user "{username:apiKey}" \
  --include \
  --header "Content-Type: application/json" \
  --digest GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups"

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

{
  "links": [{

  }],
  "results": [{
      "activeAgentCount": 0,
      "hostCounts": {
        "arbiter": 0,
        "config": 0,
        "master": 0,
        "mongos": 0,
        "primary": 1,
        "secondary": 2,
        "slave": 0
      },
      "id": "{PROJECT-ID}",
      "links": [{

      }],
      "name": "Production Cluster",
      "orgId": "{ORG-ID}",
      "publicApiEnabled": true,
      "replicaSetCount": 1,
      "shardCount": 0
    },
    {
      "activeAgentCount": 0,
      "hostCounts": {
        "arbiter": 0,
        "config": 0,
        "master": 0,
        "mongos": 0,
        "primary": 1,
        "secondary": 2,
        "slave": 0
      },
      "id": "{PROJECT-ID}",
      "lastActiveAgent": "2017-10-26T02:39:59Z",
      "links": [{

      }],
      "name": "Staging Cluster",
      "orgId": "{ORG-ID}",
      "publicApiEnabled": true,
      "replicaSetCount": 1,
      "shardCount": 0
    }
  ],
  "totalCount": 2
}

Monitor and Improve Slow Queries¶

The Performance Advisor monitors any operation with a query predicate that MongoDB considers slow and suggests new indexes to improve query performance. For the selected host and time period, the Performance Advisor evaluates up to the 20,000 most recent slow queries found in the logs.

Recommended indexes are accompanied by sample queries, grouped by query shape , that were run against a collection that would benefit from the suggested index. The Performance Advisor does not negatively affect the performance of your Cloud Manager clusters.

{ <option1>: <value1>, ... }

{ unique: true, name: "myUniqueIndex" }

{ "locale": "fr" }

Frequently Asked Questions¶

This document addresses common questions about Cloud Manager and its use.

Project Administration

Find answers to common questions about how to administer Cloud Manager users, organizations, and projects.

Automation

Find answers to common questions about automating the deployment of MongoDB instances.

Backup and Restore

Find answers to common questions about backing up and restoring MongoDB databases and collections with Cloud Manager.

Billing

Find answers to common questions about Cloud Manager billing.

Monitoring and Alerts

Find answers to common questions about monitoring your MongoDB instances with Cloud Manager and how Cloud Manager alerts you about issues.

MongoDB Agent

Find answers to common questions about how Cloud Manager uses a new, single Agent.

MongoDB 3.2 Automation End of Life

Find answers to common questions about how you can mitigate the impact of the end Cloud Manager Automation support for MongoDB 3.2.

MongoDB 3.4 Automation End of Life

Find answers to common questions about the end of Cloud Manager Automation support for MongoDB 3.4.