blob: 3149d3e4b3a41a1faad2ba5f66cbaa1290ea4316 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Apache Druid">
<meta name="keywords" content="druid,kafka,database,analytics,streaming,real-time,real time,apache,open source">
<meta name="author" content="Apache Software Foundation">
<title>Druid | Tutorial: Configuring data retention</title>
<link rel="alternate" type="application/atom+xml" href="/feed">
<link rel="shortcut icon" href="/img/favicon.png">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
<link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="/css/bootstrap-pure.css?v=1.1">
<link rel="stylesheet" href="/css/base.css?v=1.1">
<link rel="stylesheet" href="/css/header.css?v=1.1">
<link rel="stylesheet" href="/css/footer.css?v=1.1">
<link rel="stylesheet" href="/css/syntax.css?v=1.1">
<link rel="stylesheet" href="/css/docs.css?v=1.1">
<script>
(function() {
var cx = '000162378814775985090:molvbm0vggm';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//cse.google.com/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
</head>
<body>
<!-- Start page_header include -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
<div class="top-navigator">
<div class="container">
<div class="left-cont">
<a class="logo" href="/"><span class="druid-logo"></span></a>
</div>
<div class="right-cont">
<ul class="links">
<li class=""><a href="/technology">Technology</a></li>
<li class=""><a href="/use-cases">Use Cases</a></li>
<li class=""><a href="/druid-powered">Powered By</a></li>
<li class=""><a href="/docs/latest/design/">Docs</a></li>
<li class=""><a href="/community/">Community</a></li>
<li class="header-dropdown">
<a>Apache</a>
<div class="header-dropdown-menu">
<a href="https://www.apache.org/" target="_blank">Foundation</a>
<a href="https://www.apache.org/events/current-event" target="_blank">Events</a>
<a href="https://www.apache.org/licenses/" target="_blank">License</a>
<a href="https://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a>
<a href="https://www.apache.org/security/" target="_blank">Security</a>
<a href="https://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a>
</div>
</li>
<li class=" button-link"><a href="/downloads.html">Download</a></li>
</ul>
</div>
</div>
<div class="action-button menu-icon">
<span class="fa fa-bars"></span> MENU
</div>
<div class="action-button menu-icon-close">
<span class="fa fa-times"></span> MENU
</div>
</div>
<script type="text/javascript">
var $menu = $('.right-cont');
var $menuIcon = $('.menu-icon');
var $menuIconClose = $('.menu-icon-close');
function showMenu() {
$menu.fadeIn(100);
$menuIcon.fadeOut(100);
$menuIconClose.fadeIn(100);
}
$menuIcon.click(showMenu);
function hideMenu() {
$menu.fadeOut(100);
$menuIconClose.fadeOut(100);
$menuIcon.fadeIn(100);
}
$menuIconClose.click(hideMenu);
$(window).resize(function() {
if ($(window).width() >= 840) {
$menu.fadeIn(100);
$menuIcon.fadeOut(100);
$menuIconClose.fadeOut(100);
}
else {
$menu.fadeOut(100);
$menuIcon.fadeIn(100);
$menuIconClose.fadeOut(100);
}
});
</script>
<!-- Stop page_header include -->
<div class="container doc-container">
<p> Looking for the <a href="/docs/0.23.0/">latest stable documentation</a>?</p>
<div class="row">
<div class="col-md-9 doc-content">
<p>
<a class="btn btn-default btn-xs visible-xs-inline-block visible-sm-inline-block" href="#toc">Table of Contents</a>
</p>
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
<h1 id="tutorial-configuring-data-retention">Tutorial: Configuring data retention</h1>
<p>This tutorial demonstrates how to configure retention rules on a datasource to set the time intervals of data that will be retained or dropped.</p>
<p>For this tutorial, we&#39;ll assume you&#39;ve already downloaded Druid as described in
the <a href="index.html">single-machine quickstart</a> and have it running on your local machine. </p>
<p>It will also be helpful to have finished <a href="../tutorials/tutorial-batch.html">Tutorial: Loading a file</a> and <a href="../tutorials/tutorial-query.html">Tutorial: Querying data</a>.</p>
<h2 id="load-the-example-data">Load the example data</h2>
<p>For this tutorial, we&#39;ll be using the Wikipedia edits sample data, with an ingestion task spec that will create a separate segment for each hour in the input data.</p>
<p>The ingestion spec can be found at <code>quickstart/tutorial/retention-index.json</code>. Let&#39;s submit that spec, which will create a datasource called <code>retention-tutorial</code>:</p>
<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span>bin/post-index-task --file quickstart/tutorial/retention-index.json
</code></pre></div>
<p>After the ingestion completes, go to http://localhost:8081 in a browser to access the Coordinator console.</p>
<p>In the Coordinator console, go to the <code>datasources</code> tab at the top of the page.</p>
<p>This tab shows the available datasources and a summary of the retention rules for each datasource:</p>
<p><img src="../tutorials/img/tutorial-retention-00.png" alt="Summary" title="Summary"></p>
<p>Currently there are no rules set for the <code>retention-tutorial</code> datasource. Note that there are default rules, currently set to <code>load Forever 2 in _default_tier</code>. </p>
<p>This means that all data will be loaded regardless of timestamp, and each segment will be replicated to two nodes in the default tier. </p>
<p>In this tutorial, we will ignore the tiering and redundancy concepts for now.</p>
<p>Let&#39;s click the <code>retention-tutorial</code> datasource on the left. </p>
<p>The next page (http://localhost:8081/#/datasources/retention-tutorial) provides information about what segments a datasource contains. On the left, the page shows that there are 24 segments, each one containing data for a specific hour of 2015-09-12:</p>
<p><img src="../tutorials/img/tutorial-retention-01.png" alt="Original segments" title="Original segments"></p>
<h2 id="set-retention-rules">Set retention rules</h2>
<p>Suppose we want to drop data for the first 12 hours of 2015-09-12 and keep data for the later 12 hours of 2015-09-12.</p>
<p>Click the <code>edit rules</code> button with a pencil icon at the upper left corner of the page.</p>
<p>A rule configuration window will appear. Enter <code>tutorial</code> for both the user and changelog comment field.</p>
<p>Now click the <code>+ Add a rule</code> button twice. </p>
<p>In the <code>rule #1</code> box at the top, click <code>Load</code>, <code>Interval</code>, enter <code>2015-09-12T12:00:00.000Z/2015-09-13T00:00:00.000Z</code> in the interval box, and click <code>+ _default_tier replicant</code>.</p>
<p>In the <code>rule #2</code> box at the bottom, click <code>Drop</code> and <code>Forever</code>.</p>
<p>The rules should look like this:</p>
<p><img src="../tutorials/img/tutorial-retention-02.png" alt="Set rules" title="Set rules"></p>
<p>Now click <code>Save all rules</code>, wait for a few seconds, and refresh the page. </p>
<p>The segments for the first 12 hours of 2015-09-12 are now gone:</p>
<p><img src="../tutorials/img/tutorial-retention-03.png" alt="New segments" title="New segments"></p>
<p>The resulting retention rule chain is the following:</p>
<ol>
<li><p>loadByInterval 2015-09-12T12/2015-09-13 (12 hours)</p></li>
<li><p>dropForever</p></li>
<li><p>loadForever (default rule)</p></li>
</ol>
<p>The rule chain is evaluated from top to bottom, with the default rule chain always added at the bottom.</p>
<p>The tutorial rule chain we just created loads data if it is within the specified 12 hour interval. </p>
<p>If data is not within the 12 hour interval, the rule chain evaluates <code>dropForever</code> next, which will drop any data.</p>
<p>The <code>dropForever</code> terminates the rule chain, effectively overriding the default <code>loadForever</code> rule, which will never be reached in this rule chain.</p>
<p>Note that in this tutorial we defined a load rule on a specific interval. </p>
<p>If instead you want to retain data based on how old it is (e.g., retain data that ranges from 3 months in the past to the present time), you would define a Period load rule instead.</p>
<h2 id="further-reading">Further reading</h2>
<ul>
<li><a href="../operations/rule-configuration.html">Load rules</a></li>
</ul>
</div>
<div class="col-md-3">
<div class="searchbox">
<gcse:searchbox-only></gcse:searchbox-only>
</div>
<div id="toc" class="nav toc hidden-print">
</div>
</div>
</div>
</div>
<!-- Start page_footer include -->
<footer class="druid-footer">
<div class="container">
<div class="text-center">
<p>
<a href="/technology">Technology</a>&ensp;·&ensp;
<a href="/use-cases">Use Cases</a>&ensp;·&ensp;
<a href="/druid-powered">Powered by Druid</a>&ensp;·&ensp;
<a href="/docs/latest/">Docs</a>&ensp;·&ensp;
<a href="/community/">Community</a>&ensp;·&ensp;
<a href="/downloads.html">Download</a>&ensp;·&ensp;
<a href="/faq">FAQ</a>
</p>
</div>
<div class="text-center">
<a title="Join the user group" href="https://groups.google.com/forum/#!forum/druid-user" target="_blank"><span class="fa fa-comments"></span></a>&ensp;·&ensp;
<a title="Follow Druid" href="https://twitter.com/druidio" target="_blank"><span class="fab fa-twitter"></span></a>&ensp;·&ensp;
<a title="GitHub" href="https://github.com/apache/druid" target="_blank"><span class="fab fa-github"></span></a>
</div>
<div class="text-center license">
Copyright © 2020 <a href="https://www.apache.org/" target="_blank">Apache Software Foundation</a>.<br>
Except where otherwise noted, licensed under <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.<br>
Apache Druid, Druid, and the Druid logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.
</div>
</div>
</footer>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-131010415-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-131010415-1');
</script>
<script>
function trackDownload(type, url) {
ga('send', 'event', 'download', type, url);
}
</script>
<script src="//code.jquery.com/jquery.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
<script src="/assets/js/druid.js"></script>
<!-- stop page_footer include -->
<script>
$(function() {
$(".toc").load("/docs/0.13.0-incubating/toc.html");
// There is no way to tell when .gsc-input will be async loaded into the page so just try to set a placeholder until it works
var tries = 0;
var timer = setInterval(function() {
tries++;
if (tries > 300) clearInterval(timer);
var searchInput = $('input.gsc-input');
if (searchInput.length) {
searchInput.attr('placeholder', 'Search');
clearInterval(timer);
}
}, 100);
});
</script>
</body>
</html>