For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Docs Menu
Docs Home
/
Development
/
Atlas Stream Processing
Docs Home
/
Development
/
Atlas Stream Processing
Docs Home
/
Development
/
Atlas Stream Processing

Manage Stream Processing Workspaces

An Atlas Stream Processing workspace provides a context for all of your operations on streaming data. The procedures in this page walk you through creating and configuring your stream processing workspaces.

Prerequisites

To create and configure a stream processing workspace, you must have the following:

Considerations

You must set a default tier when you create a stream processing workspace. Stream processors that you create in this workspace default to this tier. You can optionally set a max tier size as well. You can't create stream processors larger than the max tier in this workspace.

Defaults:

  • default tier: SP10

  • max tier size: unset

You can configure the default and max stream processing workspace tiers only from the Atlas control plane (UI, API, Terraform, or CLI). You can't configure the default and tiers from the data plane (mongosh).

View stream processing workspaces

To view your stream processing workspaces:

To list all stream processing workspaces in the project you specify using the Atlas CLI, run the following command:

atlas api streams listStreamWorkspaces [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas api streams listStreamWorkspaces.

1

In Atlas, go to the Stream Processing page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Streaming Data heading.

The Stream Processing page displays.

The Atlas Administration API provides different endpoints for retrieving one or all stream processing workspaces.

Return One Stream Workspace

List All Stream Workspaces

Create a stream processing workspace

To create a new stream processing workspace:

To create one stream processing workspace in the project you specify using the Atlas CLI, run the following command:

atlas api streams createStreamWorkspace [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas api streams createStreamWorkspace.

1

In Atlas, go to the Stream Processing page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Streaming Data heading.

The Stream Processing page displays.

2

Create your stream processing workspace.

  1. Click Create workspace in the upper right corner.

  2. Configure your new stream processing workspace.

    1. Select a default tier.

    2. Enter a string for the Workspace Name. Each stream processing workspace name must be unique within a project.

    3. (Optional) Set a max tier size.

    To learn more about default tier and max tier sizes, see Considerations.

    1. Select a Cloud Provider.

    2. Select a Region from the dropdown menu.

    3. (Optional) Select up to two failover regions from the Regional Failover dropdown menu.

    4. Click Create.

The Atlas Administration API provides an endpoint for creating a stream processing workspace.

Create One Stream Workspace

Delete a stream processing workspace

To delete a stream processing workspace:

To delete one stream processing workspace in the project you specify using the Atlas CLI, run the following command:

atlas api streams deleteStreamWorkspace [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas api streams deleteStreamWorkspace.

1

In Atlas, go to the Stream Processing page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Streaming Data heading.

The Stream Processing page displays.

2

Delete the stream processing workspace.

  1. Locate the overview panel of the stream processing workspace you want to delete

  2. Click the ellipsis ... icon in the upper-right.

  3. Click Delete workspace.

  4. When prompted, type the name of the stream processing workspace in the text field.

  5. Click Delete.

The Atlas Administration API provides an endpoint for deleting a stream processing workspace.

Delete One Stream Workspace

Edit a stream processing workspace

To edit an stream processing workspace:

To update one stream processing workspace in the project you specify using the Atlas CLI, run the following command:

atlas api streams updateStreamWorkspace [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas api streams updateStreamWorkspace.

The Atlas Administration API provides an endpoint for editing a stream processing workspace.

Update One Stream Workspace

Trigger stream processing workspace Failover

Atlas Stream Processing supports processor failover at the workspace level. When you trigger workspace-level failover, all stream processors within that workspace shift processing to their configured failover processors simultaneously.

To update one stream processing workspace in the project you specify using the Atlas CLI, run the following command:

atlas api streams updateStreamWorkspace [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas api streams updateStreamWorkspace.

1

In Atlas, go to the Stream Processing page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Streaming Data heading.

The Stream Processing page displays.

2

Initiate failover.

  1. Locate the overview panel of the stream processing workspace for which you want to initiate failover.

  2. Click the Manage button in the upper-right.

  3. Ensure you are on the Stream Processors management page.

  4. Click the ellipsis button . . . in the upper-right. From the dropdown menu, select Failover all processors.

  5. In the modal window, under the Select failover regions heading, click the name of the region to which you want to failover.

  6. In the modal window, select the failover type. To perform a Forced failover, type Force in the confirmation prompt. For a Forced failover, select Clear checkpoint to skip resuming from the most recent checkpoint. By default, this checkbox is cleared.

  7. Click the Activate [TYPE] failover button, where [TYPE] is your chosen failover type.

To initiate failover for all stream processors in a workspace, use the Update One Stream Workspace Options endpoint. Provide the following key-value pairs in the request body:

Key
Value

status

"FAILED_OVER"

region

The name of the region to which you want to initiate failover.

Download Audit Logs

To download your stream processing workspace audit logs:

To download audit logs for one stream processing workspace you specify using the Atlas CLI, run the following command:

atlas api streams downloadAuditLogs [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas api streams downloadAuditLogs.

1

In Atlas, go to the Stream Processing page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Streaming Data heading.

The Stream Processing page displays.

2

Click . From the dropdown menu, select Audit Logs.

3

In the modal window, select a Time Period from the dropdown menu. This value determines the logging interval used to delimit events in the downloadable log file.

4

Click Download Logs.

The Atlas Administration API provides an endpoint for creating a stream processing workspace.

Download Audit Logs for One Atlas Stream Processing Workspace

Back
Stream Processor Windows
Next
Manage Connections
Rate this page

On this page