Kafka

Permite a configuração de um tópico Kafka de onde as mensagens serão consumidas.

Parâmetros

Parâmetros aceitos para esse tipo de entrada:

CampoDescriçãoValor

kafka.addresses

Endereços do cluster

Tipo: []string Obrigatório

kafka.topics

Tópicos para consumo das mensagens

Tipo: []string Obrigatório

kafka.consumer_group

Grupo de consumo

Tipo: string Obrigatório

kafka.tls

Configuração de TLS

Tipo: object Obrigatório

kafka.tls.enabled

Habilitar TLS

Tipo: boolean Obrigatório

kafka.tls.skip_cert_verify

Ignorar verificação de certificado

Tipo: boolean Obrigatório

kafka.sasl

Configuração de autenticação

Tipo: object Obrigatório

kafka.sasl.mechanism

Mecanismo de autenticação

Tipo: enum[NONE PLAIN] Obrigatório

kafka.sasl.user

Identificador de acesso

Tipo: string Obrigatório se mechanism = PLAIN

kafka.sasl.password

Senha de acesso

Tipo: string Obrigatório se mechanism = PLAIN

Requisição

curl --location '<HOST>/v1/configs' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <ACCESS-TOKEN>' \
  --data '{
    "input": {
      "type": "KAFKA",
      "kafka": {
        "addresses": [
          "ADDRESS"
        ],
        "topics": [
          "TOPIC"
        ],
        "tls": {
          "enabled": "true",
          "skip_cert_verify": "true"
        },
        "sasl": {
          "mechanism": "PLAIN",
          "user": "USER",
          "password": "PASSWORD"
        }
      }
    },
    "output": {...}
  }'

Obs: Caso a credencial de conexão seja uma connection string é possível se autenticar configurando o campo user como $ConnectionString e passando a connection string no campo password.

Resposta

A resposta desse endpoint será no seguinte formato:

{
  "id": "FIREHOSE-ID",
  "input": {
    "type": "KAFKA",
    "kafka": {
      "addresses": [
        "ADDRESS"
      ],
      "topics": [
        "TOPIC"
      ],
      "tls": {
        "enabled": "true",
        "skip_cert_verify": "true"
      },
      "sasl": {
        "mechanism": "*",
        "user": "*",
        "password": "*"
      }
    }
  },
  "output": {...}
}

Last updated