Skip to main content

Data Routers

Processors allow you to change the shape and content of data. While pipes ensure the movement and continuous flow, processing adds functionality into the flow. In Processors you learned how to create a process. In this section you will assign the process to a pipe by creating a Router.

note

The screenshots, properties-panel steps, and flow-editing interactions from Creating the Pipe onward are from an earlier version of the Configuration page; the current capture below shows the diagram's columns, ports and connection lines but not those editing steps, so re-verify them against the current product.

Routers on the Configuration page

Routers are the middle of the three columns on Platform → ConfigurationSources (left), Routers (middle), and Sinks (right), read left to right in the direction data flows.

Configurations page showing the pipeline diagram with source, router, and sink columns connected by flow lines

Each router card lists the pipes it runs. A pipe row shows the pipe name and its processor count, for example (1 procs). Routers that are actively moving data are outlined in green and display a small green throughput graph above the card's upper-right corner; idle routers have a gray outline and no graph. A router in error is outlined in red and marked with an exclamation mark above the card.

Small circular ports sit on the edges of each card. Colored lines run from a source's output port to the router's input port, and from each router pipe's output port to a sink, tracing the exact path events take through the platform. Line colors distinguish the individual flows where several cross.

Click Add Router + at the bottom of the Routers column to add a new router.

Creating the Pipe

Configuration page with the Add Router + button at the bottom of the Routers column

The properties window is on the far left. When clicking the "Add Router" button, that panel will request a name and description for the new router.

Router properties panel requesting a name and description for the new router

In this example, you are using the process created previously, called LinuxServer.

Processor selector in the router properties panel, with LinuxServer chosen

This will fill in the processor and name the overall router the same name. You can change the overall router name by unchecking "Use processor name as router." Doing that allows you to edit the "Name" field.

Router properties panel with Use processor name as router unchecked and a custom name entered

When you save this, the new router will appear to the right in the "Pipe Configuration" panel.

Pipe Configuration panel showing the newly saved router

You can see the processor in the pipe by clicking the "LinuxServer" process in the router called "LinuxServerExample."

LinuxServer processor selected inside the LinuxServerExample router

The processor is highlighted and this processor's data can be seen in the properties panel.

Properties panel showing the selected processor's details

As you can see, the processor is there but there is no data or histograms yet.

Connecting Data

In this example you are going to use a Data Source called "Syslog Endpoint." Syslog is a common data source. In this case you want to move an existing source that is turned on.

Changing the flow is as simple as deleting the current flow and then reassigning the new one. The full procedure is: disable the source, delete the old flow, draw the new flow, then re-enable the source.

Disable the source

If you are moving the flow from a source, you first need to turn the source off.

Configuration page with a source card selected

By clicking on the source in the Configuration panel, you will see a green plug to the left of the source name in the properties panel. Click this and accept turning it off.

The source will turn red when it is off, and the icon on the panel will have a red plug above it.

Properties panel showing the green plug control that disables the source

Delete the existing flow

At the start of a flow line in the diagram, there is a circle that marks its start.

Outgoing Flow Marker

With the source turned off, hover over the outgoing flow line and select it. The flow is highlighted, and a delete (trash) icon appears.

Delete Icon of a Flow

Clicking this will delete the flow. A confirmation box will appear if the flow deletion impacts operations.

Confirmation Box to Delete Flow

Confirm the deletion and the connection will be removed.

Create the new flow

Now you have a data source with no Router. This allows you to route the data somewhere else.

Start by selecting the source flow. This is done by clicking on the outgoing circle on the flow pipe.

Outgoing circle on the source card selected to start a new flow

Next, mouse over the destination — the incoming flow marker, the circle to the left of the process you want to connect. A dotted flow line will appear.

Dotted flow line drawn from the source's outgoing circle to the processor's incoming marker

Clicking the incoming marker will present a confirmation for the connection.

Confirmation of a new flow

Confirming will establish the connection.

Re-enable the source

There is one more step you need to do to get the data flowing into the process: turn on the data source. Remember you turned it off to create the connection.

Properties panel with the source being switched back on after the connection is made

Selecting the source you will see a red plug icon. Click that and accept turning on the source. It will change colors to green when the source is active again.