Параметры Kafka#

Параметры создания сервиса#

Эти параметры указываются в качестве parameters в методе CreateService.

При создании нового сервиса нужно обязательно указать параметры, отмеченные как Необходимые.

Если выбранная версия Kafka поддерживает другие параметры, то их можно задать внутри параметра options.

version#

Устанавливаемая версия.

Необходимо

Тип данных

Допустимые значения

Да

String

3.6.1
3.7.0

monitoring#

Подключение к сервису мониторинга.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

По умолчанию

Для всех сервисов, кроме Prometheus

Есть

Boolean

true
false

false

monitorBy#

Идентификатор сервиса мониторинга. Указанный сервис должен быть развёрнут в том же проекте, что и текущий сервис.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Да, если передан параметр monitoring = true. Если monitoring = false, передача параметра невозможна

Есть

String

ID сервиса мониторинга, расположенного в том же VPC, что и текущий сервис

monitoringLabels#

Метки, которые будут назначены метрикам мониторируемого сервиса в сервисе мониторинга.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет. Если monitoring = false, передача параметра невозможна

Есть

Dict

Имя метки может содержать цифры, латинские буквы, символ подчёркивания. Значение метки может содержать любые ASCII-символы.

logging#

Подключение к сервису логирования.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

По умолчанию

Для всех сервисов, кроме ELK и Prometheus

Есть

Boolean

true
false

false

logTo#

Идентификатор сервиса логирования. Логируемый сервис должен быть развёрнут в том же проекте, что и текущий сервис.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

По умолчанию

Да, если передан параметр logging = true. Если logging = false, передача параметра невозможна

Есть

String

ID сервиса мониторинга, расположенного в том же VPC, что и текущий сервис

loggingTags#

Теги, которые будут назначены записям журнала текущего сервиса в сервисе логирования.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

По умолчанию

Нет. Если logging = false, передача параметра невозможна

Есть

List of strings

Строка не более 256 символов

options#

Контейнер для других параметров Kafka.

Примечание

Если имя параметра включает точку, то его нельзя передать в контейнере для дополнительных параметров. Свяжитесь с технической поддержкой, если вам необходимо использовать такой параметр.

Необходимо

Тип данных

Допустимые значения

Нет

Dict

N/A

Параметры создания и редактирования топика Kafka#

Эти параметры указываются в качестве parameters в методах CreateKafkaTopic и ModifyKafkaTopic.

При создании нового топика Kafka нужно обязательно указать все параметры, отмеченные как Необходимые. При изменении существующего топика Kafka нужно обязательно передать все параметры, для которых предусмотрена возможность редактирования. Если параметр не передан, то его значение будет очищено. Параметры, для которых редактирование недоступно, передавать не обязательно, но при их передаче значение должно соответствовать текущему.

partitions#

Количество разделов в топике.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Да

Есть

Integer

От 1 до числа узлов брокеров
При редактировании параметра нельзя уменьшить количество разделов в топиках

replicationFactor#

Количество реплик разделов.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Да

Есть

Integer

От 1 до числа узлов брокеров

cleanupPolicy#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

String

compact
delete
delete,compact

compressionType#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

String

uncompressed
zstd
lz4
snappy
gzip
producer

deleteRetentionMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

fileDeleteDelayMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

flushMessages#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

1–
9223372036854775807

flushMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

indexIntervalBytes#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
2147483647

maxCompactionLagMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

1–
9223372036854775807

maxMessageBytes#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
2147483647

messageTimestampAfterMaxMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

messageTimestampBeforeMaxMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

messageTimestampType#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

String

CreateTime
LogAppendTime

minCleanableDirtyRatio#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Float

0–1
с шагом 0.1

minCompactionLagMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

minInsyncReplicas#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

1–
2147483647

preallocate#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Boolean

true
false

retentionBytes#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

-1–
2147483647

retentionMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

-1–
9223372036854775807

segmentBytes#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

14–
2147483647

segmentIndexBytes#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

4–
2147483647

segmentJitterMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

0–
9223372036854775807

segmentMs#

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Есть

Integer

1–
9223372036854775807