Kafka type

The kafka type is used for Kafka communications.

Basic settings tab

Setting

Description

Name

Required setting.

Unique name of the resource. Must contain 1 to 128 Unicode characters.

Tenant

Required setting.

The name of the tenant that owns the resource.

The State toggle switch

Used when events must be sent to the destination.

By default, sending events is enabled.

Type

Required setting.

Destination type, kafka.

URL

Required setting.

URL that you want to connect to. Available formats: host:port, IPv4:port, :port. IPv6 addresses are also supported, however, when you use them, you must specify the interface as well: [address%interface]:port.
Example: [fe80::5054:ff:fe4d:ba0c%eth0]:4222).

You can add multiple addresses using the URL button.

Topic

Required setting.

Subject of Kafka messages. Must contain from 1 to 255 of the following characters: a–z, A–Z, 0–9, ".", "_", "-".

Delimiter

Specify a character that defines where one event ends and the other begins. By default, \n is used.

Authorization

Type of authorization when connecting to the specified URL Possible values:

  • disabled is the default value.
  • PFX — a certificate must be generated with a private key in PKCS#12 container format in an external Certificate Authority. Then the certificate must be exported from the key store and uploaded to the KUMA web interface as a PFX secret.
  • Add PFX secret
  • plain — you must indicate the secret containing user account credentials for authorization when connecting to the connector.

    Add secret

Description

Resource description: up to 4,000 Unicode characters.

Advanced settings tab

Setting

Description

Buffer size

Sets the size of the buffer.

The default value is 1 KB, and the maximum value is 64 MB.

Timeout

The time (in seconds) to wait for a response from another service or component.

The default value is 30.

Disk buffer size limit

Size of the disk buffer in bytes.

The default value is 10 GB.

Output format

Format for sending events to an external destination. Available values:

  • JSON
  • CEF

TLS mode

Use of TLS encryption. Available values:

  • Disabled (default) means TLS encryption is not used.
  • Enabled means encryption is used, but the certificate is not verified.
  • With verification means encryption is used with verification that the certificate was signed with the KUMA root certificate. The root certificate and key of KUMA are created automatically during program installation and are stored on the KUMA Core server in the folder /opt/kaspersky/kuma/core/certificates/.
  • Custom CA means encryption is used with verification that the certificate was signed by a Certificate Authority. The secret containing the certificate is selected from the Custom CA drop-down list, which is displayed when this option is selected.

    Creating a certificate signed by a Certificate Authority

    When using TLS, it is impossible to specify an IP address as a URL.

Delimiter

In the drop-down list, you can select the character to mark the boundary between events. By default, \n is used.

Buffer flush interval

Time (in seconds) between sending batches of data to the destination. The default value is 1 second.

Number of handlers

This field is used to set the number of services processing the queue. By default, this value is equal to the number of vCPUs of the KUMA Core server.

Debug

This toggle switch lets you specify whether resource logging must be enabled. The default value is Disabled.

Disk buffer disabled

Drop-down list that lets you enable or disable the disk buffer. By default, the disk buffer is enabled.

The disk buffer is used if the collector cannot send normalized events to the destination. The amount of allocated disk space is limited by the value of the Disk buffer size limit setting.

If the disk space allocated for the disk buffer is exhausted, events are rotated as follows: new events replace the oldest events written to the buffer.

Filter

In this section, you can specify the criteria for identifying events that must be processed by the resource. You can select an existing filter from the drop-down list or create a new filter.

Creating a filter in resources

Page top