| <!DOCTYPE html> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>Write Records using Core Library — 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="../index.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="../index.html">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 & Administration</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & 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="main.html">Tutorials</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="main.html#basic">Basic</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="main.html#messaging">Messaging</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="main.html#replicated-state-machines">Replicated State Machines</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="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="../index.html">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"> |
| |
| <div class="section" id="write-records-using-core-library"> |
| <h1>Write Records using Core Library<a class="headerlink" href="#write-records-using-core-library" title="Permalink to this headline">¶</a></h1> |
| <p>This tutorial shows how to write records using core library.</p> |
| <div class="section" id="open-a-writer"> |
| <h2>Open a writer<a class="headerlink" href="#open-a-writer" title="Permalink to this headline">¶</a></h2> |
| <ul> |
| <li><p class="first">Create distributedlog URI.</p> |
| <div class="highlight-python"><pre>String dlUriStr = ...; |
| URI uri = URI.create(dlUriStr);</pre> |
| <div style='display:none;' class='raw-code'><pre>String dlUriStr = ...; |
| URI uri = URI.create(dlUriStr);</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Create distributedlog configuration.</p> |
| <div class="highlight-python"><pre>DistributedLogConfiguration conf = new DistributedLogConfiguration();</pre> |
| <div style='display:none;' class='raw-code'><pre>DistributedLogConfiguration conf = new DistributedLogConfiguration();</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Enable immediate flush.</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">conf</span><span class="o">.</span><span class="n">setImmediateFlushEnabled</span><span class="p">(</span><span class="n">true</span><span class="p">);</span> |
| <span class="n">conf</span><span class="o">.</span><span class="n">setOutputBufferSize</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span> |
| <span class="n">conf</span><span class="o">.</span><span class="n">setPeriodicFlushFrequencyMilliSeconds</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span> |
| </pre></div> |
| <div style='display:none;' class='raw-code'><pre>conf.setImmediateFlushEnabled(true); |
| conf.setOutputBufferSize(0); |
| conf.setPeriodicFlushFrequencyMilliSeconds(0);</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Enable immediate locking. So if there is already a writer wring to |
| the stream, opening another writer will fail because previous writer |
| already held a lock.</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">conf</span><span class="o">.</span><span class="n">setLockTimeout</span><span class="p">(</span><span class="n">DistributedLogConstants</span><span class="o">.</span><span class="n">LOCK_IMMEDIATE</span><span class="p">);</span> |
| </pre></div> |
| <div style='display:none;' class='raw-code'><pre>conf.setLockTimeout(DistributedLogConstants.LOCK_IMMEDIATE);</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Build the distributedlog namespace.</p> |
| <div class="highlight-python"><pre>DistributedLogNamespace namespace = DistributedLogNamespaceBuilder.newBuilder() |
| .conf(conf) |
| .uri(uri) |
| .regionId(DistributedLogConstants.LOCAL_REGION_ID) |
| .clientId("console-writer") |
| .build();</pre> |
| <div style='display:none;' class='raw-code'><pre>DistributedLogNamespace namespace = DistributedLogNamespaceBuilder.newBuilder() |
| .conf(conf) |
| .uri(uri) |
| .regionId(DistributedLogConstants.LOCAL_REGION_ID) |
| .clientId("console-writer") |
| .build();</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Open the writer.</p> |
| <div class="highlight-python"><pre>DistributedLogManager dlm = namespace.openLog("basic-stream-1"); |
| AsyncLogWriter writer = FutureUtils.result(dlm.openAsyncLogWriter());</pre> |
| <div style='display:none;' class='raw-code'><pre>DistributedLogManager dlm = namespace.openLog("basic-stream-1"); |
| AsyncLogWriter writer = FutureUtils.result(dlm.openAsyncLogWriter());</pre> |
| </div></div> |
| </li> |
| </ul> |
| </div> |
| <div class="section" id="write-records"> |
| <h2>Write Records<a class="headerlink" href="#write-records" title="Permalink to this headline">¶</a></h2> |
| <ul> |
| <li><p class="first">Construct a log record using <tt class="docutils literal"><span class="pre">System.currentTimeMillis()</span></tt> as the |
| <tt class="docutils literal"><span class="pre">TransactionID</span></tt>.</p> |
| <div class="highlight-python"><pre>byte[] data = ...; |
| LogRecord record = new LogRecord(System.currentTimeMillis(), data);</pre> |
| <div style='display:none;' class='raw-code'><pre>byte[] data = ...; |
| LogRecord record = new LogRecord(System.currentTimeMillis(), data);</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Write the log record.</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">Future</span><span class="o"><</span><span class="n">DLSN</span><span class="o">></span> <span class="n">writeFuture</span> <span class="o">=</span> <span class="n">writer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">record</span><span class="p">);</span> |
| </pre></div> |
| <div style='display:none;' class='raw-code'><pre>Future<DLSN> writeFuture = writer.write(record);</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Register a future listener on write completion.</p> |
| <div class="highlight-python"><pre>writeFuture.addEventListener(new FutureEventListener<DLSN>() { |
| @Override |
| public void onFailure(Throwable cause) { |
| // executed when write failed. |
| } |
| |
| @Override |
| public void onSuccess(DLSN value) { |
| // executed when write completed. |
| } |
| });</pre> |
| <div style='display:none;' class='raw-code'><pre>writeFuture.addEventListener(new FutureEventListener<DLSN>() { |
| @Override |
| public void onFailure(Throwable cause) { |
| // executed when write failed. |
| } |
| |
| @Override |
| public void onSuccess(DLSN value) { |
| // executed when write completed. |
| } |
| });</pre> |
| </div></div> |
| </li> |
| </ul> |
| </div> |
| <div class="section" id="close-the-writer"> |
| <h2>Close the writer<a class="headerlink" href="#close-the-writer" title="Permalink to this headline">¶</a></h2> |
| <ul> |
| <li><p class="first">Close the writer after usage.</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">FutureUtils</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="n">writer</span><span class="o">.</span><span class="n">asyncClose</span><span class="p">());</span> |
| </pre></div> |
| <div style='display:none;' class='raw-code'><pre>FutureUtils.result(writer.asyncClose());</pre> |
| </div></div> |
| </li> |
| </ul> |
| </div> |
| <div class="section" id="usage"> |
| <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> |
| <p>Run the example in the following steps:</p> |
| <ol class="arabic"> |
| <li><p class="first">Start the local bookkeeper cluster. After the bookkeeper cluster is |
| started, you could access it using distributedlog uri |
| <em>distributedlog://127.0.0.1:7000/messaging/distributedlog</em>.</p> |
| <div class="highlight-python"><pre>// dlog local ${zk-port} |
| ./distributedlog-core/bin/dlog local 7000</pre> |
| <div style='display:none;' class='raw-code'><pre>// dlog local ${zk-port} |
| ./distributedlog-core/bin/dlog local 7000</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Create the stream under the distributedlog uri.</p> |
| <div class="highlight-python"><pre>// Create Stream `basic-stream-1` |
| // dlog tool create -u ${distributedlog-uri} -r ${stream-prefix} -e ${stream-regex} |
| ./distributedlog-core/bin/dlog tool create -u distributedlog://127.0.0.1:7000/messaging/distributedlog -r basic-stream- -e 1</pre> |
| <div style='display:none;' class='raw-code'><pre>// Create Stream `basic-stream-1` |
| // dlog tool create -u ${distributedlog-uri} -r ${stream-prefix} -e ${stream-regex} |
| ./distributedlog-core/bin/dlog tool create -u distributedlog://127.0.0.1:7000/messaging/distributedlog -r basic-stream- -e 1</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Tailing the stream using <tt class="docutils literal"><span class="pre">TailReader</span></tt> to wait for new records.</p> |
| <div class="highlight-python"><pre>// Tailing Stream `basic-stream-1` |
| // runner run com.twitter.distributedlog.basic.TailReader ${distributedlog-uri} ${stream} |
| ./distributedlog-tutorials/distributedlog-basic/bin/runner run com.twitter.distributedlog.basic.TailReader distributedlog://127.0.0.1:7000/messaging/distributedlog basic-stream-1</pre> |
| <div style='display:none;' class='raw-code'><pre>// Tailing Stream `basic-stream-1` |
| // runner run com.twitter.distributedlog.basic.TailReader ${distributedlog-uri} ${stream} |
| ./distributedlog-tutorials/distributedlog-basic/bin/runner run com.twitter.distributedlog.basic.TailReader distributedlog://127.0.0.1:7000/messaging/distributedlog basic-stream-1</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Run the example to write records to the stream in a console.</p> |
| <div class="highlight-python"><pre>// Write Records into Stream `basic-stream-1` |
| // runner run com.twitter.distributedlog.basic.ConsoleWriter ${distributedlog-uri} ${stream} |
| ./distributedlog-tutorials/distributedlog-basic/bin/runner run com.twitter.distributedlog.basic.ConsoleWriter distributedlog://127.0.0.1:7000/messaging/distributedlog basic-stream-1</pre> |
| <div style='display:none;' class='raw-code'><pre>// Write Records into Stream `basic-stream-1` |
| // runner run com.twitter.distributedlog.basic.ConsoleWriter ${distributedlog-uri} ${stream} |
| ./distributedlog-tutorials/distributedlog-basic/bin/runner run com.twitter.distributedlog.basic.ConsoleWriter distributedlog://127.0.0.1:7000/messaging/distributedlog basic-stream-1</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Example output from <tt class="docutils literal"><span class="pre">ConsoleWriter</span></tt> and <tt class="docutils literal"><span class="pre">TailReader</span></tt>.</p> |
| <div class="highlight-python"><pre>// Output of `ConsoleWriter` |
| Opening log stream basic-stream-1 |
| [dlog] > test! |
| [dlog] > |
| |
| |
| // Output of `TailReader` |
| Opening log stream basic-stream-1 |
| Log stream basic-stream-1 is empty. |
| Wait for records starting from DLSN{logSegmentSequenceNo=1, entryId=0, slotId=0} |
| Received record DLSN{logSegmentSequenceNo=1, entryId=0, slotId=0} |
| """ |
| test! |
| """</pre> |
| <div style='display:none;' class='raw-code'><pre>// Output of `ConsoleWriter` |
| Opening log stream basic-stream-1 |
| [dlog] > test! |
| [dlog] > |
| |
| |
| // Output of `TailReader` |
| Opening log stream basic-stream-1 |
| Log stream basic-stream-1 is empty. |
| Wait for records starting from DLSN{logSegmentSequenceNo=1, entryId=0, slotId=0} |
| Received record DLSN{logSegmentSequenceNo=1, entryId=0, slotId=0} |
| """ |
| test! |
| """</pre> |
| </div></div> |
| </li> |
| <li><p class="first">Open another terminal to run <tt class="docutils literal"><span class="pre">ConsoleWriter</span></tt>. It would fail with |
| <tt class="docutils literal"><span class="pre">OwnershipAcquireFailedException</span></tt> as previous <tt class="docutils literal"><span class="pre">ConsoleWriter</span></tt> is |
| still holding lock on writing to stream <tt class="docutils literal"><span class="pre">basic-stream-1</span></tt>.</p> |
| <div class="highlight-python"><pre>Opening log stream basic-stream-1 |
| Exception in thread "main" com.twitter.distributedlog.exceptions.OwnershipAcquireFailedException: LockPath - /messaging/distributedlog/basic-stream-1/<default>/lock: Lock acquisition failed, the current owner is console-writer |
| at com.twitter.distributedlog.lock.ZKSessionLock$8.apply(ZKSessionLock.java:570) |
| at com.twitter.distributedlog.lock.ZKSessionLock$8.apply(ZKSessionLock.java:567) |
| at com.twitter.util.Future$$anonfun$map$1$$anonfun$apply$8.apply(Future.scala:1041) |
| at com.twitter.util.Try$.apply(Try.scala:13) |
| at com.twitter.util.Future$.apply(Future.scala:132) |
| at com.twitter.util.Future$$anonfun$map$1.apply(Future.scala:1041) |
| at com.twitter.util.Future$$anonfun$map$1.apply(Future.scala:1040) |
| at com.twitter.util.Promise$Transformer.liftedTree1$1(Promise.scala:112) |
| at com.twitter.util.Promise$Transformer.k(Promise.scala:112) |
| at com.twitter.util.Promise$Transformer.apply(Promise.scala:122) |
| at com.twitter.util.Promise$Transformer.apply(Promise.scala:103) |
| at com.twitter.util.Promise$$anon$1.run(Promise.scala:357) |
| at com.twitter.concurrent.LocalScheduler$Activation.run(Scheduler.scala:178) |
| at com.twitter.concurrent.LocalScheduler$Activation.submit(Scheduler.scala:136) |
| at com.twitter.concurrent.LocalScheduler.submit(Scheduler.scala:207) |
| at com.twitter.concurrent.Scheduler$.submit(Scheduler.scala:92) |
| at com.twitter.util.Promise.runq(Promise.scala:350) |
| at com.twitter.util.Promise.updateIfEmpty(Promise.scala:716) |
| at com.twitter.util.Promise.update(Promise.scala:694) |
| at com.twitter.util.Promise.setValue(Promise.scala:670) |
| at com.twitter.distributedlog.lock.ZKSessionLock$9.safeRun(ZKSessionLock.java:622) |
| at org.apache.bookkeeper.util.SafeRunnable.run(SafeRunnable.java:31) |
| at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:471) |
| at java.util.concurrent.FutureTask.run(FutureTask.java:262) |
| at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:178) |
| at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:292) |
| at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1145) |
| at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:615) |
| at java.lang.Thread.run(Thread.java:745)</pre> |
| <div style='display:none;' class='raw-code'><pre>Opening log stream basic-stream-1 |
| Exception in thread "main" com.twitter.distributedlog.exceptions.OwnershipAcquireFailedException: LockPath - /messaging/distributedlog/basic-stream-1/<default>/lock: Lock acquisition failed, the current owner is console-writer |
| at com.twitter.distributedlog.lock.ZKSessionLock$8.apply(ZKSessionLock.java:570) |
| at com.twitter.distributedlog.lock.ZKSessionLock$8.apply(ZKSessionLock.java:567) |
| at com.twitter.util.Future$$anonfun$map$1$$anonfun$apply$8.apply(Future.scala:1041) |
| at com.twitter.util.Try$.apply(Try.scala:13) |
| at com.twitter.util.Future$.apply(Future.scala:132) |
| at com.twitter.util.Future$$anonfun$map$1.apply(Future.scala:1041) |
| at com.twitter.util.Future$$anonfun$map$1.apply(Future.scala:1040) |
| at com.twitter.util.Promise$Transformer.liftedTree1$1(Promise.scala:112) |
| at com.twitter.util.Promise$Transformer.k(Promise.scala:112) |
| at com.twitter.util.Promise$Transformer.apply(Promise.scala:122) |
| at com.twitter.util.Promise$Transformer.apply(Promise.scala:103) |
| at com.twitter.util.Promise$$anon$1.run(Promise.scala:357) |
| at com.twitter.concurrent.LocalScheduler$Activation.run(Scheduler.scala:178) |
| at com.twitter.concurrent.LocalScheduler$Activation.submit(Scheduler.scala:136) |
| at com.twitter.concurrent.LocalScheduler.submit(Scheduler.scala:207) |
| at com.twitter.concurrent.Scheduler$.submit(Scheduler.scala:92) |
| at com.twitter.util.Promise.runq(Promise.scala:350) |
| at com.twitter.util.Promise.updateIfEmpty(Promise.scala:716) |
| at com.twitter.util.Promise.update(Promise.scala:694) |
| at com.twitter.util.Promise.setValue(Promise.scala:670) |
| at com.twitter.distributedlog.lock.ZKSessionLock$9.safeRun(ZKSessionLock.java:622) |
| at org.apache.bookkeeper.util.SafeRunnable.run(SafeRunnable.java:31) |
| at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:471) |
| at java.util.concurrent.FutureTask.run(FutureTask.java:262) |
| at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:178) |
| at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:292) |
| at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1145) |
| at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:615) |
| at java.lang.Thread.run(Thread.java:745)</pre> |
| </div></div> |
| </li> |
| </ol> |
| </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="../index.html">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 & Administration</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & 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="main.html">Tutorials</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="main.html#basic">Basic</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="main.html#messaging">Messaging</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="main.html#replicated-state-machines">Replicated State Machines</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="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">×</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/docs/tutorials/basic-1.rst" |
| rel="nofollow">Source</a> |
| |
| <a href="../_sources/tutorials/basic-1.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> |