Skip to content

Bots From Extension: syslogs

Syslog Forwarder

This extension provides 3 bots.




Bot @syslogs:write-tcp

Bot Position In Pipeline: Sink

Send syslog messages to an IP Address & Port using Syslog TCP protocol. Adds a new column with status for forwarding action.

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
column* Text Name of the input column which has syslog messages
status_column Text status Name of the output column which will have forwarding status for each message
server* Text Syslog Server IP Address
port Text 514 Syslog Server Port. Default is 514
connect_retries Text 3 Max retries for connecting with server
connect_timeout Text 3.0 Max timeout in seconds for connection
connect_quite Text 60.0 Max seconds wait time after a set of failed connection retries.
max_idle_time Text 60.0 Maximum number of seconds to keep the connection open when not sending the data

Example Usage

1
2
3
4
5
6
7
  @files:loadfile
        filename = 'https://bot-docs.cloudfabrix.io/data/datasets/synthetic_syslogs_dataset.csv'
    --> @syslogs:write-tcp
        column = "message" &
        server = "192.168.10.10"  &
        port = 514  &
        status_column = "server1_fwd_status"






Bot @syslogs:write-tcp-json

Bot Position In Pipeline: Sink

Send syslog messages to an IP Address & Port using Syslog TCP protocol. Encodes each row as a single JSON object, appended by a new line. Adds a new column with status for forwarding action.

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
status_column Text status Name of the output column which will have forwarding status for each message
server* Text Syslog Server IP Address
port Text 514 Syslog Server Port. Default is 514
connect_retries Text 3 Max retries for connecting with server
connect_timeout Text 3.0 Max timeout in seconds for connection
connect_quite Text 60.0 Max seconds wait time after a set of failed connection retries.
max_idle_time Text 60.0 Maximum number of seconds to keep the connection open when not sending the data

Example Usage

1
2
3
4
5
6
  @files:loadfile
        filename = 'https://bot-docs.cloudfabrix.io/data/datasets/synthetic_syslogs_dataset.csv'
    --> @syslogs:write-tcp
        server = "192.168.10.10"  &
        port = 514  &
        status_column = "server1_fwd_status"






Bot @syslogs:write-udp

Bot Position In Pipeline: Sink

Send syslog messages to an IP Address & Port using Syslog UDP protocol

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
column* Text Name of the input column which has syslog messages
server* Text Syslog Server IP Address
port Text 514 Syslog Server Port. Default is 514

Example Usage

1
2
3
4
5
6
  @files:loadfile
        filename = 'https://bot-docs.cloudfabrix.io/data/datasets/synthetic_syslogs_dataset.csv'
    --> @syslogs:write-udp
        column = "message" &
        server = "192.168.10.10"  &
        port = 514