Bring Your Own Code

Most recent version: v0.0.1

PreviousAnonymizer NextField Generator

Last updated 15 days ago

Was this helpful?

Ports

These are the input and output ports of this Action:

Input ports

Default port - All the events to be processed by this Action enter through this port.

Output ports

Default port - Events are sent through this port if no error occurs while processing them.
Error port - Events are sent through this port if an error occurs while processing them.

Configuration

To open the configuration, click the Action in the canvas and select Configuration.

Enter the required parameters:

Configuration

To indicate where you want to execute your code, you must either choose a Docker client instance or enter its corresponding IP/port in the configuration options below.

Parameter

Description

Docker client

Choose one of the available Docker instances to execute your code.

Enter the instance IP to execute your code.

Port

Enter the instance port to execute your port.

Timeout connection

Enter the milliseconds to wait for the Docker connection.

Buffer size

Size in bytes to batch events.

Code

In future updates of this Action, you'll be able to update your code as a .zip file. This option is currently not available

Paste your Python File in this area. You can include any required Dependencies in the corresponding tab.

AI Assistant

You can use the AI Assistant to generate the Python code you require. Simply click the icon at the bottom of the configuration menu and enter the prompt that indicates the results that you need.

Finally, give your Output Field a name. Click Add field if you need to add any additional fields.

Click Save to complete.

Overview

The Bring Your Own Code Action enables dynamic execution of user-provided Python code in isolated environments in an Onum pipeline. This way, you can use your own Python code to enrich or reduce your events directly.

In order to configure this Action, you must first link it to a Listener or another Action. Go to to learn how this works.

Ports

These are the input and output ports of this Action:

Input ports

Default port - All the events to be processed by this Action enter through this port.

Output ports

Default port - Events are sent through this port if no error occurs while processing them.
Error port - Events are sent through this port if an error occurs while processing them.

Configuration

Find Bring Your Own Code in the Actions tab (under the Advanced group) and drag it onto the canvas. Link it to the required and .

To open the configuration, click the Action in the canvas and select Configuration.

Enter the required parameters:

Configuration

To indicate where you want to execute your code, you must either choose a Docker client instance or enter its corresponding IP/port in the configuration options below.

Parameter

Description

Docker client

Choose one of the available Docker instances to execute your code.

Enter the instance IP to execute your code.

Port

Enter the instance port to execute your port.

Timeout connection

Enter the milliseconds to wait for the Docker connection.

Buffer size

Size in bytes to batch events.

Code

In future updates of this Action, you'll be able to update your code as a .zip file. This option is currently not available

Paste your Python File in this area. You can include any required Dependencies in the corresponding tab.

AI Assistant

You can use the AI Assistant to generate the Python code you require. Simply click the icon at the bottom of the configuration menu and enter the prompt that indicates the results that you need.

Learn more about our AI Assistant in .

Finally, give your Output Field a name. Click Add field if you need to add any additional fields.

Click Save to complete.