---
title: Kafka
summary: Fastly will upload log messages periodically to the server in the format specified in the Kafka object.
url: https://www.fastly.com/documentation/reference/api/logging/kafka
---

Fastly will upload log messages periodically to the server in the format specified in the Kafka object.

## Data model

| Field | Type | Description |
|-------|------|-------------|
| `auth_method` | string | SASL authentication method. |
| `brokers` | string | A comma-separated list of IP addresses or hostnames of Kafka brokers. Required. |
| `compression_codec` | string | The codec used for compression of your logs. |
| `parse_log_keyvals` | boolean | Enables parsing of key=value tuples from the beginning of a logline, turning them into <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers">record headers</a>. |
| `password` | string | SASL password. |
| `request_max_bytes` | integer | The maximum number of bytes sent in one request. Defaults <code>0</code> (no limit). |
| `required_acks` | integer | The number of acknowledgements a leader must receive before a write is considered successful. |
| `topic` | string | The Kafka topic to send logs to. Required. |
| `use_tls` | string | Whether to use TLS. |
| `user` | string | SASL user. |
| `format` | string | A Fastly <a href="https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/">log format string</a>. |
| `format_version` | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in <code>vcl_log</code> if <code>format_version</code> is set to <code>2</code> and in <code>vcl_deliver</code> if <code>format_version</code> is set to <code>1</code>. |
| `log_processing_region` | string | The geographic region where the logs will be processed before streaming. Valid values are <code>us</code>, <code>eu</code>, and <code>none</code> for global. |
| `name` | string | The name for the real-time logging configuration. |
| `placement` | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with <code>format_version</code> of 2 are placed in <code>vcl_log</code> and those with <code>format_version</code> of 1 are placed in <code>vcl_deliver</code>. |
| `response_condition` | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |
| `tls_ca_cert` | string | A secure certificate to authenticate a server with. Must be in PEM format. |
| `tls_client_cert` | string | The client certificate used to make authenticated requests. Must be in PEM format. |
| `tls_client_key` | string | The client private key used to make authenticated requests. Must be in PEM format. |
| `tls_hostname` | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |
| `created_at` | string | Date and time in ISO 8601 format. (Read-only) |
| `deleted_at` | string | Date and time in ISO 8601 format. (Read-only) |
| `service_id` | string | Alphanumeric string identifying the service. (Read-only) |
| `updated_at` | string | Date and time in ISO 8601 format. (Read-only) |
| `version` | string | String identifying a service version. (Read-only) |

## API endpoints

### List Kafka log endpoints

**GET** `/service/{service_id}/version/{version_id}/logging/kafka`

List all of the Kafka logging endpoints for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Create a Kafka log endpoint

**POST** `/service/{service_id}/version/{version_id}/logging/kafka`

Create a Kafka logging endpoint for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Get a Kafka log endpoint

**GET** `/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}`

Get the Kafka logging endpoint for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `logging_kafka_name` | string | path | Yes | The name for the real-time logging configuration. |
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Update the Kafka log endpoint

**PUT** `/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}`

Update the Kafka logging endpoint for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `logging_kafka_name` | string | path | Yes | The name for the real-time logging configuration. |
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Delete the Kafka log endpoint

**DELETE** `/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}`

Delete the Kafka logging endpoint for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `logging_kafka_name` | string | path | Yes | The name for the real-time logging configuration. |
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |