Contents

Connector, kafka type

Connector, kafka type

Expand all | Collapse all

Connectors of the kafka typeUsed for communicating with the Apache Kafka data bus when working with Windows and Linux agents. Settings for a connector of the kafka type are described in the following tables.

Basic settings tab

Setting	Description
Name	Unique name of the resource. The maximum length of the name is 128 Unicode characters. Required setting.
Tenant	The name of the tenant that owns the resource. Required setting.
Type	Connector type: kafka. Required setting.
Tags	Tags for resource search. Optional setting.
URL	URL that you want to connect to. The following URL formats are supported: `<host name>:<port number>` `<IPv4 address>:<port number>` `<IPv6 address>:<port number>` You can specify IPv6 addresses in the following format: `[<IPv6 address>%<interface>:<port number>`, for example, `[fe80::5054:ff:fe4d:ba0c%eth0]:4222`. You can add multiple URLs or remove an URL. To add an URL, click the + Add button. To remove an URL, click the delete icon next to it. Required setting.
Authorization	Type of authorization when connecting to the URL specified in the URL field: Disabled. This value is selected by default. Plain. If this option is selected, in the Secret drop-down list, specify the secret containing user account credentials for authorization when connecting to the destination. You can select an existing secret or create a new secret. To create a new secret, select Create new. If you want to edit the settings of an existing secret, click the pencil icon next to it. How to create a secret? To create a secret: In the Name field, enter the name of the secret. In the User and Password fields, enter the credentials of the user account that the Agent will use to connect to the connector. If necessary, enter a description of the secret in the Description field. Click the Create button. The secret is added and displayed in the Secret drop-down list. PFX means TLS encryption with a PFX secret. You must generate a PFX certificate with a private key in PKCS#12 container format in an external Certificate Authority, export the PFX certificate from the key store, and upload the PFX certificate to the KUMA Console as a PFX secret. If you select this value, in the PFX secret drop-down list, specify a PFX secret with a certificate signed by a certification authority. You can select an existing PFX secret or create a new PFX secret. To create a new PFX secret, select Create new. If you want to edit the settings of an existing secret, click the pencil icon next to it. How to create a PFX secret? To create a PFX secret: In the Name field, enter the name of the PFX secret. Click Upload PFX and select the PKCS#12 container file to which you exported the PFX certificate with the private key. In the Password field, enter the PFX certificate security password that was set in the PFX Certificate Export Wizard. Click the Create button. The PFX secret is created and displayed in the PFX secret drop-down list.
Topic	Subject of Kafka messages. The maximum length of the subject is 255 characters. You can use the following characters: a–z, A–Z, 0–9, ".", "_", "-". Required setting.
GroupID.	The value of the `GroupID` parameter for Kafka messages. Maximum length of the value: 255 characters. You can use the following characters: a–z, A–Z, 0–9, ".", "_", and "-".
Delimiter	The character that marks the boundary between events: \n \t \0 If you do not select a value in this drop-down list, \n is selected by default.
Description	Description of the resource. The maximum length of the description is 4000 Unicode characters.

Advanced settings tab

Setting	Description
Debug	Ths switch enables resource logging. The toggle switch is turned off by default.
Number of handlers	Number of handlers that the service can run simultaneously to process response rules in parallel. To determine the number of handlers, you can use the following formula: (<number of CPUs> / 2) + 2. The value must be a positive integer.
Character encoding	Character encoding. The default is UTF-8.
TLS mode	TLS encryption mode. When using TLS encryption, you cannot specify an IP address in the URL field on the Basic settings. Available values: Disabled means TLS encryption is not used. This value is selected by default. Enabled means TLS encryption is used, but certificates are not verified. With verification means TLS encryption is used with verification of the certificate signed with the KUMA root certificate. The root certificate and key of KUMA are created automatically during application installation and are stored on the KUMA Core server in the /opt/kaspersky/kuma/core/certificates/ directory. Custom CA means TLS encryption is used with verification that the certificate was signed by a Certificate Authority. If you select this value, in the Custom CA drop-down list, specify a secret with a certificate signed by a certification authority. You can select an existing secret or create a new secret. To create a new secret, select Create new. If you want to edit the settings of an existing secret, click the pencil icon next to it. How to create a certificate signed by a Certificate Authority? You can create a CA-signed certificate on the KUMA Core server (the following command examples use OpenSSL). To create a certificate signed by a Certificate Authority: Generate a key to be used by the Certificate Authority, for example: `openssl genrsa -out ca.key 2048` Create a certificate for the generated key, for example: `openssl req -new -x509 -days 365 -key ca.key -subj "/CN=<common host name of Certificate Authority>" -out ca.crt` Create a private key and a request to have it signed by the Certificate Authority, for example: `openssl req -newkey rsa:2048 -nodes -keyout server.key -subj "/CN=<common host name of KUMA server>" -out server.csr` Create the certificate signed by the Certificate Authority. You need to include the domain names or IP addresses of the server for which you are creating the certificate in the `subjectAltName` variable, for example: `openssl x509 -req -extfile <(printf "subjectAltName=DNS:domain1.ru,DNS:domain2.com,IP:192.168.0.1") -days 365 -in server.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out server.crt` Upload the created `server.crt` certificate in the KUMA Console to a secret of the certificate type, then in the Custom CA drop-down list, select the secret of the certificate type. To use KUMA certificates on third-party devices, you must change the certificate file extension from CERT to CRT. Otherwise, you can get the `x509: certificate signed by unknown authority` error.
Size of message to fetch	Size of one message in the request, in bytes. The default value of 16 MB is applied if no value is specified or 0 is specified.
Maximum fetch wait time	Timeout for one message in seconds. The default value of 5 seconds is applied if no value is specified or 0 is specified.
Connection timeout	Kafka broker connection timeout in seconds. Maximum possible value: 2147483647. The default value is 30 seconds.
Read timeout	Read operation timeout in seconds. Maximum possible value: 2147483647. The default value is 30 seconds.
Write timeout	Write operation timeout in seconds. Maximum possible value: 2147483647. The default value is 30 seconds.
Group status update interval	Group status update interval in seconds Cannot exceed session time. The recommended value is 1/3 of the session time. Maximum possible value: 2147483647. The default value is 30 seconds.
Session time	Session time in seconds. Maximum possible value: 2147483647. The default value is 30 seconds.
Maximum time to process one message	Maximum time to process one message by a single thread, in milliseconds. Maximum possible value: 2147483647. The default value is 100 milliseconds.
Enable autocommit	Enabled by default.
Autocommit interval	Autocommit interval in seconds The default value is 1 second. Maximum possible value: 18446744073709551615. Any positive number can be specified.