Navigating the Canvas View

Let's get acquainted with the Canvas View user interface.

The Canvas View is the primary interface for building, editing, and monitoring pipelines.

About the Canvas View

When creating a pipeline in the Canvas View, you click the point in the pipeline where you want to add a function and then select from a list that shows valid functions only. You then configure the function by filling in fields that show all the accepted arguments for that function. The Canvas View automatically supplies default values for any optional arguments that you do not fill in, and also provides streamlined workflows for more advanced pipeline features such as branches and unions.

The following screenshot shows the different elements that appear in the Canvas View.

Label	Element	Description
A1	Splunk Cloud Services app menu	Switch between different Splunk Cloud Services apps or tenants. You can switch to the Splunk Cloud Console to manage the users, groups, and roles in your tenant.
A2	UI pages	Navigate to the following pages: Home: Check out the tutorial and product tour to get familiar with the Stream Processor Service, or review the latest feature updates and recently created pipelines on your tenant. Pipelines: Use this page to start creating a pipeline or manage existing pipelines. Connections: Use this page to create and manage connections to data sources and destinations. Lookups: Use this page to create and manage lookup tables for enriching event data.
A3	More Options	Access additional options for working Splunk Cloud Services: View details about the Stream Processor Service or your current tenant. Navigate to the Stream Processor Service documentation. Log out of Splunk Cloud Services.
A4	Pipeline name	The name of your pipeline.
A5	Pipeline state	The state of your pipeline. For a list of available states and what they mean, see Check the status of a pipeline.
A6	View/Edit	View or edit an activated pipeline. Changes are not applied to the activated pipeline until you save and reactivate the pipeline.
A7	Start Preview	Preview the data moving through the selected function in your pipeline. See Test your pipeline configuration with preview sessions.
A8	Save	Save your pipeline.
A9	Activate Pipeline	Activate your pipeline.
A10	Pipeline options	Access additional options for working with your pipeline: Validate the pipeline to confirm that your functions are configured correctly. Save a copy of the pipeline. Export the pipeline to save a backup copy of the pipeline. Import a pipeline to restore a backup copy of a pipeline. Revert the pipeline to a previous version. Deactivate the pipeline. Delete the pipeline. View the metadata associated with the pipeline.
A11	Pipeline canvas	A canvas space that shows a graphical representation of your pipeline.
A12	Function	The basic building block of a pipeline.
A13	Zoom In/Out	Zoom in or out on the pipeline canvas.
A14	Edit function name	Assign a custom name to the selected function.
A15	View documentation	View the documentation for the selected function in another browser tab.
A16	Add a branch	Create a branch in your pipeline, and add a function to the newly created branch.
A17	Add a function	Add a function to your pipeline.
A18	Function metrics	Live metrics about the function, such as the number of events moving in or out of the function per second. You can use these metrics to quickly scan if your records are making it through your pipeline or to check the performance of your pipeline.
A19	View Configurations	View or modify the configuration of the selected function.
A20	Preview Results	View a sample of the events that are sent through the selected function.
A21	Display options for preview	Choose how to display the data that's collected during a preview session. You can display each record in a table, list, or raw JSON format, and specify the number of records to show per page.
A22	Search preview results	Search the preview results for records that contain a specified search term. You can adjust the search operation to only return records where a specific field contains the search term.