You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`ProcessorStateManager` is a concrete <<kafka-streams-internals-StateManager.adoc#, StateManager>> (as a <<kafka-streams-AbstractStateManager.adoc#, AbstractStateManager>>) that...FIXME
3
+
`ProcessorStateManager` is a concrete <<kafka-streams-internals-StateManager.adoc#, StateManager>> (as a <<kafka-streams-internals-AbstractStateManager.adoc#, AbstractStateManager>>) that...FIXME
4
4
5
5
`ProcessorStateManager` is <<creating-instance, created>> exclusively when `AbstractTask` is <<kafka-streams-internals-AbstractTask.adoc#stateMgr, created>> (for <<kafka-streams-internals-StandbyTask.adoc#, StandbyTask>> and <<kafka-streams-internals-StreamTask.adoc#, StreamTask>> tasks).
6
6
@@ -81,7 +81,7 @@ NOTE: `register` is part of link:kafka-streams-internals-StateManager.adoc#regis
81
81
Registering state store [storeName] to its state manager
82
82
```
83
83
84
-
`register` finds the <<kafka-streams-StateStore.adoc#, StateStore>> in the <<storeToChangelogTopic, storeToChangelogTopic>> internal registry. If not found, `register` registers the `StateStore` (in the <<kafka-streams-AbstractStateManager.adoc#stores, stores>> registry) and returns.
84
+
`register` finds the <<kafka-streams-StateStore.adoc#, StateStore>> in the <<storeToChangelogTopic, storeToChangelogTopic>> internal registry. If not found, `register` registers the `StateStore` (in the <<kafka-streams-internals-AbstractStateManager.adoc#stores, stores>> registry) and returns.
85
85
86
86
If found however, `register` uses the topic to create a Kafka `TopicPartition` (with the <<getPartition, partition>>).
87
87
@@ -97,15 +97,15 @@ If the `ProcessorStateManager` is not in <<isStandby, standby>> mode, `register`
97
97
Restoring state store [storeName] from changelog topic [topic]
98
98
```
99
99
100
-
`register` adds the (store) partition to the <<changelogPartitions, changelogPartitions>> and registers the `StateStore` (in the <<kafka-streams-AbstractStateManager.adoc#stores, stores>> registry).
100
+
`register` adds the (store) partition to the <<changelogPartitions, changelogPartitions>> and registers the `StateStore` (in the <<kafka-streams-internals-AbstractStateManager.adoc#stores, stores>> registry).
101
101
102
102
`register` throws an `IllegalArgumentException` if the name of the <<kafka-streams-StateStore.adoc#, StateStore>> is *.checkpoint*.
103
103
104
104
```
105
105
Illegal store name: .checkpoint
106
106
```
107
107
108
-
`register` throws an `IllegalArgumentException` if the <<kafka-streams-StateStore.adoc#, StateStore>> is already registered (in the <<kafka-streams-AbstractStateManager.adoc#stores, stores>> registry).
108
+
`register` throws an `IllegalArgumentException` if the <<kafka-streams-StateStore.adoc#, StateStore>> is already registered (in the <<kafka-streams-internals-AbstractStateManager.adoc#stores, stores>> registry).
NOTE: `checkpoint` is part of the <<kafka-streams-Checkpointable.adoc#checkpoint, Checkpointable Contract>> to checkpoint offsets.
238
238
239
-
`checkpoint` requests the <<changelogReader, ChangelogReader>> for <<kafka-streams-ChangelogReader.adoc#restoredOffsets, restoredOffsets>> and adds them to the <<kafka-streams-AbstractStateManager.adoc#checkpointableOffsets, checkpointableOffsets>> registry.
239
+
`checkpoint` requests the <<changelogReader, ChangelogReader>> for <<kafka-streams-ChangelogReader.adoc#restoredOffsets, restoredOffsets>> and adds them to the <<kafka-streams-internals-AbstractStateManager.adoc#checkpointableOffsets, checkpointableOffsets>> registry.
240
240
241
-
For every <<kafka-streams-StateStore.adoc#, state store>> (in the <<kafka-streams-AbstractStateManager.adoc#stores, stores>> internal registry), `checkpoint`...FIXME
241
+
For every <<kafka-streams-StateStore.adoc#, state store>> (in the <<kafka-streams-internals-AbstractStateManager.adoc#stores, stores>> internal registry), `checkpoint`...FIXME
242
242
243
-
`checkpoint` creates a new <<kafka-streams-internals-OffsetCheckpoint.adoc#, OffsetCheckpoint>> (with the <<kafka-streams-AbstractStateManager.adoc#CHECKPOINT_FILE_NAME, .checkpoint>> file in the <<kafka-streams-AbstractStateManager.adoc#baseDir, base directory>>) unless <<kafka-streams-AbstractStateManager.adoc#checkpoint, it was done already>>.
243
+
`checkpoint` creates a new <<kafka-streams-internals-OffsetCheckpoint.adoc#, OffsetCheckpoint>> (with the <<kafka-streams-internals-AbstractStateManager.adoc#CHECKPOINT_FILE_NAME, .checkpoint>> file in the <<kafka-streams-internals-AbstractStateManager.adoc#baseDir, base directory>>) unless <<kafka-streams-internals-AbstractStateManager.adoc#checkpoint, it was done already>>.
244
244
245
245
`checkpoint` prints out the following TRACE message to the logs:
246
246
247
247
```
248
248
Writing checkpoint: [checkpointableOffsets]
249
249
```
250
250
251
-
In the end, `checkpoint` requests the <<kafka-streams-AbstractStateManager.adoc#checkpoint, OffsetCheckpoint>> to <<kafka-streams-internals-OffsetCheckpoint.adoc#write, write>> the <<kafka-streams-AbstractStateManager.adoc#checkpointableOffsets, checkpointableOffsets>>.
251
+
In the end, `checkpoint` requests the <<kafka-streams-internals-AbstractStateManager.adoc#checkpoint, OffsetCheckpoint>> to <<kafka-streams-internals-OffsetCheckpoint.adoc#write, write>> the <<kafka-streams-internals-AbstractStateManager.adoc#checkpointableOffsets, checkpointableOffsets>>.
Copy file name to clipboardexpand all lines: kafka-streams-StateStore.adoc
+2-2
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Closing the state store
21
21
22
22
Used when:
23
23
24
-
* `AbstractStateManager` is requested to <<kafka-streams-AbstractStateManager.adoc#reinitializeStateStoresForPartitions, reinitializeStateStoresForPartitions>>
24
+
* `AbstractStateManager` is requested to <<kafka-streams-internals-AbstractStateManager.adoc#reinitializeStateStoresForPartitions, reinitializeStateStoresForPartitions>>
25
25
26
26
* <<kafka-streams-internals-GlobalStateManagerImpl.adoc#close, GlobalStateManagerImpl>> and <<kafka-streams-ProcessorStateManager.adoc#close, ProcessorStateManager>> are requested to close
27
27
@@ -61,7 +61,7 @@ Initializes the state store
61
61
62
62
Used when:
63
63
64
-
* `AbstractStateManager` is requested to <<kafka-streams-AbstractStateManager.adoc#reinitializeStateStoresForPartitions, reinitializeStateStoresForPartitions>>
64
+
* `AbstractStateManager` is requested to <<kafka-streams-internals-AbstractStateManager.adoc#reinitializeStateStoresForPartitions, reinitializeStateStoresForPartitions>>
65
65
66
66
* `AbstractTask` is requested to <<kafka-streams-internals-AbstractTask.adoc#registerStateStores, registerStateStores>>
* link:kafka-streams-StreamsMetricsThreadImpl.adoc#tags[Tags] with one entry with `client-id` and the `[clientId]-StreamThread-[STREAM_THREAD_ID]` value.
546
546
547
-
`create` creates a <<kafka-streams-ThreadCache.adoc#, ThreadCache>> (with `cacheSizeBytes` for the `maxCacheSizeBytes` and the `StreamsMetricsThreadImpl`).
547
+
`create` creates a <<kafka-streams-internals-ThreadCache.adoc#, ThreadCache>> (with `cacheSizeBytes` for the `maxCacheSizeBytes` and the `StreamsMetricsThreadImpl`).
548
548
549
549
`create` creates a link:kafka-streams-internals-TaskCreator.adoc#creating-instance[TaskCreator] and a link:kafka-streams-internals-StandbyTaskCreator.adoc#creating-instance[StandbyTaskCreator] that are used exclusively to create a link:kafka-streams-internals-TaskManager.adoc#creating-instance[TaskManager] (with a new link:kafka-streams-AssignedStreamsTasks.adoc#creating-instance[AssignedStreamsTasks] and link:kafka-streams-AssignedStandbyTasks.adoc#creating-instance[AssignedStandbyTasks] as well as the given <<kafka-streams-StreamsMetadataState.adoc#, StreamsMetadataState>>).
Copy file name to clipboardexpand all lines: kafka-streams-StreamsMetrics.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -57,4 +57,4 @@ Used when...FIXME
57
57
|===
58
58
59
59
[[implementations]]
60
-
NOTE: link:kafka-streams-StreamsMetricsImpl.adoc[StreamsMetricsImpl] is the one and only known direct implementation of <<contract, StreamsMetrics Contract>> in Kafka Streams {{ book.kafka_version }}.
60
+
NOTE: link:kafka-streams-internals-StreamsMetricsImpl.adoc[StreamsMetricsImpl] is the one and only known direct implementation of <<contract, StreamsMetrics Contract>> in Kafka Streams {{ book.kafka_version }}.
`StreamsMetricsThreadImpl` is a concrete <<kafka-streams-StreamsMetricsImpl.adoc#, StreamsMetricsImpl>>.
3
+
`StreamsMetricsThreadImpl` is a concrete <<kafka-streams-internals-StreamsMetricsImpl.adoc#, StreamsMetricsImpl>>.
4
4
5
5
`StreamsMetricsThreadImpl` is <<creating-instance, created>> for a link:kafka-streams-StreamThread.adoc#create[StreamThread] (when `KafkaStreams` is link:kafka-streams-KafkaStreams.adoc#creating-instance[created]).
Copy file name to clipboardexpand all lines: kafka-streams-TimestampExtractor.adoc
+3-3
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ interface TimestampExtractor {
12
12
}
13
13
----
14
14
15
-
The extracted timestamp is in milliseconds and can never be negative (or <<kafka-streams-RecordQueue.adoc#addRawRecords, will be dropped>>).
15
+
The extracted timestamp is in milliseconds and can never be negative (or <<kafka-streams-internals-RecordQueue.adoc#addRawRecords, will be dropped>>).
16
16
17
17
You can define a custom timestamp extractor for reading a topic as a <<kafka-streams-StreamsBuilder.adoc#stream, KStream>> or a <<kafka-streams-StreamsBuilder.adoc#table, KTable>> in an <<kafka-streams-Consumed.adoc#, Consumed>> object (using <<kafka-streams-Consumed.adoc#with, with>> or <<kafka-streams-Consumed.adoc#withTimestampExtractor, withTimestampExtractor>>).
| [[extract]] Used exclusively when `RecordQueue` is requested to link:kafka-streams-RecordQueue.adoc#addRawRecords[add Kafka ConsumerRecords (as StampedRecords)].
49
+
| [[extract]] Used exclusively when `RecordQueue` is requested to link:kafka-streams-internals-RecordQueue.adoc#addRawRecords[add Kafka ConsumerRecords (as StampedRecords)].
NOTE: `TimestampExtractor` is an `Evolving` contract which means that compatibility may be broken at a minor release.
67
67
68
-
`TimestampExtractor` is used to create a <<kafka-streams-internals-InternalTopologyBuilder-SourceNodeFactory.adoc#, SourceNodeFactory>>, <<kafka-streams-RecordQueue.adoc#, RecordQueue>>, <<kafka-streams-internals-InternalTopologyBuilder-SourceNodeFactory.adoc#, SourceNodeFactory>>.
68
+
`TimestampExtractor` is used to create a <<kafka-streams-internals-InternalTopologyBuilder-SourceNodeFactory.adoc#, SourceNodeFactory>>, <<kafka-streams-internals-RecordQueue.adoc#, RecordQueue>>, <<kafka-streams-internals-InternalTopologyBuilder-SourceNodeFactory.adoc#, SourceNodeFactory>>.
`GlobalStateManagerImpl` is a concrete <<kafka-streams-GlobalStateManager.adoc#, GlobalStateManager>> (and a <<kafka-streams-AbstractStateManager.adoc#, AbstractStateManager>>) that...FIXME
3
+
`GlobalStateManagerImpl` is a concrete <<kafka-streams-GlobalStateManager.adoc#, GlobalStateManager>> (and a <<kafka-streams-internals-AbstractStateManager.adoc#, AbstractStateManager>>) that...FIXME
4
4
5
5
`GlobalStateManagerImpl` is <<creating-instance, created>> exclusively when `GlobalStreamThread` is requested to <<kafka-streams-internals-GlobalStreamThread.adoc#initialize, initialize>> (when `GlobalStreamThread` is <<kafka-streams-internals-GlobalStreamThread.adoc#run, started>> with <<kafka-streams-KafkaStreams.adoc#start, KafkaStreams>>).
0 commit comments