Kafka

Permite a configuração de um tópico Kafka que receberá as mensagens trafegadas.

Parâmetros

Parâmetros aceitos para esse tipo de sindicância de destino:

Campo	Descrição	Valor
kafka.topic	Tópico que receberá as mensagens	Tipo: string Obrigatório
kafka.tls	Configuração de TLS	Tipo: object Obrigatório
kafka.tls.enabled	Habilitar TLS	Tipo: enum[true false] Obrigatório
kafka.tls.skip_cert_verify	Ignorar verificação de certificado	Tipo: enum[true false] 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 '{
    "output": {
        "target": "my-topic",
        "type": "KAFKA",
        "kafka": {
          "topic": "TOPIC",
          "tls": {
            "enabled": "true",
            "skip_cert_verify": "true"
          },
          "sasl": {
            "mechanism": "PLAIN",
            "user": "USER",
            "password": "PASSWORD"
          }
        }
    }
}'

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",
  "output": {
    "target": "my-topic",
    "type": "KAFKA",
    "kafka": {
      "topic": "TOPIC",
      "tls": {
        "enabled": "true",
        "skip_cert_verify": "true"
      },
      "sasl": {
        "mechanism": "*",
        "user": "*",
        "password": "*"
      }
    }
  }
}

Um token de verificação Firehose-Verify-Token, passado na configuração do Firehose, será adicionado como o atributo firehose_id nos metadados da mensagem.