Kafka Inputs

Enter a descriptive name for this input. 

When you create a workflow, you will use this label to enter your input into the workflow. 

This parameter is required.

Review the following example:

- labels: "my-kafka-events"

Enter your Kafka broker address.

This parameter is required.

Review the following example:

endpoint: "something-tls"

Enter your Kafka topic name.

This parameter is required.

Review the following example:

topic: "topic"

Enter a consumer group within the specified topic name. 

This parameter is required.

Review the following example:

group_id: "my-group"

Select an existing filter to add to this input. 

To learn more, see Filters.

This parameter is optional. 

Review the following example: 

filters: 
   - info 

source_detection:

   source_type

Enter a source type.

Within inputs, a source type tells the Edge Delta agent which specific stream to monitor and extra logs from.

You can select (or enter) Docker, ECS, File, K8s. or Custom. 

This parameter is optional. 

Review the following example: 

source_detection:
  source_type: "K8s"

source_detection:

   optional

Enter true or false to ingest (or discard) logs with a failed source detection. 

Enter true to ingest logs with the original source information, despite a failed source detection.

Enter false to discard logs with a failed source detection.

This parameter is optional. 

Review the following example: 

optional: false

source_detection:

  processing_mode

There are 2 types of processing modes:

• json
• regex

If you enter json, then you must enter the JSON path as a value for each field mapping. 

If you enter regex, then you must enter a regex pattern with one capturing group named field, such as

• "path (?P<field>\w+)" 

This parameter is optional. 

Review the following example:

source_detection:
        source_type: "Custom"
        optional: false
        processing_mode: regex
        field_mappings:
          namespace: namespace (?P<field>\w+)
          serviceName: service (?P<field>\w+)
          roleName: user_role (?P<field>\w+)
          systemType: system (?P<field>\w+)

source_detection:

   field_mappings

This parameter is optional. 

Review the following example: 

source_detection:
  field_mappings:
    namespace: "kubernetes.namespace"
    serviceName: "service"
    roleName: "user.role"
    systemType: "system"

sasl:

  username

Enter your Kafka SASL username.

This parameter is optional.

Review the following example:

sasl:
  username: kafka_username

sasl:

  password

Enter your Kafka SASL password.

This parameter is optional.

Review the following example:

sasl:
  password: p@ssword123

sasl:

  mechanism

Enter a Kafka SASL mechanism type to implement a secure authentication.

You can enter: 

• PLAIN
• SCRAM-SHA-256
• SCRAM-SHA-512

This parameter is optional.

Review the following example:

sasl:
  mechanism: PLAIN 

tls:

  disable_verify

To disable a TLS verification of a certificate:

• In the visual editor, select True.
• In the YAML file, enter: disable_verify: true.

To enable a TLS verification of the certificate:

• In the visual editor, select False.
• In the YAML file, you can enter disable_verify: false or you can remove this line entirely. 

This parameter is optional. 

Review the following example: 

tls:
  disable_verify: true

tls:

  ca_file

Enter the absolute file path to the CA certificate file.

This parameter is optional. 

Review the following example: 

tls:
  ca_file: /var/etc/kafka

tls:

  ca_path

Enter the absolute path to scan the CA certificate file.

This parameter is optional. 

Review the following example: 

tls:
  ca_path: /certs/ca.pem

tls:

  crt_file

Enter the absolute path to the certificate file. 

This parameter is optional. 

Review the following example: 

tls:
  crt_file: /certs/server-cert.pem

tls:

  key_file

Enter the absolute path to the private key file. 

This parameter is optional. 

Review the following example: 

tls:
  key_file: /certs/server-key.pem

tls:

  key_password

Enter the password for the key file.

This parameter is optional. 

Review the following example: 

tls:
  key_password: p@ssword123

tls:

 client_auth_type

Select a client authorization type. 

You can select (or enter)

• noclientcert
• requestclientcert
• requireanyclientcert
• verifyclientcertifgiven
• requireandverifyclientcert

The default setting is noclientcert.

This parameter is optional. 

Review the following example: 

tls:
  client_auth_type: noclientcert

tls:

  min_version

Enter the minimum version of TLS to accept. 

This parameter is optional. 

Review the following example: 

tls:
  min_version: TLSv1_1

tls:

  max_version

Enter the maximum version of TLS to accept. 

This parameter is optional. 

Review the following example: 

tls:
  max_version: TLSv1_3