Syslog TCP Source properties reference

The properties listed in this reference must be added to the connector configuration with the following prefix:

parameter.[***CONNECTOR NAME***] Parameters:

In addition to the properties listed here, this connector also accepts certain properties of the Kafka Connect framework as well as the properties of the NiFi Stateless Source connector. When creating a new connector using the SMM UI, all valid properties are presented in the default configuration template. You can view the configuration template to get a full list of valid properties. In addition, for more information regarding the accepted properties not listed here, you can review the Apache Kafka documentation and the Stateless NiFi Source properties reference.

Authorized Issuer DN Pattern

Description: A regular expression that can be applied against the Issuer's Distinguished Name of incoming TLS connections.
Default Value: .*
Accepted Values
Required: false

Authorized Subject DN Pattern

Description: A regular expression that can be applied against the Subject's Distinguished Name of incoming TLS connections.
Default Value: .*
Accepted Values
Required: false

Character Set

Description: The character set used in the input as well as the output data.
Default Value: UTF-8
Accepted Values
Required: true

Client Authentication

Description: The client authentication policy used for SSL.
Default Value: REQUIRED
Accepted Values: NONE, WANT, REQUIRED
Required: true

Date Format

Description: Specifies the format used for writing date fields if the Output Format is JSON. Otherwise this parameter is not used.
Default Value: yyyy-MM-dd
Accepted Values
Required: true

Grok Expression

Description: Specifies the format of a line in Grok format. This allows the connector to understand how to parse each line in the input file. If a line in the file does not match this pattern, the line is handled according to the Grok No Match Behavior. A valid Grok expression must be specified using this property even if Grok format is not used.
Default Value: %{GREEDYDATA:message}
Accepted Values
Required: true

Grok No Match Behaviour

Description

Specifies how to handle lines that do not match the pattern set in the Grok Expression property.

If set to append-to-previous-message, non-matching lines are appended to the last field of the previous message.
If set to skip-line, non-matching lines are skipped. If set to raw-line, non-matching lines are only added to the _raw field.

Default Value

append-to-previous-message

Accepted Values

append-to-previous-message, skip-line, raw-line

Required

true

Input Data Format

Description: The format of incoming messages.
Default Value: Syslog 3164
Accepted Values: Syslog 3164, Syslog 5424, Grok
Required: true

Kerberos Keytab for Schema Registry

Description: The fully-qualified filename of the kerberos keytab associated with the principal for accessing Schema Registry.
Default Value: The location of the default keytab which is empty and can only be used for unsecure connections.
Accepted Values
Required: true

Kerberos Principal for Schema Registry

Description: The Kerberos principal used for authenticating to Schema Registry.
Default Value: default
Accepted Values
Required: true

Max Batch Size

Description: The maximum number of messages to add to a single batch of messages. If multiple messages are available, they are concatenated with a new line character up to this configured maximum number of messages.
Default Value: 1
Accepted Values
Required: true

Max Number of Worker Threads

Description: he maximum number of worker threads available for handling TCP connections.
Default Value: 2
Accepted Values
Required: true

Output Format

Description: The format of the messages written to Kafka.
Default Value: AVRO
Accepted Values: TEXT, AVRO, JSON
Required: true

Output Grouping for JSON

Description

Specifies how JSON objects are grouped in the connector output.

If set to output-array, the output will consist of an array of JSON objects.
If set to output-oneline, each line of the output data will be one JSON object. That is, each JSON object occupies one line in the output.

Default Value

output-oneline

Accepted Values

output-array, output-oneline

Required

true

Port

Description: The port to listen on for communication.
Type: int
Default Value
Accepted Values
Required: true

SSL Keystore Filename

Description: The fully-qualified filename of a keystore. This keystore is used to establish a secure connection between this connector and its clients using SSL.
Default Value
Accepted Values
Required: true

SSL Keystore Key Password

Description: The password used to access the key stored in the keystore file configured in SSL Keystore Filename.
Default Value
Accepted Values
Required: true

SSL Keystore Password

