Skip to content

Commit 21fea17

Browse files
guozhangwangguozhangwang
committed
MINOR: add upgrade section for 1.0.0
1. Add upgrade section for 1.0.0, including Streams API changes section. 2. Add metrics name changes section. Author: Guozhang Wang <wangguoz@gmail.com> Reviewers: Eno Thereska <eno.thereska@gmail.com>, Damian Guy <damian.guy@gmail.com> Closes apache#3687 from guozhangwang/KMinor-metrics-upgrade-guide
1 parent 5e65c0d commit 21fea17

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

‎docs/streams/upgrade-guide.html

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,22 @@
2020
<script id="content-template" type="text/x-handlebars-template">
2121
<h1>Upgrade Guide &amp; API Changes</h1>
2222

23+
<p>
24+
If you want to upgrade from 0.11.0.x to 1.0.0 you don't need to do any code changes as the public API is fully backward compatible.
25+
However, some public APIs were deprecated and thus it is recommended to update your code eventually to allow for future upgrades.
26+
See <a href="#streams_api_changes_100">below</a> a complete list of 1.0.0 API and semantic changes that allow you to advance your application and/or simplify your code base, including the usage of new features.
27+
</p>
28+
2329
<p>
2430
If you want to upgrade from 0.10.2.x to 0.11.0 you don't need to do any code changes as the public API is fully backward compatible.
25-
However, some configuration parameters were deprecated and thus it is recommend to update your code eventually to allow for future upgrades.
26-
See <a href="#streams_api_changes_0110">below</a> a complete list of 0.11.0 API and semantical changes that allow you to advance your application and/or simplify your code base, including the usage of new features.
31+
However, some configuration parameters were deprecated and thus it is recommended to update your code eventually to allow for future upgrades.
32+
See <a href="#streams_api_changes_0110">below</a> a complete list of 0.11.0 API and semantic changes that allow you to advance your application and/or simplify your code base, including the usage of new features.
2733
</p>
2834

2935
<p>
3036
If you want to upgrade from 0.10.1.x to 0.10.2, see the <a href="/{{version}}/documentation/#upgrade_1020_streams"><b>Upgrade Section for 0.10.2</b></a>.
3137
It highlights incompatible changes you need to consider to upgrade your code and application.
32-
See <a href="#streams_api_changes_0102">below</a> a complete list of 0.10.2 API and semantical changes that allow you to advance your application and/or simplify your code base, including the usage of new features.
38+
See <a href="#streams_api_changes_0102">below</a> a complete list of 0.10.2 API and semantic changes that allow you to advance your application and/or simplify your code base, including the usage of new features.
3339
</p>
3440

3541
<p>
@@ -38,6 +44,16 @@ <h1>Upgrade Guide &amp; API Changes</h1>
3844
See <a href="#streams_api_changes_0101">below</a> a complete list of 0.10.1 API changes that allow you to advance your application and/or simplify your code base, including the usage of new features.
3945
</p>
4046

47+
<h3><a id="streams_api_changes_100" href="#streams_api_changes_100">Streams API changes in 1.0.0</a></h3>
48+
<!-- TODO: KIP-120, 138, 160, 161, 167, 173 -->
49+
50+
<p>
51+
If you are monitoring on task level or processor-node / state store level Streams metrics, please note that the metrics sensor name and hierarchy was changed:
52+
The task ids, store names and processor names are no longer in the sensor metrics names, but instead are added as tags of the sensors to achieve consistent metrics hierarchy.
53+
As a result you may need to make corresponding code changes on your metrics reporting and monitoring tools when upgrading to 1.0.0.
54+
Detailed metrics sensor can be found in the <a href="#kafka_streams_monitoring">Streams Monitoring</a> section.
55+
</p>
56+
4157
<h3><a id="streams_api_changes_0110" href="#streams_api_changes_0110">Streams API changes in 0.11.0.0</a></h3>
4258

4359
<p> Updates in <code>StreamsConfig</code>: </p>

‎docs/upgrade.html

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,16 @@ <h5><a id="upgrade_100_new_protocols" href="#upgrade_100_new_protocols">New Prot
7676
<li> <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-112%3A+Handle+disk+failure+for+JBOD">KIP-112</a>: FetchResponse v6 introduces error code for KafkaStorageException. </li>
7777
</ul>
7878

79+
<h5><a id="upgrade_100_streams" href="#upgrade_100_streams">Upgrading a 1.0.0 Kafka Streams Application</a></h5>
80+
<ul>
81+
<li> Upgrading your Streams application from 0.11.0 to 1.0.0 does not require a broker upgrade.
82+
A Kafka Streams 1.0.0 application can connect to 0.11.0, 0.10.2 and 0.10.1 brokers (it is not possible to connect to 0.10.0 brokers though). </li>
83+
<li> If you are monitoring on streams metrics, you will need make some changes to the metrics names in your reporting and monitoring code, because the metrics sensor hierarchy was changed. </li>
84+
<li> There are a few public APIs including <code>ProcessorContext#schedule()</code>, <code>Processor#punctuate()</code> and <code>KStreamBuilder</code>, <code>TopologyBuilder</code> are being deprecated by new APIs.
85+
We recommend making corresponding code changes, which should be very minor since the new APIs look very similary, when you upgrade.
86+
<li> See <a href="/{{version}}/documentation/streams#streams_api_changes_100">Streams API changes in 1.0.0</a> for more details. </li>
87+
</ul>
88+
7989
<h4><a id="upgrade_11_0_0" href="#upgrade_11_0_0">Upgrading from 0.8.x, 0.9.x, 0.10.0.x, 0.10.1.x or 0.10.2.x to 0.11.0.0</a></h4>
8090
<p>Kafka 0.11.0.0 introduces a new message format version as well as wire protocol changes. By following the recommended rolling upgrade plan below,
8191
you guarantee no downtime during the upgrade. However, please review the <a href="#upgrade_1100_notable">notable changes in 0.11.0.0</a> before upgrading.
@@ -277,8 +287,6 @@ <h5><a id="upgrade_10201_notable" href="#upgrade_10201_notable">Notable changes
277287
</li>
278288
</ul>
279289

280-
281-
282290
<h5><a id="upgrade_1020_notable" href="#upgrade_1020_notable">Notable changes in 0.10.2.0</a></h5>
283291
<ul>
284292
<li>The Java clients (producer and consumer) have acquired the ability to communicate with older brokers. Version 0.10.2 clients

0 commit comments

Comments
 (0)