blob: 4d001d4d92352f42e773ec847a72aa993aea5a1c [file] [log] [blame]
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview &mdash; DistributedLog 1.0 documentation</title>
<link rel="stylesheet" href="_static/override.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-3.1.0/css/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-3.1.0/css/bootstrap-theme.min.css" type="text/css" />
<link rel="stylesheet" href="_static/css/featherlight.min.css" type="text/css" />
<link rel="stylesheet" href="_static/css/docbird.css" type="text/css" />
<link rel="stylesheet" href="_static/css/docbird-xs.css" type="text/css" />
<link rel="stylesheet" href="_static/css/jquery.rateyo.min.css" type="text/css" />
<link rel="stylesheet" href="_static/css/selection-sharer.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.1.0/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/js/bootstrap-docbird.js"></script>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/js/featherlight.min.js"></script>
<script type="text/javascript" src="_static/js/ifvisible.js"></script>
<script type="text/javascript" src="_static/js/timeme.js"></script>
<script type="text/javascript" src="_static/js/jquery.rateyo.min.js"></script>
<script type="text/javascript" src="_static/js/js.cookie.js"></script>
<link rel="shortcut icon" href="_static/docbird.ico"/>
<link rel="top" title="DistributedLog 1.0 documentation" href="#" />
<link rel="next" title="Releases" href="download.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta property="docbird:project" content="DistributedLog" />
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container-fluid">
<div class="row db-header">
<div class="col-sm-3 col-md-3 col-lg-3 hidden-xs db-header-controls">
<a href="/" alt="Back to Docbird">
<div class="db-home-button">
<span class="glyphicon glyphicon-home"></span>
</div>
</a>
<form action="search.html" method="get" class="db-searchbox-form">
<div class="form-group">
<input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<div class="col-sm-7 col-md-7 col-lg-7 col-xs-12 db-header-info">
<div class="visible-xs">
<a href="/" alt="Back to Docbird">
<div class="db-home-button">
<span class="glyphicon glyphicon-home"></span>
</div>
</a>
</div>
<div class="visible-xs db-xs-menu-button">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#db-xs-menu">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
</div>
<div class="db-header-projectname">
<h1><a href="#">DistributedLog</a></h1>
</div>
</div>
</div>
<div class="row db-xs-menu hidden-sm hidden-md hidden-lg
collapse" id="db-xs-menu">
<form action="search.html" method="get" class="db-searchbox-form">
<div class="form-group">
<input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<div class="db-toc" role="complementary">
<ul>
<li class="toctree-l1"><a class="reference internal" href="download.html">Releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download.html#rc1">0.3.51-RC1</a></li>
<li class="toctree-l2"><a class="reference internal" href="download.html#rc0">0.3.51-RC0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="basics/main.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="basics/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="basics/quickstart.html">Quick Start</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/main.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/core.html">Core Library API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/proxy.html">Write Proxy Client API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/practice.html">Best Practices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/main.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/core.html">Core Library Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/proxy.html">Write Proxy Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/client.html">Client Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/perlog.html">Per Stream Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="considerations/main.html">Considerations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#partitioning">Partitioning</a></li>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#processing-semantics">Processing Semantics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="architecture/main.html">Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#data-model">Data Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#software-stack">Software Stack</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="design/main.html">Detail Design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#consistency">Consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#streaming-reads">Streaming Reads</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="globalreplicatedlog/main.html">Global Replicated Log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="implementation/main.html">Implementation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="implementation/storage.html">Storage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="operations/main.html">Deployment &amp; Administration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="operations/deployment.html">Cluster Setup &amp; Deployment</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/operations.html">DistributedLog Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/performance.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/hardware.html">Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/monitoring.html">Monitoring</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/zookeeper.html">ZooKeeper</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/bookkeeper.html">BookKeeper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="performance/main.html">Performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="references/main.html">References</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references/configuration.html">Configuration Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="references/metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="references/features.html">Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/main.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#messaging">Messaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#analytics">Analytics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer/main.html">Developer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer/release.html">Release</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div style="z-index: 1" class="col-xs-12 col-sm-12 col-md-12 col-lg-12">
<style>
.overflow-container {
display: none;
}
.overflow-toggle {
text-decoration: none;
border-bottom: none;
border-radius: 4px;
border: 1px solid #eee;
padding: 1px 3px 3px;
color: #888;
font-weight: normal;
background-color: linen;
line-height: 1.85em;
cursor: pointer;
}
.overflow-toggle:hover {
color: #333;
border-color: #ccc;
background-color: beige;
}
</style>
<script>
$(function(){
$('.overflow-toggle').on('click', function(){
$(this).next().toggle();
});
});
</script>
<div class="db-project-header-container">
<div class="row">
<div class="db-project-info col-lg-12 col-md-12 col-sm-12 col-xs-12">
<h1>
<a href="#">DistributedLog</a>
</h1>
<div class="db-code-link">
<a href="git@github.com:twitter/distributedlog.git/tree/master/" target="_blank">git@github.com:twitter/distributedlog.git/tree/master/</a>
</div>
</div>
</div>
<div class="row db-project-links-row">
<div class=" col-sm-3 col-md-3 col-lg-3 db-project-link-column">
<div class="db-hashtag-container">
<span class="db-project-link-label">OWNERS</span>
<em>None</em>
</div>
</div>
<div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column">
<div class="db-hashtag-container">
<span class="db-project-link-label">TAGS</span>
<em><a class="db-hashtag" href="/?q=tags:%23uses_maven">#uses_maven</a></em>
</div>
</div>
<div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column">
<span class="db-project-link-label">HEALTH</span>
<h3 style="margin-top: 0">
<!-- <a href="//techdocs/checklist.html" class="label label-success">-->
<a href="/report/distributedlog" class="">
9.0 / 10
<span style="margin-left: .25em" class="glyphicon glyphicon-ok"></span>
</a>
</h3>
</div>
<div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column">
<span class="db-project-link-label">RATING</span>
<div id="rateYo"></div>
</div>
</div>
</div>
</div>
<div class="col-xs-12 col-sm-8 col-md-8 col-lg-8">
<div class="db-content-body">
<p><a class="reference external" href="https://travis-ci.org/twitter/distributedlog"><img alt="Build Status" src="https://travis-ci.org/twitter/distributedlog.svg?branch=master" /></a></p>
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p>DistributedLog (DL) is a high-performance, replicated log service,
offering durability, replication and strong consistency as essentials
for building reliable distributed systems.</p>
<div class="section" id="high-performance">
<h2>High Performance<a class="headerlink" href="#high-performance" title="Permalink to this headline">¶</a></h2>
<p>DL is able to provide milliseconds latency on durable writes with a
large number of concurrent logs, and handle high volume reads and writes
per second from thousands of clients.</p>
</div>
<div class="section" id="durable-and-consistent">
<h2>Durable and Consistent<a class="headerlink" href="#durable-and-consistent" title="Permalink to this headline">¶</a></h2>
<p>Messages are persisted on disk and replicated to store multiple copies
to prevent data loss. They are guaranteed to be consistent among writers
and readers in terms of strict ordering.</p>
</div>
<div class="section" id="efficient-fan-in-and-fan-out">
<h2>Efficient Fan-in and Fan-out<a class="headerlink" href="#efficient-fan-in-and-fan-out" title="Permalink to this headline">¶</a></h2>
<p>DL provides an efficient service layer that is optimized for running in
a multi- tenant datacenter environment such as Mesos or Yarn. The
service layer is able to support large scale writes (fan-in) and reads
(fan-out).</p>
</div>
<div class="section" id="various-workloads">
<h2>Various Workloads<a class="headerlink" href="#various-workloads" title="Permalink to this headline">¶</a></h2>
<p>DL supports various workloads from latency-sensitive online transaction
processing (OLTP) applications (e.g. WAL for distributed database and
in-memory replicated state machines), real-time stream ingestion and
computing, to analytical processing.</p>
</div>
<div class="section" id="multi-tenant">
<h2>Multi Tenant<a class="headerlink" href="#multi-tenant" title="Permalink to this headline">¶</a></h2>
<p>To support a large number of logs for multi-tenants, DL is designed for
I/O isolation in real-world workloads.</p>
</div>
<div class="section" id="layered-architecture">
<h2>Layered Architecture<a class="headerlink" href="#layered-architecture" title="Permalink to this headline">¶</a></h2>
<p>DL has a modern layered architecture design, which separates the
stateless service tier from the stateful storage tier. To support large
scale writes (fan- in) and reads (fan-out), DL allows scaling storage
independent of scaling CPU and memory.</p>
</div>
</div>
<div class="section" id="documentation-and-getting-started">
<h1>Documentation and Getting Started<a class="headerlink" href="#documentation-and-getting-started" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference external" href="http://twitter.github.io/distributedlog/html/basics/quickstart.html">**Getting
Started**</a></li>
<li><a class="reference external" href="http://twitter.github.io/distributedlog/html/api/main.html">**API
References**</a></li>
<li><a class="reference external" href="http://twitter.github.io/distributedlog/html/tutorials/main.html">**Tutorials**</a></li>
</ul>
</div>
<div class="section" id="getting-involved">
<h1>Getting involved<a class="headerlink" href="#getting-involved" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li>Website: <a class="reference external" href="https://twitter.github.io/distributedlog/html/">https://twitter.github.io/distributedlog/html/</a></li>
<li>Source: <a class="reference external" href="https://github.com/twitter/distributedlog">https://github.com/twitter/distributedlog</a></li>
<li>Maiing List:
<a class="reference external" href="https://groups.google.com/forum/#!forum/distributedlog-user">distributedlog-user&#64;googlegroups.com</a></li>
<li>Issue Tracker: <a class="reference external" href="https://github.com/twitter/distributedlog/issues">https://github.com/twitter/distributedlog/issues</a></li>
</ul>
<p>We feel that a welcoming community is important and we ask that you
follow Twitter's <a class="reference external" href="https://engineering.twitter.com/opensource/code-of-conduct">Open Source Code of
Conduct</a>
in all interactions with the community.</p>
</div>
<div class="section" id="authors">
<h1>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li>Robin Dhamankar
(<a class="reference external" href="https://twitter.com/RobinDhamankar">&#64;RobinDhamankar</a>)</li>
<li>Sijie Guo (<a class="reference external" href="https://twitter.com/sijieg">&#64;sijieg</a>)</li>
<li>Leigh Stewart (<a class="reference external" href="https://twitter.com/l4stewar">&#64;l4stewar</a>)</li>
</ul>
<p>Thanks for assistance and contributions:</p>
<ul class="simple">
<li>Aniruddha Laud (<a class="reference external" href="https://twitter.com/i0exception">&#64;i0exception</a>)</li>
<li>Franck Cuny (<a class="reference external" href="https://twitter.com/franckcuny">&#64;franckcuny</a>)</li>
<li>Dave Rusek (<a class="reference external" href="https://twitter.com/davidjrusek">&#64;davidjrusek</a>)</li>
<li>Jordan Bull (<a class="reference external" href="https://twitter.com/jordangbull">&#64;jordangbull</a>)</li>
</ul>
<p>A full list of
<a class="reference external" href="https://github.com/twitter/distributedlog/graphs/contributors">contributors</a>
can be found on GitHub.</p>
</div>
<div class="section" id="license">
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1>
<p>Copyright 2016 Twitter, Inc.</p>
<p>Licensed under the Apache License, Version 2.0:
<a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
</div>
<div class="section" id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="download.html">Releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download.html#rc1">0.3.51-RC1</a></li>
<li class="toctree-l2"><a class="reference internal" href="download.html#rc0">0.3.51-RC0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="basics/main.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="basics/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="basics/quickstart.html">Quick Start</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/main.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/core.html">Core Library API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/proxy.html">Write Proxy Client API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/practice.html">Best Practices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/main.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/core.html">Core Library Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/proxy.html">Write Proxy Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/client.html">Client Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/perlog.html">Per Stream Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="considerations/main.html">Considerations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#partitioning">Partitioning</a></li>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#processing-semantics">Processing Semantics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="architecture/main.html">Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#data-model">Data Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#software-stack">Software Stack</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="design/main.html">Detail Design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#consistency">Consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#streaming-reads">Streaming Reads</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="globalreplicatedlog/main.html">Global Replicated Log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="implementation/main.html">Implementation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="implementation/storage.html">Storage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="operations/main.html">Deployment &amp; Administration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="operations/deployment.html">Cluster Setup &amp; Deployment</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/operations.html">DistributedLog Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/performance.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/hardware.html">Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/monitoring.html">Monitoring</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/zookeeper.html">ZooKeeper</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/bookkeeper.html">BookKeeper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="performance/main.html">Performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="references/main.html">References</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references/configuration.html">Configuration Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="references/metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="references/features.html">Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/main.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#messaging">Messaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#analytics">Analytics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer/main.html">Developer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer/release.html">Release</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="hidden-xs col-sm-3 col-md-3 col-md-offset-1 col-lg-3 db-sidebar">
<div class="db-toc" role="complementary">
<ul class="current">
<li class="toctree-l0 current"><a class="current reference internal" href="#">DistributedLog</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="download.html">Releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download.html#rc1">0.3.51-RC1</a></li>
<li class="toctree-l2"><a class="reference internal" href="download.html#rc0">0.3.51-RC0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="basics/main.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="basics/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="basics/quickstart.html">Quick Start</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/main.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/core.html">Core Library API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/proxy.html">Write Proxy Client API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/practice.html">Best Practices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/main.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/core.html">Core Library Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/proxy.html">Write Proxy Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/client.html">Client Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/perlog.html">Per Stream Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="considerations/main.html">Considerations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#partitioning">Partitioning</a></li>
<li class="toctree-l2"><a class="reference internal" href="considerations/main.html#processing-semantics">Processing Semantics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="architecture/main.html">Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#data-model">Data Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#software-stack">Software Stack</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="design/main.html">Detail Design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#consistency">Consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#streaming-reads">Streaming Reads</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="globalreplicatedlog/main.html">Global Replicated Log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="implementation/main.html">Implementation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="implementation/storage.html">Storage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="operations/main.html">Deployment &amp; Administration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="operations/deployment.html">Cluster Setup &amp; Deployment</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/operations.html">DistributedLog Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/performance.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/hardware.html">Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/monitoring.html">Monitoring</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/zookeeper.html">ZooKeeper</a></li>
<li class="toctree-l2"><a class="reference internal" href="operations/bookkeeper.html">BookKeeper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="performance/main.html">Performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="references/main.html">References</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references/configuration.html">Configuration Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="references/metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="references/features.html">Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/main.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#messaging">Messaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/main.html#analytics">Analytics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer/main.html">Developer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer/release.html">Release</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
<span id="last"></span>
</div>
</div>
<!-- <div id="slidebox"> -->
<!-- <button id="slidebox_close" type="button" class="close">&times;</button> -->
<!-- <p>Rate This Page</p> -->
<!-- <div id="rateYo"></div> -->
<!-- <p>Comment</p>
<input type="text" name="comment"></input>
<button>Submit</button> -->
<!-- </div> -->
</div>
</div>
<footer class="footer">
<div class="container-fluid">
<div class="row">
<div class="col-md-10 col-md-offset-1">
<p class="pull-right">
<a href="#">Back to top</a>
<br/>
<div id="sourcelink">
<a href="git@github.com:twitter/distributedlog.git/tree/master/README.md"
rel="nofollow">Source</a>
<a href="_sources/index.txt"
rel="nofollow">Raw</a>
<a href="__docbird-build.log"
rel="nofollow">Build Log</a>
<a href="/report/stats/distributedlog:distributedlog"
rel="nofollow">Stats</a>
</div>
</p>
<p>
Built and hosted by <a href="//">DocBird</a>.
</p>
</div>
</div>
</div>
</footer>
<script type="text/javascript" src="_static/js/docbird.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30775-8']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<!-- <script type="text/javascript" src="//s/d41d8cd98f00b204e9800998ecf8427e/en_US-tbnx1s-1988229788/6163/97/1.4.3/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?collectorId=e62237fc"></script>
-->
<script type="text/javascript">
$(document).ready(function () {
// track user activity time (from https://github.com/jasonzissman/TimeMe.js)
TimeMe.setIdleDurationInSeconds(30);
TimeMe.setCurrentPageName("my-home-page");
TimeMe.initialize();
// record page visit event when user leaves the page
window.onbeforeunload = function (event) {
xmlhttp=new XMLHttpRequest();
xmlhttp.withCredentials = true;
xmlhttp.open("POST", "/event/distributedlog:distributedlog/visit", false);
xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
var event_data = {
total_time_reading: TimeMe.getTimeOnCurrentPageInSeconds(),
page: window.location.href
};
//alert("send: " + $.param(event_data));
xmlhttp.send($.param(event_data));
};
// ask user for page rating after 20 seconds
// setTimeout(function(){
// alert("Rate this page!");
// }, 20000);
});
</script>
<!-- <style>
#slidebox{
width: 250px;
height: 90px;
padding: 10px;
background-color: #fff;
border: 1px solid #ccc;
position: fixed;
bottom: 3px;
right: -280px;
z-index: 1;
}
#slidebox .close{
margin-top: -5px;
opacity: 0.5;
}
#slidebox .close:hover{
opacity: 0.7;
}
</style> -->
<script type="text/javascript">
$(function() {
// $(window).scroll(function(){
// var distanceTop = $('#last').offset().top - $(window).height();
// if ($(window).scrollTop() > distanceTop)
// $('#slidebox').animate({'right':'3px'},300);
// else
// $('#slidebox').stop(true).animate({'right':'-280px'},100);
// });
// $('#slidebox .close').bind('click',function(){
// $(this).parent().remove();
// });
$("#rateYo").rateYo({
normalFill: "#A0A0A0",
halfStar: true,
rating: (Cookies.get('docbird.rating.distributedlog.distributedlog') || 0.0)
}).on("rateyo.set", function (e, data) {
var event_data = {
comment: '', // see todo note below
rating: data.rating,
page: window.location.href
};
Cookies.get('docbird.rating.distributedlog.distributedlog', data.rating)
$.post('/event/distributedlog:distributedlog/rating', event_data)
// xmlhttp=new XMLHttpRequest();
// xmlhttp.withCredentials = true;
// var event_data = {
// comment: '', // see todo note below
// rating: data.rating,
// page: window.location.href
// };
// xmlhttp.open("GET", "/event/distributedlog/rating?" + $.param(event_data), false);
// xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
// // todo: implement comment form in rating slide out,
// // and instead of hooking this event, include a submit button,
// // and read the rating with rating() method
// // alert("send: " + $.param(event_data));
// xmlhttp.send();
});
});
</script>
<script src="_static/js/selection-sharer.js"></script>
<script>
$('.db-content-body').selectionSharer();
</script>
</body>
</html>