# Kafka REST Proxy

The **kafka-rest** output plugin, allows to flush your records into a [Kafka REST Proxy](http://docs.confluent.io/current/kafka-rest/docs/index.html) server. The following instructions assumes that you have a fully operational Kafka REST Proxy and Kafka services running in your environment.

## Configuration Parameters

| Key               | Description                                                                           | default           |
| ----------------- | ------------------------------------------------------------------------------------- | ----------------- |
| Host              | IP address or hostname of the target Kafka REST Proxy server                          | 127.0.0.1         |
| Port              | TCP port of the target Kafka REST Proxy server                                        | 8082              |
| Topic             | Set the Kafka topic                                                                   | fluent-bit        |
| Partition         | Set the partition number (optional)                                                   |                   |
| Message\_Key      | Set a message key (optional)                                                          |                   |
| Time\_Key         | The Time\_Key property defines the name of the field that holds the record timestamp. | @timestamp        |
| Time\_Key\_Format | Defines the format of the timestamp.                                                  | %Y-%m-%dT%H:%M:%S |
| Include\_Tag\_Key | Append the Tag name to the final record.                                              | Off               |
| Tag\_Key          | If Include\_Tag\_Key is enabled, this property defines the key name for the tag.      | \_flb-key         |

### TLS / SSL

Kafka REST Proxy output plugin supports TTL/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](https://github.com/fluent/fluent-bit-docs/tree/16f30161dc4c79d407cd9c586a0c6839d0969d97/pipeline/configuration/tls_ssl.md) section.

## Getting Started

In order to insert records into a Kafka REST Proxy service, you can run the plugin from the command line or through the configuration file:

### Command Line

The **kafka-rest** plugin, can read the parameters from the command line in two ways, through the **-p** argument (property), e.g:

```
$ fluent-bit -i cpu -t cpu -o kafka-rest -p host=127.0.0.1 -p port=8082 -m '*'
```

### Configuration File

In your main configuration file append the following *Input* & *Output* sections:

```python
[INPUT]
    Name  cpu
    Tag   cpu

[OUTPUT]
    Name        kafka-rest
    Match       *
    Host        127.0.0.1
    Port        8082
    Topic       fluent-bit
    Message_Key my_key
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fluentbit.io/manual/1.6/pipeline/outputs/kafka-rest-proxy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.