You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@omid.apache.org by oh...@apache.org on 2018/12/04 08:27:24 UTC
[48/51] [partial] incubator-omid-site git commit: [wagon-git] commit
to branch asf-site 12/4/18 10:26 AM
http://git-wip-us.apache.org/repos/asf/incubator-omid-site/blob/9ccae1ee/client-failure-management.html
----------------------------------------------------------------------
diff --git a/client-failure-management.html b/client-failure-management.html
index 84983e9..887be71 100644
--- a/client-failure-management.html
+++ b/client-failure-management.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7 at 2018-09-20
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-12-04
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180920" />
+ <meta name="Date-Revision-yyyymmdd" content="20181204" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Omid – Management of Client Failures</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -117,7 +117,9 @@
</li>
<li> <a href="index.html" title="About">About</a>
</li>
- <li> <a href="license.html" title="Licenses">Licenses</a>
+ <li> <a href="licenses.html" title="Licenses">Licenses</a>
+</li>
+ <li> <a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li> <a href="modules.html" title="Project Modules">Project Modules</a>
</li>
@@ -125,11 +127,11 @@
</li>
<li> <a href="plugins.html" title="Plugins">Plugins</a>
</li>
- <li> <a href="team-list.html" title="Team">Team</a>
+ <li> <a href="scm.html" title="Source Code Management">Source Code Management</a>
</li>
- <li> <a href="source-repository.html" title="Source Code Management">Source Code Management</a>
+ <li> <a href="summary.html" title="Summary">Summary</a>
</li>
- <li> <a href="project-summary.html" title="Summary">Summary</a>
+ <li> <a href="team.html" title="Team">Team</a>
</li>
</ul>
</li>
@@ -194,11 +196,11 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.9.0.0
+ <li id="projectVersion">Version: 1.0.0
</li>
- <li id="publishDate" class="pull-right">Last Published: 2018-09-20</li>
+ <li id="publishDate" class="pull-right">Last Published: 2018-12-04</li>
</ul>
</div>
@@ -219,14 +221,13 @@
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>Management of Client Failures</h1>
+-->
+<h1>Management of Client Failures</h1>
<p>Upon user application crashes, Transactional Clients may leave some orphaned data in the datastore, even though the data in the datastore is kept in a consistent state. When another Transactional Client comes across this data, it will check whether the associated transaction was committed or not. If the data belongs to a transaction which has not been committed, and the transaction id is lower than the low watermark, then the data is deleted, since it belongs to a transaction that can never be committed.</p>
-<p>If data belongs to a transaction that was already committed, this means that the Transactional Client crashed between sending the commit request and completing the transaction in the commit table. This means that shadow cells have not been deleted. The Transactional Client reading will write the shadow cell for the orphan data. However, it is not able to complete the transaction in the commit table as it can not guarantee that shadow cells have been written for all cells in the transaction, since only the crashed client knew which cells it had written to. Consequently, this means that the commit table can grow indefinitely. Initially, this flaw should not cause many problems, since:</p>
-
+<p>If data belongs to a transaction that was already committed, this means that the Transactional Client crashed between sending the commit request and completing the transaction in the commit table. This means that shadow cells have not been deleted. The Transactional Client reading will write the shadow cell for the orphan data. However, it is not able to complete the transaction in the commit table as it can not guarantee that shadow cells have been written for all cells in the transaction, since only the crashed client knew which cells it had written to. Consequently, this means that the commit table can grow indefinitely. Initially, this flaw should not cause many problems, since:</p>
<ul>
-
+
<li>the amount of data stored is small (16 bytes)</li>
-
<li>the number of clients expected to fail between commit and completion is low * the data is stored on persistent storage. It is not bounded by memory.</li>
</ul>
<p>For example, if 1% of all Transactional Clients are expected to crash at this exact point in time, while the system is writing, on average, 100,000 transactions per second, the amount of data required to store these commit table entries for a whole year would be around 500 GB. A single disk could hold this.</p>
http://git-wip-us.apache.org/repos/asf/incubator-omid-site/blob/9ccae1ee/coding-guide-and-style.html
----------------------------------------------------------------------
diff --git a/coding-guide-and-style.html b/coding-guide-and-style.html
index 7266f7f..9544881 100644
--- a/coding-guide-and-style.html
+++ b/coding-guide-and-style.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7 at 2018-09-20
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-12-04
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180920" />
+ <meta name="Date-Revision-yyyymmdd" content="20181204" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Omid – Coding Guide</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -117,7 +117,9 @@
</li>
<li> <a href="index.html" title="About">About</a>
</li>
- <li> <a href="license.html" title="Licenses">Licenses</a>
+ <li> <a href="licenses.html" title="Licenses">Licenses</a>
+</li>
+ <li> <a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li> <a href="modules.html" title="Project Modules">Project Modules</a>
</li>
@@ -125,11 +127,11 @@
</li>
<li> <a href="plugins.html" title="Plugins">Plugins</a>
</li>
- <li> <a href="team-list.html" title="Team">Team</a>
+ <li> <a href="scm.html" title="Source Code Management">Source Code Management</a>
</li>
- <li> <a href="source-repository.html" title="Source Code Management">Source Code Management</a>
+ <li> <a href="summary.html" title="Summary">Summary</a>
</li>
- <li> <a href="project-summary.html" title="Summary">Summary</a>
+ <li> <a href="team.html" title="Team">Team</a>
</li>
</ul>
</li>
@@ -194,11 +196,11 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.9.0.0
+ <li id="projectVersion">Version: 1.0.0
</li>
- <li id="publishDate" class="pull-right">Last Published: 2018-09-20</li>
+ <li id="publishDate" class="pull-right">Last Published: 2018-12-04</li>
</ul>
</div>
@@ -219,91 +221,72 @@
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>Coding Guide</h1>
+-->
+<h1>Coding Guide</h1>
<p>The basic principle is to always write code that is testable, easy to understand, extensible, resistant to bugs. Code is written once but read by many people so we need to focus also on the next person that will read it:</p>
-
<ul>
-
+
<li>Keep it simple</li>
-
<li>Test your code</li>
-
<li><a class="externalLink" href="http://programmer.97things.oreilly.com/wiki/index.php/The_Single_Responsibility_Principle">Single responsibility principle</a></li>
-
<li>Try to maintain components <a class="externalLink" href="http://programmer.97things.oreilly.com/wiki/index.php/Cohesion_and_Coupling_matter">loosely coupled</a></li>
-
<li>Do not abuse of comments:
-
<ul>
-
+
<li>Choose names that reveal intent for modules, packages, classes, methods, variables, constants, etc.</li>
-
<li>Do not use comments for excuse bad code or when appropriate naming is enough</li>
-
<li>Comments are good when they provide context (Explain why, not how) or explain things that happen in the real world</li>
- </ul></li>
-
+</ul>
+</li>
<li>Follow the <a class="externalLink" href="http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule">Boy Scout Rule</a></li>
-
<li>Don’t reinvent the wheel:
-
<ul>
-
+
<li>Use patterns when possible</li>
-
<li>Use proven libraries for (e.g. Apache commons, guava, etc.)</li>
- </ul></li>
-
+</ul>
+</li>
<li>Refactor when necessary
-
<ul>
-
+
<li>When adding a new feature and the context is not appropriate, refactor first in a separate commit/s</li>
- </ul></li>
-
+</ul>
+</li>
<li>Use <a class="externalLink" href="http://testng.org/">TestNG</a> for testing instead of JUnit</li>
</ul>
<h1>Coding Style</h1>
<p>Omid coding style should follow general rules found in <a class="externalLink" href="https://google.github.io/styleguide/javaguide.html">Google’s Code Style for Java</a>, with the following modifications:</p>
-
<ul>
-
+
<li>Lines can be up to 120 characters long</li>
-
<li>Block indentation should be:
-
<ul>
-
+
<li>4 spaces</li>
-
<li>Tabs not allowed</li>
- </ul></li>
-
+</ul>
+</li>
<li>Always use curly braces for code blocks, even for single-line ‘ifs’ and ‘elses’</li>
-
<li>Do not include @author tags in any javadoc</li>
-
<li>Import ordering and spacing:
-
<ul>
-
+
<li>Try to organize imports alphabetically in blocks with this format:
-
<ul>
-
+
<li>A first block of imports from external libraries</li>
-
<li>A second block of imports from Java libraries</li>
-
<li>Finally a third block with <tt>static</tt> imports</li>
- </ul></li>
-
+</ul>
+</li>
<li>Example:</li>
- </ul></li>
+</ul>
+</li>
</ul>
-<div class="source">
-<div class="source"><pre class="prettyprint"> import com.google.common.base.Charsets;
+<div>
+<div>
+<pre class="source"> import com.google.common.base.Charsets;
import com.yahoo.omid.zk.ZKUtils.ZKException;
import com.yahoo.statemachine.StateMachine.Event;
import com.yahoo.statemachine.StateMachine.Fsm;
@@ -322,7 +305,8 @@
import static com.yahoo.omid.zk.ZKUtils.provideZookeeperClient;
...
</pre></div></div>
-<p>The complete rules (specified with <a class="externalLink" href="https://github.com/checkstyle/checkstyle">Checkstyle</a>) can be found in the <tt>misc/omid_checks.xml</tt> file. A summary of the current status of the style in the Omid project can be found in the <a href="./checkstyle-aggregate.html">checkstyle-aggregate</a> page.</p>
+
+<p>The complete rules (specified with <a class="externalLink" href="https://github.com/checkstyle/checkstyle">Checkstyle</a>) can be found in the <tt>misc/omid_checks.xml</tt> file. A summary of the current status of the style in the Omid project can be found in the <a href="checkstyle-aggregate">checkstyle-aggregate</a> page.</p>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-omid-site/blob/9ccae1ee/cpd.html
----------------------------------------------------------------------
diff --git a/cpd.html b/cpd.html
index 83bec05..182f9de 100644
--- a/cpd.html
+++ b/cpd.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7 at 2018-09-26
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-12-04
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180926" />
+ <meta name="Date-Revision-yyyymmdd" content="20181204" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Omid – CPD Results</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -117,7 +117,9 @@
</li>
<li> <a href="index.html" title="About">About</a>
</li>
- <li> <a href="license.html" title="Licenses">Licenses</a>
+ <li> <a href="licenses.html" title="Licenses">Licenses</a>
+</li>
+ <li> <a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li> <a href="modules.html" title="Project Modules">Project Modules</a>
</li>
@@ -125,11 +127,11 @@
</li>
<li> <a href="plugins.html" title="Plugins">Plugins</a>
</li>
- <li> <a href="team-list.html" title="Team">Team</a>
+ <li> <a href="scm.html" title="Source Code Management">Source Code Management</a>
</li>
- <li> <a href="source-repository.html" title="Source Code Management">Source Code Management</a>
+ <li> <a href="summary.html" title="Summary">Summary</a>
</li>
- <li> <a href="project-summary.html" title="Summary">Summary</a>
+ <li> <a href="team.html" title="Team">Team</a>
</li>
</ul>
</li>
@@ -194,11 +196,11 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="projectVersion">Version: 0.9.0.0
+ <li id="projectVersion">Version: 1.0.0
</li>
- <li id="publishDate" class="pull-right">Last Published: 2018-09-26</li>
+ <li id="publishDate" class="pull-right">Last Published: 2018-12-04</li>
</ul>
</div>
@@ -220,24 +222,24 @@
<tr class="b">
<td>org/apache/omid/examples/BasicExample.java</td>
<td>Omid Client Examples</td>
-<td><a href="./xref/org/apache/omid/examples/BasicExample.html#L90">90</a></td></tr>
+<td><a href="./xref/org/apache/omid/examples/BasicExample.html#L93">93</a></td></tr>
<tr class="a">
<td>org/apache/omid/examples/ConfigurationExample.java</td>
<td>Omid Client Examples</td>
-<td><a href="./xref/org/apache/omid/examples/ConfigurationExample.html#L107">107</a></td></tr>
+<td><a href="./xref/org/apache/omid/examples/ConfigurationExample.html#L110">110</a></td></tr>
<tr class="b"><td colspan='3'>
<div>
<pre> LOG.info("Transaction {} STARTED", tx);
Put row1 = new Put(exampleRow1);
- row1.add(family, qualifier, dataValue1);
+ row1.addColumn(family, qualifier, dataValue1);
txTable.put(tx, row1);
LOG.info("Transaction {} trying to write a new value in [TABLE:ROW/CF/Q] => {}:{}/{}/{} = {} ",
tx, userTableName, Bytes.toString(exampleRow1), Bytes.toString(family),
Bytes.toString(qualifier), Bytes.toString(dataValue1));
Put row2 = new Put(exampleRow2);
- row2.add(family, qualifier, dataValue2);
+ row2.addColumn(family, qualifier, dataValue2);
txTable.put(tx, row2);
LOG.info("Transaction {} trying to write a new value in [TABLE:ROW/CF/Q] => {}:{}/{}/{} = {} ",
tx, userTableName, Bytes.toString(exampleRow2), Bytes.toString(family),
@@ -253,11 +255,11 @@
<tr class="b">
<td>org/apache/omid/examples/BasicExample.java</td>
<td>Omid Client Examples</td>
-<td><a href="./xref/org/apache/omid/examples/BasicExample.html#L64">64</a></td></tr>
+<td><a href="./xref/org/apache/omid/examples/BasicExample.html#L66">66</a></td></tr>
<tr class="a">
<td>org/apache/omid/examples/ConfigurationExample.java</td>
<td>Omid Client Examples</td>
-<td><a href="./xref/org/apache/omid/examples/ConfigurationExample.html#L47">47</a></td></tr>
+<td><a href="./xref/org/apache/omid/examples/ConfigurationExample.html#L49">49</a></td></tr>
<tr class="b"><td colspan='3'>
<div>
<pre> private static final Logger LOG = LoggerFactory.getLogger(BasicExample.class);