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:
An Atlas project
An Atlas user with the
Project Owner, theProject Stream Processing Owner, or theProject Data Access Adminrole to manage a Stream Processing Workspace.Note
While the
Project Owner,Project Stream Processing Owner, andProject Data Access Adminroles all grant the privileges to create, view, edit and delete stream processing workspaces, theProject Ownerrole also allows users to perform tasks such as creating database deployments, managing project access, and more.See Project Roles to learn more about the differences between these roles.
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:
SP10max 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.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
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.
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.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
Create your stream processing workspace.
Click Create workspace in the upper right corner.
Configure your new stream processing workspace.
Select a default tier.
Select a Cloud Provider.
Select a Region from the dropdown menu.
Enter a string for the Workspace Name. Each stream processing workspace name must be unique within a project.
(Optional) Set a max tier size.
To learn more about default tier and max tier sizes, see Considerations.
Click Create.
The Atlas Administration API provides an endpoint for creating a stream processing 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.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
The Atlas Administration API provides an endpoint for deleting a stream processing 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.
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.
In Atlas, go to the Stream Processing page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Stream Processing under the Streaming Data heading.
The Stream Processing page displays.
Click . From the dropdown menu, select Audit Logs.
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.
The Atlas Administration API provides an endpoint for creating a stream processing workspace.
Download Audit Logs for One Atlas Stream Processing Workspace