Wiki source code of Retention Policy

Last modified by Eva Torken on 2023/08/25 15:54
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 In this microlearning, we will dive a little bit deeper into the concept of the retention policy concerning Event Streaming. Retention policy determines when a message needs to be cleaned up and, if so, what will happen to the message.
3
4 Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Intermediate knowledge of the eMagiz platform
9
10 == 2. Key concepts ==
11
12 This microlearning centers on the retention policy for Event Streaming.
13
14 * The key aspects are:
15 ** Retention Hours
16 ** Retention Bytes
17 ** Cleanup Policy
18 ** These three items determine the retention policy
19
20 == 3. Event Streaming ==
21
22 In this microlearning, we will dive a little bit deeper into the concept of the retention policy concerning Event Streaming. Retention policy determines when a message needs to be cleaned up and, if so, what will happen to the message.
23
24 * The key aspects are:
25 ** Retention Hours
26 ** Retention Bytes
27 ** Cleanup Policy
28 ** These three items determine the retention policy
29
30 As we learned in the introductory [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-event-streaming-introduction||target="blank"]], the topic holds a log with a sequence of messages. Based on several criteria, the broker decides when to remove messages from the back of the log to ensure that the topic stays within specific parameters. These parameters are the retention hours and the retention bytes. If you want to learn more about them specifically, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-topic-and-topic-properties||target="blank"]].
31
32 These parameters combined with the cleanup policy determine what happens with a message after it is expired. There are two options available:
33 * delete
34 * compact
35
36 The delete option is the default that eMagiz uses and advises. This option will, as the name suggests, delete all messages that are expired. There is an alternative approach called compact. This functionality will enable log compaction on the topic.
37
38 The three aspects combine to make up the retention policy. Defining the correct values for both the retention hours and the retention bytes is a science as a form of art. As you only have limited storage capacity available, the challenge becomes how much retention you reserve per topic. The more you assign, the less free storage capacity remains for other topics. As a consequence, you need to strive to optimize your retention policy per topic continually.
39
40 == 4. Key takeaways ==
41
42 * The key aspects are:
43 ** Retention Hours
44 ** Retention Bytes
45 ** Cleanup Policy
46 ** These three items determine the retention policy
47
48 == 5. Suggested Additional Readings ==
49
50 If you are interested in this topic, please read the help text eMagiz provides you.
51 )))((({{toc/}}))){{/container}}{{/container}}