Description: The password used to access the contents of the keystore configured in the SSL Keystore Filename property.
Default Value
Accepted Values
Required: true

SSL Keystore Type

Description: The type of the keystore configured in the SSL Keystore Filename property.
Default Value
Accepted Values: BCFKS, PKCS12, JKS
Required: true

SSL Truststore Filename

Description: The fully-qualified filename of a truststore. It can be used for establishing connections using mutual TLS. When using one-way SSL (Client Authentication parameter set to NONE), this parameter must be removed completely from the configuration JSON.
Default Value
Accepted Values
Required: false

SSL Truststore Password

Description: The password used to access the contents of the truststore configured in the SSL Truststore Filename property. When using one-way SSL (Client Authentication parameter set to NONE), this parameter must be removed completely from the configuration JSON.
Default Value
Accepted Values
Required: false

SSL Truststore Type

Description: The type of the truststore configured in the SSL Truststore Filename property. When using one-way SSL (Client Authentication parameter set to NONE), this parameter must be removed completely from the configuration JSON.
Default Value
Accepted Values: BCFKS, PKCS12, JKS
Required: false

Schema Access Strategy

Description

Specifies the strategy used for determining the schema of the input message. This property only takes effect if the input data format is GROK or if the output data format is AVRO.

If input is GROK and this property is set to Schema Registry, schemas are read from Schema Registry.
If input is GROK and this property is set to Field Names from Grok Expression. The schema is determined using the field names in the Grok Expression property.
If output is AVRO and this property is set to Schema Registry, schemas are not embedded in the output AVRO file. This behaviour is true even if Schema Registry is not used.
If output is AVRO and this property is set to any string other than Schema Registry, schemas are embedded in the output AVRO file.

Default Value

Schema Registry

Accepted Values

Schema Registry, Field Names From Grok Expression

Required

true

Schema Branch

Description: The name of the branch to use when looking up the schema in Schema Registry. Schema Branch and Schema Version cannot be specified at the same time. If one is specified, the other needs to be removed from the configuration. If Schema Registry is not used, this property must be completely removed from the configuration.
Default Value
Accepted Values
Required: false

Schema Name

Description

The schema name to look up in Schema Registry.

If the Schema Access Strategy property is set to Schema Registry, this property must contain a valid schema name.
If Schema Registry is not used, this property must be completely removed from the configuration JSON.

Default Value

Accepted Values

Required

false

Schema Registry URL

Description: The URL of the Schema Registry server. If Schema Registry is not used, use the default value.
Default Value: http://localhost:7788/api/v1
Accepted Values
Required: true

Schema Version

Description: The version of the schema to look up in Schema Registry. If Schema Registry is used and a schema version is not specified, the latest version of the schema is retrieved. Schema Branch and Schema Version cannot be specified at the same time. If one is specified, the other needs to be removed from the configuration. If Schema Registry is not used, this property must be completely removed from the configuration.
Default Value
Accepted Values
Required: false

Time Format

Description: Specifies the format used for writing time fields if the Output Format is JSON. Otherwise this parameter is not used.
Default Value: HH:mm:ss
Accepted Values
Required: true

Timestamp Format

Description: Specifies the format used for writing timestamp fields if the Output Format is JSON. Otherwise this parameter is not used.
Default Value: yyyy-MM-dd HH:mm:ss.SSS
Accepted Values
Required: true

Truststore Filename for Schema Registry

Description: The fully-qualified filename of a truststore. This truststore is used to establish a secure connection with Schema Registry using TLS.
Default Value: The location of the default truststore which is empty and can only be used for unsecure connections.
Accepted Values
Required: true

Truststore Password for Schema Registry

Description: The password used to access the contents of the truststore configured in the Truststore Filename for Schema Registry property.
Default Value: password
Accepted Values
Required: true

Truststore Type for Schema Registry

Description: The type of the truststore configured in the Truststore Filename for Schema Registry property.
Default Value: JKS
Accepted Values: BCFKS, PKCS12, JKS
Required: true