Skip to content

Commit 80880a0

Browse files
authored
Update topic properties (#529)
* JK-8526: Update topic properties * Last tweaks
1 parent af509bb commit 80880a0

File tree

1 file changed

+84
-38
lines changed

1 file changed

+84
-38
lines changed

docs/kafka/topic-configuration-kafka/README.adoc

Lines changed: 84 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Partitions are distinct lists of messages within a topic. Partitions are the mai
164164
[cols="25%,75%"]
165165
|===
166166
h|Editable
167-
|Yes (increase only)
167+
|Yes
168168

169169
h|Type
170170
|Integer
@@ -173,7 +173,7 @@ h|Default value
173173
|`1`
174174

175175
h|Supported values
176-
|[`1,...`]
176+
|1 or greater
177177

178178
h|Kafka property name
179179
|`num.partitions`
@@ -205,6 +205,8 @@ h|Type
205205
h|Default value
206206
|`3`
207207

208+
(For trial Kafka instances, the default value is `1`.)
209+
208210
h|Kafka property name
209211
|`replication.factor`
210212
|===
@@ -227,6 +229,8 @@ h|Type
227229
h|Default value
228230
|`2`
229231

232+
(For trial Kafka instances, the default value is `1`.)
233+
230234
h|Kafka property name
231235
|`min.insync.replicas`
232236
|===
@@ -247,10 +251,7 @@ h|Type
247251
|Long
248252

249253
h|Default value
250-
|`604800000 ms` (7 days)
251-
252-
h|Supported values
253-
| `milliseconds`, `seconds`, `days`, `months`, `years`, `Unlimited`
254+
|`604800000` (milliseconds, 7 days)
254255

255256
h|Kafka property name
256257
|`retention.ms`
@@ -272,10 +273,7 @@ h|Type
272273
|Long
273274

274275
h|Default value
275-
|`Unlimited`
276-
277-
h|Supported values
278-
| `bytes`, `kilobytes`, `megabytes`, `gigabytes`, `terabytes`, `Unlimited`
276+
|`-1` (no retention size limit)
279277

280278
h|Kafka property name
281279
|`retention.bytes`
@@ -301,7 +299,7 @@ h|Type
301299
|Integer
302300

303301
h|Default value
304-
|`1 MB`
302+
|`1048588` (bytes)
305303

306304
h|Kafka property name
307305
|`max.message.bytes`
@@ -345,18 +343,17 @@ h|Type
345343
|Long
346344

347345
h|Default value
348-
|`9223372036854775807 ms`
346+
|`9223372036854775807` (milliseconds)
349347

350348
h|Kafka property name
351349
|`message.timestamp.difference.max.ms`
352350
|===
353351
--
354352

355-
Compression type::
353+
Message format version::
356354
+
357355
--
358-
Compression type determines the final compression for the topic. The standard compression types are `gzip`, `snappy`, `lz4`, and `zstd`. Additional compression types include `Uncompressed`, which does not compress the topic, and `Producer`, which retains the original compression type set by the producer. By default, the compression type is set to `Producer`.
359-
356+
Message format version is the `ApiVersion` value that the broker uses to append messages to topics. This value must be a valid `ApiVersion` value, such as 0.10.0, 1.1, 2.8, or 3.0.
360357

361358
.Property attributes
362359
[cols="25%,75%"]
@@ -368,18 +365,40 @@ h|Type
368365
|String
369366

370367
h|Default value
371-
|`Producer`
368+
|`3.0-IV1`
372369

373370
h|Kafka property name
374-
|`compression.type`
371+
|`message.format.version`
375372
|===
376373
--
377374

375+
Message down-conversion::
376+
+
377+
--
378+
Message down-conversion determines whether the broker can convert the `message.format.version` property value to an older version for consumers that require an older message format version. By default, this property is enabled in order to avoid an `UNSUPPORTED_VERSION` error for consumption requests from older clients. If this property adds excessive load to your broker, you can disable it.
378379

379-
Message format version::
380+
.Property attributes
381+
[cols="25%,75%"]
382+
|===
383+
h|Editable
384+
|Yes
385+
386+
h|Type
387+
|Boolean
388+
389+
h|Default value
390+
|`true`
391+
392+
h|Kafka property name
393+
|`message.downconversion.enable`
394+
|===
395+
--
396+
397+
Compression type::
380398
+
381399
--
382-
Message format version is the `ApiVersion` value that the broker uses to append messages to topics. This value must be a valid `ApiVersion` value, such as 0.8.2, 0.9.0.0, or 0.10.0.
400+
Compression type determines the final compression for the topic. The standard compression types are `gzip`, `snappy`, `lz4`, and `zstd`. Additional compression types include `Uncompressed`, which does not compress the topic, and `Producer`, which retains the original compression type set by the producer. By default, the compression type is set to `Producer`.
401+
383402

384403
.Property attributes
385404
[cols="25%,75%"]
@@ -391,14 +410,13 @@ h|Type
391410
|String
392411

393412
h|Default value
394-
|`2.7-IV2`
413+
|`Producer`
395414

396415
h|Kafka property name
397-
|`message.format.version`
416+
|`compression.type`
398417
|===
399418
--
400419

401-
402420
=== Log
403421

404422
These properties define how your log is handled.
@@ -439,13 +457,13 @@ Delete retention time is the amount of time that deletion tombstone markers are
439457
[cols="25%,75%"]
440458
|===
441459
h|Editable
442-
|No
460+
|Yes
443461

444462
h|Type
445463
|Long
446464

447465
h|Default value
448-
|`86400000 ms` (1 day)
466+
|`86400000` (milliseconds, 1 day)
449467

450468
h|Kafka property name
451469
|`delete.retention.ms`
@@ -483,19 +501,41 @@ Minimum compaction lag time is the minimum time a message remains uncompacted in
483501
[cols="25%,75%"]
484502
|===
485503
h|Editable
486-
|No
504+
|Yes
487505

488506
h|Type
489507
|Long
490508

491509
h|Default value
492-
|`0 seconds`
510+
|`0` (milliseconds)
493511

494512
h|Kafka property name
495513
|`min.compaction.lag.ms`
496514
|===
497515
--
498516

517+
Maximum compaction lag time::
518+
+
519+
--
520+
Maximum compaction lag time is the maximum time a message remains uncompacted in a log. This property applies only when the topic cleanup policy is set to `Compact` or `Compact, Delete`.
521+
522+
.Property attributes
523+
[cols="25%,75%"]
524+
|===
525+
h|Editable
526+
|Yes
527+
528+
h|Type
529+
|Long
530+
531+
h|Default value
532+
|`9223372036854775807` (milliseconds)
533+
534+
h|Kafka property name
535+
|`max.compaction.lag.ms`
536+
|===
537+
--
538+
499539
=== Replication
500540

501541
These properties control the behavior of your replicas. Each of these properties impacts every replica created in the topic.
@@ -515,7 +555,7 @@ h|Type
515555
|Boolean
516556

517557
h|Default value
518-
|`Disabled`
558+
|`false`
519559

520560
h|Kafka property name
521561
|`unclean.leader.election.enable`
@@ -535,13 +575,16 @@ Log segment size is the size of the log segment files that constitute the log. L
535575
[cols="25%,75%"]
536576
|===
537577
h|Editable
538-
|No
578+
|Yes
539579

540580
h|Type
541581
|Integer
542582

543583
h|Default value
544-
|`1 GB`
584+
|`1073741824` (bytes)
585+
586+
h|Supported values
587+
| 52428800 bytes or greater
545588

546589
h|Kafka property name
547590
|`segment.bytes`
@@ -557,13 +600,16 @@ Segment time is the amount of time after which the current log segment is rolled
557600
[cols="25%,75%"]
558601
|===
559602
h|Editable
560-
|No
603+
|Yes
561604

562605
h|Type
563606
|Long
564607

565608
h|Default value
566-
|`604800000 ms` (7 days)
609+
|`604800000` (milliseconds, 7 days)
610+
611+
h|Supported values
612+
|600000 ms (10 mins) or greater
567613

568614
h|Kafka property name
569615
|`segment.ms`
@@ -585,7 +631,7 @@ h|Type
585631
|Long
586632

587633
h|Default value
588-
|`0 seconds`
634+
|`0` (milliseconds)
589635

590636
h|Kafka property name
591637
|`segment.jitter.ms`
@@ -607,7 +653,7 @@ h|Type
607653
|Long
608654

609655
h|Default value
610-
|`60000 ms` (1 minute)
656+
|`60000` (milliseconds, 1 minute)
611657

612658
h|Kafka property name
613659
|`file.delete.delay.ms`
@@ -629,7 +675,7 @@ h|Type
629675
|Boolean
630676

631677
h|Default value
632-
|`Disabled`
678+
|`false`
633679

634680
h|Kafka property name
635681
|`preallocate`
@@ -655,7 +701,7 @@ h|Type
655701
|Integer
656702

657703
h|Default value
658-
|`4 KB`
704+
|`4000` (bytes, 4 KB)
659705

660706
h|Kafka property name
661707
|`index.interval.bytes`
@@ -677,7 +723,7 @@ h|Type
677723
|Integer
678724

679725
h|Default value
680-
|`10 MB`
726+
|`10485760` (bytes)
681727

682728
h|Kafka property name
683729
|`segment.index.bytes`
@@ -703,7 +749,7 @@ h|Type
703749
|Long
704750

705751
h|Default value
706-
|`9223372036854775807 messages`
752+
|`9223372036854775807` (messages)
707753

708754
h|Kafka property name
709755
|`flush.messages`
@@ -725,7 +771,7 @@ h|Type
725771
|Long
726772

727773
h|Default value
728-
|`9223372036854775807 ms`
774+
|`9223372036854775807` (milliseconds)
729775

730776
h|Kafka property name
731777
|`flush.ms`

0 commit comments

Comments
 (0)