Modified: cassandra/site/publish/doc/latest/development/how_to_commit.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/how_to_commit.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/how_to_commit.html (original) +++ cassandra/site/publish/doc/latest/development/how_to_commit.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Frequently Asked Questions" href="../faq/index.html"/> <link rel="prev" title="Review Checklist" href="how_to_review.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Working on Documentation" href="documentation.html"/> <link rel="prev" title="Review Checklist" href="how_to_review.html"/> </head> <body> @@ -63,7 +63,7 @@ - <li><a href="./">Cassandra Development</a></li> + <li><a href="./">Contributing to Cassandra</a></li> @@ -132,13 +132,15 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> @@ -171,19 +173,19 @@ <dd><ol class="first last arabic simple"> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></li> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">12345-3.3.patch</span></code> (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)</li> -<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">âamend</span></code></li> +<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-amend</span></code></li> </ol> </dd> <dt>On trunk:</dt> <dd><ol class="first last arabic simple"> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.3</span> <span class="pre">-s</span> <span class="pre">ours</span></code></li> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">12345-trunk.patch</span></code> (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)</li> -<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">âamend</span></code></li> +<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-amend</span></code></li> </ol> </dd> <dt>On any branch:</dt> <dd><ol class="first last arabic simple"> -<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.3</span> <span class="pre">trunk</span> <span class="pre">âatomic</span></code></li> +<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.3</span> <span class="pre">trunk</span> <span class="pre">-atomic</span></code></li> </ol> </dd> </dl> @@ -199,7 +201,7 @@ <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></li> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">-1</span> <span class="pre"><sha-of-3.3-commit></span></code></li> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre"><sha-of-3.3-commit>.patch</span></code> (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)</li> -<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">âamend</span></code></li> +<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-amend</span></code></li> </ol> </dd> <dt>On trunk:</dt> @@ -207,12 +209,12 @@ <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.3</span> <span class="pre">-s</span> <span class="pre">ours</span></code></li> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">-1</span> <span class="pre"><sha-of-trunk-commit></span></code></li> <li><code class="docutils literal"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre"><sha-of-trunk-commit>.patch</span></code> (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)</li> -<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">âamend</span></code></li> +<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-amend</span></code></li> </ol> </dd> <dt>On any branch:</dt> <dd><ol class="first last arabic simple"> -<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.3</span> <span class="pre">trunk</span> <span class="pre">âatomic</span></code></li> +<li><code class="docutils literal"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.3</span> <span class="pre">trunk</span> <span class="pre">-atomic</span></code></li> </ol> </dd> </dl> @@ -220,7 +222,7 @@ <p class="first admonition-title">Tip</p> <p>Notes on git flags: <code class="docutils literal"><span class="pre">-3</span></code> flag to am and apply will instruct git to perform a 3-way merge for you. If a conflict is detected, you can either resolve it manually or invoke git mergetool - for both am and apply.</p> -<p class="last"><code class="docutils literal"><span class="pre">âatomic</span></code> flag to git push does the obvious thing: pushes all or nothing. Without the flag, the command is equivalent to running git push once per each branch. This is nifty in case a race condition happens - you wonât push half the branches, blocking other committersâ progress while you are resolving the issue.</p> +<p class="last"><code class="docutils literal"><span class="pre">-atomic</span></code> flag to git push does the obvious thing: pushes all or nothing. Without the flag, the command is equivalent to running git push once per each branch. This is nifty in case a race condition happens - you wonât push half the branches, blocking other committersâ progress while you are resolving the issue.</p> </div> <div class="admonition tip"> <p class="first admonition-title">Tip</p> @@ -234,7 +236,7 @@ curl -O <a class="reference external" hr <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> - <a href="../faq/index.html" class="btn btn-default pull-right " role="button" title="Frequently Asked Questions" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + <a href="documentation.html" class="btn btn-default pull-right " role="button" title="Working on Documentation" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> <a href="how_to_review.html" class="btn btn-default" role="button" title="Review Checklist" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
Modified: cassandra/site/publish/doc/latest/development/how_to_review.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/how_to_review.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/how_to_review.html (original) +++ cassandra/site/publish/doc/latest/development/how_to_review.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="How-to Commit" href="how_to_commit.html"/> <link rel="prev" title="Code Style" href="code_style.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="How-to Commit" href="how_to_commit.html"/> <link rel="prev" title="Code Style" href="code_style.html"/> </head> <body> @@ -63,7 +63,7 @@ - <li><a href="./">Cassandra Development</a></li> + <li><a href="./">Contributing to Cassandra</a></li> @@ -132,13 +132,15 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Review Checklist</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> @@ -157,7 +159,7 @@ <div class="container"> <div class="section" id="review-checklist"> -<h1>Review Checklist<a class="headerlink" href="#review-checklist" title="Permalink to this headline">¶</a></h1> +<span id="how-to-review"></span><h1>Review Checklist<a class="headerlink" href="#review-checklist" title="Permalink to this headline">¶</a></h1> <p>When reviewing tickets in Apache JIRA, the following items should be covered as part of the review process:</p> <p><strong>General</strong></p> <blockquote> Modified: cassandra/site/publish/doc/latest/development/ide.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/ide.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/ide.html (original) +++ cassandra/site/publish/doc/latest/development/ide.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Testing" href="testing.html"/> <link rel="prev" title="Cassandra Development" href="index.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Testing" href="testing.html"/> <link rel="prev" title="Getting Started" href="gettingstarted.html"/> </head> <body> @@ -63,7 +63,7 @@ - <li><a href="./">Cassandra Development</a></li> + <li><a href="./">Contributing to Cassandra</a></li> @@ -132,7 +132,8 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Building and IDE Integration</a><ul> <li class="toctree-l3"><a class="reference internal" href="#building-from-source">Building From Source</a></li> <li class="toctree-l3"><a class="reference internal" href="#setting-up-cassandra-in-intellij-idea">Setting up Cassandra in IntelliJ IDEA</a></li> @@ -144,6 +145,7 @@ <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> @@ -291,7 +293,7 @@ <a href="testing.html" class="btn btn-default pull-right " role="button" title="Testing" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> - <a href="index.html" class="btn btn-default" role="button" title="Cassandra Development" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + <a href="gettingstarted.html" class="btn btn-default" role="button" title="Getting Started" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> </div> Modified: cassandra/site/publish/doc/latest/development/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/index.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/index.html (original) +++ cassandra/site/publish/doc/latest/development/index.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="next" title="Building and IDE Integration" href="ide.html"/> <link rel="prev" title="Troubleshooting" href="../troubleshooting/index.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="next" title="Getting Started" href="gettingstarted.html"/> <link rel="prev" title="Troubleshooting" href="../troubleshooting/index.html"/> </head> <body> @@ -65,7 +65,7 @@ - <li>Cassandra Development</li> + <li>Contributing to Cassandra</li> </ul> </div> @@ -130,13 +130,15 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="current reference internal" href="#">Cassandra Development</a><ul> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to Cassandra</a><ul> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> @@ -154,10 +156,19 @@ <div class="content doc-content"> <div class="container"> - <div class="section" id="cassandra-development"> -<h1>Cassandra Development<a class="headerlink" href="#cassandra-development" title="Permalink to this headline">¶</a></h1> + <div class="section" id="contributing-to-cassandra"> +<h1>Contributing to Cassandra<a class="headerlink" href="#contributing-to-cassandra" title="Permalink to this headline">¶</a></h1> <div class="toctree-wrapper compound"> <ul> +<li class="toctree-l1"><a class="reference internal" href="gettingstarted.html">Getting Started</a><ul> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#initial-contributions">Initial Contributions</a></li> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#updating-documentation">Updating documentation</a></li> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#answering-questions-on-the-user-list">Answering questions on the user list</a></li> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#reviewing-and-testing-a-submitted-patch">Reviewing and testing a submitted patch</a></li> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#investigate-and-or-fix-a-reported-bug">Investigate and/or fix a reported bug</a></li> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#create-unit-tests-and-dtests">Create unit tests and Dtests</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="ide.html">Building and IDE Integration</a><ul> <li class="toctree-l2"><a class="reference internal" href="ide.html#building-from-source">Building From Source</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html#setting-up-cassandra-in-intellij-idea">Setting up Cassandra in IntelliJ IDEA</a></li> @@ -188,6 +199,14 @@ </li> <li class="toctree-l1"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l1"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l1"><a class="reference internal" href="documentation.html">Working on Documentation</a><ul> +<li class="toctree-l2"><a class="reference internal" href="documentation.html#how-cassandra-is-documented">How Cassandra is documented</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html#github-based-work-flow">GitHub based work flow</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html#jira-based-work-flow">Jira based work flow</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html#working-on-documents-locally-using-sphinx">Working on documents locally using Sphinx</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html#notes-for-committers">Notes for committers</a></li> +</ul> +</li> </ul> </div> </div> @@ -197,7 +216,7 @@ <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> - <a href="ide.html" class="btn btn-default pull-right " role="button" title="Building and IDE Integration" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + <a href="gettingstarted.html" class="btn btn-default pull-right " role="button" title="Getting Started" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> <a href="../troubleshooting/index.html" class="btn btn-default" role="button" title="Troubleshooting" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> Modified: cassandra/site/publish/doc/latest/development/patches.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/patches.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/patches.html (original) +++ cassandra/site/publish/doc/latest/development/patches.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Code Style" href="code_style.html"/> <link rel="prev" title="Testing" href="testing.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Code Style" href="code_style.html"/> <link rel="prev" title="Testing" href="testing.html"/> </head> <body> @@ -63,7 +63,7 @@ - <li><a href="./">Cassandra Development</a></li> + <li><a href="./">Contributing to Cassandra</a></li> @@ -132,7 +132,8 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Contributing Code Changes</a><ul> @@ -144,6 +145,7 @@ <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> @@ -162,7 +164,7 @@ <div class="container"> <div class="section" id="contributing-code-changes"> -<h1>Contributing Code Changes<a class="headerlink" href="#contributing-code-changes" title="Permalink to this headline">¶</a></h1> +<span id="patches"></span><h1>Contributing Code Changes<a class="headerlink" href="#contributing-code-changes" title="Permalink to this headline">¶</a></h1> <div class="section" id="choosing-what-to-work-on"> <h2>Choosing What to Work on<a class="headerlink" href="#choosing-what-to-work-on" title="Permalink to this headline">¶</a></h2> <p>Submitted patches can include bug fixes, changes to the Java code base, improvements for tooling (both Java or Python), documentation, testing or any other changes that requires changing the code base. Although the process of contributing code is always the same, the amount of work and time it takes to get a patch accepted also depends on the kind of issue you’re addressing.</p> Modified: cassandra/site/publish/doc/latest/development/testing.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/testing.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/testing.html (original) +++ cassandra/site/publish/doc/latest/development/testing.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Contributing Code Changes" href="patches.html"/> <link rel="prev" title="Building and IDE Integration" href="ide.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Contributing Code Changes" href="patches.html"/> <link rel="prev" title="Building and IDE Integration" href="ide.html"/> </head> <body> @@ -63,7 +63,7 @@ - <li><a href="./">Cassandra Development</a></li> + <li><a href="./">Contributing to Cassandra</a></li> @@ -132,7 +132,8 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Testing</a><ul> <li class="toctree-l3"><a class="reference internal" href="#unit-testing">Unit Testing</a></li> @@ -144,6 +145,7 @@ <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> @@ -162,7 +164,7 @@ <div class="container"> <div class="section" id="testing"> -<h1>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h1> +<span id="id1"></span><h1>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h1> <p>Creating tests is one of the most important and also most difficult parts of developing Cassandra. There are different ways to test your code depending on what you’re working on.</p> <div class="section" id="unit-testing"> <h2>Unit Testing<a class="headerlink" href="#unit-testing" title="Permalink to this headline">¶</a></h2> @@ -207,12 +209,16 @@ <p>Performance tests for Cassandra are a special breed of tests that are not part of the usual patch contribution process. In fact you can contribute tons of patches to Cassandra without ever running performance tests. They are important however when working on performance improvements, as such improvements must be measurable.</p> <div class="section" id="cassandra-stress-tool"> <h3>Cassandra Stress Tool<a class="headerlink" href="#cassandra-stress-tool" title="Permalink to this headline">¶</a></h3> -<p>TODO: <a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA-12365";>CASSANDRA-12365</a></p> +<p>See <a class="reference internal" href="../tools/cassandra_stress.html#cassandra-stress"><span class="std std-ref">Cassandra Stress</span></a></p> </div> <div class="section" id="cstar-perf"> <h3>cstar_perf<a class="headerlink" href="#cstar-perf" title="Permalink to this headline">¶</a></h3> <p>Another tool available on github is <a class="reference external" href="https://github.com/datastax/cstar_perf";>cstar_perf</a> that can be used for intensive performance testing in large clusters or locally. Please refer to the project page on how to set it up and how to use it.</p> </div> +<div class="section" id="circleci"> +<h3>CircleCI<a class="headerlink" href="#circleci" title="Permalink to this headline">¶</a></h3> +<p>Cassandra ships with a default <a class="reference external" href="https://circleci.com";>CircleCI</a> configuration, to enable running tests on your branches, you need to go the CircleCI website, click “Login” and log in with your github account. Then you need to give CircleCI permission to watch your repositories. Once you have done that, you can optionally configure CircleCI to run tests in parallel - click “Projects”, then your github account and then click the settings for the project. If you leave the parallelism at 1 for Cassandra, only <code class="docutils literal"><span class="pre">ant</span> <span class="pre">eclipse-warnings</span></code> and <code class="docutils literal"><span class="pre">ant</span> <span class="pre">test</span></code> will be run. If you up the parallelism to 4, it also runs <code class="docutils literal"><span class="pre">ant</span> <span class="pre">long-test</span></code>, <code class="docutils literal"><span class="pre">a nt</span> <span class="pre">test-compression</span></code> and <code class="docutils literal"><span class="pre">ant</span> <span class="pre">stress-test</span></code></p> +</div> </div> </div> Modified: cassandra/site/publish/doc/latest/faq/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/faq/index.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/faq/index.html (original) +++ cassandra/site/publish/doc/latest/faq/index.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="next" title="Reporting Bugs and Contributing" href="../bugs.html"/> <link rel="prev" title="How-to Commit" href="../development/how_to_commit.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="next" title="Reporting Bugs and Contributing" href="../bugs.html"/> <link rel="prev" title="Working on Documentation" href="../development/documentation.html"/> </head> <body> @@ -130,7 +130,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Frequently Asked Questions</a><ul> <li class="toctree-l2"><a class="reference internal" href="#why-can-t-i-set-listen-address-to-listen-on-0-0-0-0-all-my-addresses">Why can’t I set <code class="docutils literal"><span class="pre">listen_address</span></code> to listen on 0.0.0.0 (all my addresses)?</a></li> <li class="toctree-l2"><a class="reference internal" href="#what-ports-does-cassandra-use">What ports does Cassandra use?</a></li> @@ -202,7 +202,7 @@ to make things resolve correctly (<code <div class="section" id="what-ports-does-cassandra-use"> <span id="what-ports"></span><h2>What ports does Cassandra use?<a class="headerlink" href="#what-ports-does-cassandra-use" title="Permalink to this headline">¶</a></h2> <p>By default, Cassandra uses 7000 for cluster communication (7001 if SSL is enabled), 9042 for native protocol clients, -and 7199 for JMX (and 9160 for the deprecated Thrift interface). The internode communication and native protocol ports +and 7199 for JMX. The internode communication and native protocol ports are configurable in the <a class="reference internal" href="../configuration/cassandra_config_file.html#cassandra-yaml"><span class="std std-ref">Cassandra Configuration File</span></a>. The JMX port is configurable in <code class="docutils literal"><span class="pre">cassandra-env.sh</span></code> (through JVM options). All ports are TCP.</p> </div> @@ -228,15 +228,16 @@ token on the next restart.</p> </div> <div class="section" id="can-i-change-the-replication-factor-a-a-keyspace-on-a-live-cluster"> <span id="change-replication-factor"></span><h2>Can I change the replication factor (a a keyspace) on a live cluster?<a class="headerlink" href="#can-i-change-the-replication-factor-a-a-keyspace-on-a-live-cluster" title="Permalink to this headline">¶</a></h2> -<p>Yes, but it will require running repair (or cleanup) to change the replica count of existing data:</p> +<p>Yes, but it will require running a full repair (or cleanup) to change the replica count of existing data:</p> <ul class="simple"> <li><a class="reference internal" href="../cql/ddl.html#alter-keyspace-statement"><span class="std std-ref">Alter</span></a> the replication factor for desired keyspace (using cqlsh for instance).</li> <li>If you’re reducing the replication factor, run <code class="docutils literal"><span class="pre">nodetool</span> <span class="pre">cleanup</span></code> on the cluster to remove surplus replicated data. Cleanup runs on a per-node basis.</li> -<li>If you’re increasing the replication factor, run <code class="docutils literal"><span class="pre">nodetool</span> <span class="pre">repair</span></code> to ensure data is replicated according to the new +<li>If you’re increasing the replication factor, run <code class="docutils literal"><span class="pre">nodetool</span> <span class="pre">repair</span> <span class="pre">-full</span></code> to ensure data is replicated according to the new configuration. Repair runs on a per-replica set basis. This is an intensive process that may result in adverse cluster performance. It’s highly recommended to do rolling repairs, as an attempt to repair the entire cluster at once will -most likely swamp it.</li> +most likely swamp it. Note that you will need to run a full repair (<code class="docutils literal"><span class="pre">-full</span></code>) to make sure that already repaired +sstables are not skipped.</li> </ul> </div> <div class="section" id="can-i-store-large-blobs-in-cassandra"> @@ -373,7 +374,7 @@ more than 10 min. Running the above comm <a href="../bugs.html" class="btn btn-default pull-right " role="button" title="Reporting Bugs and Contributing" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> - <a href="../development/how_to_commit.html" class="btn btn-default" role="button" title="How-to Commit" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + <a href="../development/documentation.html" class="btn btn-default" role="button" title="Working on Documentation" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> </div> Modified: cassandra/site/publish/doc/latest/genindex.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/genindex.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/genindex.html (original) +++ cassandra/site/publish/doc/latest/genindex.html Tue May 16 02:01:22 2017 @@ -60,7 +60,7 @@ extra-footer: ' <li class="toctree-l1"><a class="reference internal" href="operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/getting_started/configuring.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/getting_started/configuring.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/getting_started/configuring.html (original) +++ cassandra/site/publish/doc/latest/getting_started/configuring.html Tue May 16 02:01:22 2017 @@ -144,7 +144,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/getting_started/drivers.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/getting_started/drivers.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/getting_started/drivers.html (original) +++ cassandra/site/publish/doc/latest/getting_started/drivers.html Tue May 16 02:01:22 2017 @@ -142,6 +142,7 @@ <li class="toctree-l3"><a class="reference internal" href="#go">Go</a></li> <li class="toctree-l3"><a class="reference internal" href="#haskell">Haskell</a></li> <li class="toctree-l3"><a class="reference internal" href="#rust">Rust</a></li> +<li class="toctree-l3"><a class="reference internal" href="#perl">Perl</a></li> </ul> </li> </ul> @@ -153,7 +154,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -270,6 +271,12 @@ version and functionality supported by a <li><a class="reference external" href="https://github.com/neich/rust-cql";>Rust CQL</a></li> </ul> </div> +<div class="section" id="perl"> +<h2>Perl<a class="headerlink" href="#perl" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference external" href="https://github.com/tvdw/perl-dbd-cassandra";>Cassandra::Client and DBD::Cassandra</a></li> +</ul> +</div> </div> Modified: cassandra/site/publish/doc/latest/getting_started/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/getting_started/index.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/getting_started/index.html (original) +++ cassandra/site/publish/doc/latest/getting_started/index.html Tue May 16 02:01:22 2017 @@ -136,7 +136,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -190,6 +190,7 @@ Cassandra.</p> <li class="toctree-l2"><a class="reference internal" href="drivers.html#go">Go</a></li> <li class="toctree-l2"><a class="reference internal" href="drivers.html#haskell">Haskell</a></li> <li class="toctree-l2"><a class="reference internal" href="drivers.html#rust">Rust</a></li> +<li class="toctree-l2"><a class="reference internal" href="drivers.html#perl">Perl</a></li> </ul> </li> </ul> Modified: cassandra/site/publish/doc/latest/getting_started/installing.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/getting_started/installing.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/getting_started/installing.html (original) +++ cassandra/site/publish/doc/latest/getting_started/installing.html Tue May 16 02:01:22 2017 @@ -143,7 +143,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/getting_started/querying.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/getting_started/querying.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/getting_started/querying.html (original) +++ cassandra/site/publish/doc/latest/getting_started/querying.html Tue May 16 02:01:22 2017 @@ -142,7 +142,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/index.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/index.html (original) +++ cassandra/site/publish/doc/latest/index.html Tue May 16 02:01:22 2017 @@ -102,6 +102,17 @@ <h3>Main documentation</h3> +<div> +<form id="doc-search-form" action="search.html" method="get" role="search"> + <div class="form-group"> + Search the documentation: + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> +</form><br /> +</div> + <table class="contentstable doc-landing-table" align="center"> <tr> <td class="left-column"> Modified: cassandra/site/publish/doc/latest/objects.inv URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/objects.inv?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== Binary files - no diff available. Modified: cassandra/site/publish/doc/latest/operating/backups.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/backups.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/backups.html (original) +++ cassandra/site/publish/doc/latest/operating/backups.html Tue May 16 02:01:22 2017 @@ -148,7 +148,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/bloom_filters.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/bloom_filters.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/bloom_filters.html (original) +++ cassandra/site/publish/doc/latest/operating/bloom_filters.html Tue May 16 02:01:22 2017 @@ -151,7 +151,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/bulk_loading.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/bulk_loading.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/bulk_loading.html (original) +++ cassandra/site/publish/doc/latest/operating/bulk_loading.html Tue May 16 02:01:22 2017 @@ -148,7 +148,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/cdc.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/cdc.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/cdc.html (original) +++ cassandra/site/publish/doc/latest/operating/cdc.html Tue May 16 02:01:22 2017 @@ -155,7 +155,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/compaction.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/compaction.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/compaction.html (original) +++ cassandra/site/publish/doc/latest/operating/compaction.html Tue May 16 02:01:22 2017 @@ -166,7 +166,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -409,7 +409,7 @@ experiment with settings without affecti <p>and the attribute to change is <code class="docutils literal"><span class="pre">CompactionParameters</span></code> or <code class="docutils literal"><span class="pre">CompactionParametersJson</span></code> if you use jconsole or jmc. The syntax for the json version is the same as you would use in an <a class="reference internal" href="../cql/ddl.html#alter-table-statement"><span class="std std-ref">ALTER TABLE</span></a> statement - for example:</p> -<div class="highlight-none"><div class="highlight"><pre>{ 'class': 'LeveledCompactionStrategy', 'sstable_size_in_mb': 123 } +<div class="highlight-none"><div class="highlight"><pre>{ 'class': 'LeveledCompactionStrategy', 'sstable_size_in_mb': 123, 'fanout_size': 10} </pre></div> </div> <p>The setting is kept until someone executes an <a class="reference internal" href="../cql/ddl.html#alter-table-statement"><span class="std std-ref">ALTER TABLE</span></a> that touches the compaction @@ -505,6 +505,9 @@ has not been involved.</p> <dt><code class="docutils literal"><span class="pre">sstable_size_in_mb</span></code> (default: 160MB)</dt> <dd>The target compressed (if using compression) sstable size - the sstables can end up being larger if there are very large partitions on the node.</dd> +<dt><code class="docutils literal"><span class="pre">fanout_size</span></code> (default: 10)</dt> +<dd>The target size of levels increases by this fanout_size multiplier. You can reduce the space amplification by tuning +this option.</dd> </dl> <p>LCS also support the <code class="docutils literal"><span class="pre">cassandra.disable_stcs_in_l0</span></code> startup option (<code class="docutils literal"><span class="pre">-Dcassandra.disable_stcs_in_l0=true</span></code>) to avoid doing STCS in L0.</p> Modified: cassandra/site/publish/doc/latest/operating/compression.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/compression.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/compression.html (original) +++ cassandra/site/publish/doc/latest/operating/compression.html Tue May 16 02:01:22 2017 @@ -154,7 +154,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/hardware.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/hardware.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/hardware.html (original) +++ cassandra/site/publish/doc/latest/operating/hardware.html Tue May 16 02:01:22 2017 @@ -154,7 +154,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/hints.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/hints.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/hints.html (original) +++ cassandra/site/publish/doc/latest/operating/hints.html Tue May 16 02:01:22 2017 @@ -148,7 +148,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/index.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/index.html (original) +++ cassandra/site/publish/doc/latest/operating/index.html Tue May 16 02:01:22 2017 @@ -146,7 +146,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -180,7 +180,12 @@ <li class="toctree-l2"><a class="reference internal" href="topo_changes.html#cleanup-data-after-range-movements">Cleanup data after range movements</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="repair.html">Repair</a></li> +<li class="toctree-l1"><a class="reference internal" href="repair.html">Repair</a><ul> +<li class="toctree-l2"><a class="reference internal" href="repair.html#incremental-and-full-repairs">Incremental and Full Repairs</a></li> +<li class="toctree-l2"><a class="reference internal" href="repair.html#usage-and-best-practices">Usage and Best Practices</a></li> +<li class="toctree-l2"><a class="reference internal" href="repair.html#other-options">Other Options</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="read_repair.html">Read repair</a></li> <li class="toctree-l1"><a class="reference internal" href="hints.html">Hints</a></li> <li class="toctree-l1"><a class="reference internal" href="compaction.html">Compaction</a><ul> @@ -237,9 +242,11 @@ <li class="toctree-l2"><a class="reference internal" href="metrics.html#commitlog-metrics">CommitLog Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#storage-metrics">Storage Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#hintedhandoff-metrics">HintedHandoff Metrics</a></li> +<li class="toctree-l2"><a class="reference internal" href="metrics.html#hintsservice-metrics">HintsService Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#sstable-index-metrics">SSTable Index Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#bufferpool-metrics">BufferPool Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#client-metrics">Client Metrics</a></li> +<li class="toctree-l2"><a class="reference internal" href="metrics.html#batch-metrics">Batch Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#jvm-metrics">JVM Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#jmx">JMX</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html#metric-reporters">Metric Reporters</a></li> Modified: cassandra/site/publish/doc/latest/operating/metrics.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/metrics.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/metrics.html (original) +++ cassandra/site/publish/doc/latest/operating/metrics.html Tue May 16 02:01:22 2017 @@ -155,9 +155,11 @@ <li class="toctree-l3"><a class="reference internal" href="#commitlog-metrics">CommitLog Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#storage-metrics">Storage Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#hintedhandoff-metrics">HintedHandoff Metrics</a></li> +<li class="toctree-l3"><a class="reference internal" href="#hintsservice-metrics">HintsService Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#sstable-index-metrics">SSTable Index Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#bufferpool-metrics">BufferPool Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#client-metrics">Client Metrics</a></li> +<li class="toctree-l3"><a class="reference internal" href="#batch-metrics">Batch Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#jvm-metrics">JVM Metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="#jmx">JMX</a></li> <li class="toctree-l3"><a class="reference internal" href="#metric-reporters">Metric Reporters</a></li> @@ -169,7 +171,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -440,21 +442,65 @@ average throughputs.</dd> <td>Counter</td> <td>Number of times speculative retries were sent for this table.</td> </tr> -<tr class="row-odd"><td>WaitingOnFreeMemtableSpace</td> +<tr class="row-odd"><td>SpeculativeFailedRetries</td> +<td>Counter</td> +<td>Number of speculative retries that failed to prevent a timeout</td> +</tr> +<tr class="row-even"><td>SpeculativeInsufficientReplicas</td> +<td>Counter</td> +<td>Number of speculative retries that couldn’t be attempted due to lack of replicas</td> +</tr> +<tr class="row-odd"><td>SpeculativeSampleLatencyNanos</td> +<td>Gauge<Long></td> +<td>Number of nanoseconds to wait before speculation is attempted. Value may be statically configured or updated periodically based on coordinator latency.</td> +</tr> +<tr class="row-even"><td>WaitingOnFreeMemtableSpace</td> <td>Histogram</td> <td>Histogram of time spent waiting for free memtable space, either on- or off-heap.</td> </tr> -<tr class="row-even"><td>DroppedMutations</td> +<tr class="row-odd"><td>DroppedMutations</td> <td>Counter</td> <td>Number of dropped mutations on this table.</td> </tr> +<tr class="row-even"><td>AnticompactionTime</td> +<td>Timer</td> +<td>Time spent anticompacting before a consistent repair.</td> +</tr> +<tr class="row-odd"><td>ValidationTime</td> +<td>Timer</td> +<td>Time spent doing validation compaction during repair.</td> +</tr> +<tr class="row-even"><td>SyncTime</td> +<td>Timer</td> +<td>Time spent doing streaming during repair.</td> +</tr> +<tr class="row-odd"><td>BytesValidated</td> +<td>Histogram</td> +<td>Histogram over the amount of bytes read during validation.</td> +</tr> +<tr class="row-even"><td>PartitionsValidated</td> +<td>Histogram</td> +<td>Histogram over the number of partitions read during validation.</td> +</tr> +<tr class="row-odd"><td>BytesAnticompacted</td> +<td>Counter</td> +<td>How many bytes we anticompacted.</td> +</tr> +<tr class="row-even"><td>BytesMutatedAnticompaction</td> +<td>Counter</td> +<td>How many bytes we avoided anticompacting because the sstable was fully contained in the repaired range.</td> +</tr> +<tr class="row-odd"><td>MutatedAnticompactionGauge</td> +<td>Gauge<Double></td> +<td>Ratio of bytes mutated vs total bytes repaired.</td> +</tr> </tbody> </table> </div> <div class="section" id="keyspace-metrics"> <h2>Keyspace Metrics<a class="headerlink" href="#keyspace-metrics" title="Permalink to this headline">¶</a></h2> <p>Each keyspace in Cassandra has metrics responsible for tracking its state and performance.</p> -<p>These metrics are the same as the <code class="docutils literal"><span class="pre">Table</span> <span class="pre">Metrics</span></code> above, only they are aggregated at the Keyspace level.</p> +<p>Most of these metrics are the same as the <code class="docutils literal"><span class="pre">Table</span> <span class="pre">Metrics</span></code> above, only they are aggregated at the Keyspace level. The keyspace specific metrics are specified in the table below.</p> <p>Reported name format:</p> <dl class="docutils"> <dt><strong>Metric Name</strong></dt> @@ -462,6 +508,37 @@ average throughputs.</dd> <dt><strong>JMX MBean</strong></dt> <dd><code class="docutils literal"><span class="pre">org.apache.cassandra.metrics:type=Keyspace</span> <span class="pre">scope=<Keyspace></span> <span class="pre">name=<MetricName></span></code></dd> </dl> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="7%" /> +<col width="73%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>WriteFailedIdeaCL</td> +<td>Counter</td> +<td>Number of writes that failed to achieve the configured ideal consistency level or 0 if none is configured</td> +</tr> +<tr class="row-odd"><td>IdealCLWriteLatency</td> +<td>Latency</td> +<td>Coordinator latency of writes at the configured ideal consistency level. No values are recorded if ideal consistency level is not configured</td> +</tr> +<tr class="row-even"><td>RepairTime</td> +<td>Timer</td> +<td>Total time spent as repair coordinator.</td> +</tr> +<tr class="row-odd"><td>RepairPrepareTime</td> +<td>Timer</td> +<td>Total time spent preparing for repair.</td> +</tr> +</tbody> +</table> </div> <div class="section" id="threadpool-metrics"> <h2>ThreadPool Metrics<a class="headerlink" href="#threadpool-metrics" title="Permalink to this headline">¶</a></h2> @@ -734,6 +811,10 @@ specific type.</p> <td>Histogram</td> <td>How many contended writes were encountered</td> </tr> +<tr class="row-even"><td>MutationSizeHistogram</td> +<td>Histogram</td> +<td>Total size in bytes of the requests mutations.</td> +</tr> </tbody> </table> </td> @@ -851,6 +932,10 @@ specific type.</p> <td>Counter</td> <td>Number of unavailable exceptions encountered.</td> </tr> +<tr class="row-even"><td>MutationSizeHistogram</td> +<td>Histogram</td> +<td>Total size in bytes of the requests mutations.</td> +</tr> </tbody> </table> </td> @@ -1339,6 +1424,53 @@ Dropped writes are stored and retried by </tbody> </table> </div> +<div class="section" id="hintsservice-metrics"> +<h2>HintsService Metrics<a class="headerlink" href="#hintsservice-metrics" title="Permalink to this headline">¶</a></h2> +<p>Metrics specific to the Hints delivery service. There are also some metrics related to hints tracked in <code class="docutils literal"><span class="pre">Storage</span> <span class="pre">Metrics</span></code></p> +<p>These metrics include the peer endpoint <strong>in the metric name</strong></p> +<p>Reported name format:</p> +<dl class="docutils"> +<dt><strong>Metric Name</strong></dt> +<dd><code class="docutils literal"><span class="pre">org.apache.cassandra.metrics.HintsService.<MetricName></span></code></dd> +<dt><strong>JMX MBean</strong></dt> +<dd><code class="docutils literal"><span class="pre">org.apache.cassandra.metrics:type=HintsService</span> <span class="pre">name=<MetricName></span></code></dd> +</dl> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="14%" /> +<col width="60%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>HintsSucceeded</td> +<td>Meter</td> +<td>A meter of the hints successfully delivered</td> +</tr> +<tr class="row-odd"><td>HintsFailed</td> +<td>Meter</td> +<td>A meter of the hints that failed deliver</td> +</tr> +<tr class="row-even"><td>HintsTimedOut</td> +<td>Meter</td> +<td>A meter of the hints that timed out</td> +</tr> +<tr class="row-odd"><td>Hints_delays</td> +<td>Histogram</td> +<td>Histogram of hint delivery delays (in milliseconds)</td> +</tr> +<tr class="row-even"><td>Hints_delays-<PeerIP></td> +<td>Histogram</td> +<td>Histogram of hint delivery delays (in milliseconds) per peer</td> +</tr> +</tbody> +</table> +</div> <div class="section" id="sstable-index-metrics"> <h2>SSTable Index Metrics<a class="headerlink" href="#sstable-index-metrics" title="Permalink to this headline">¶</a></h2> <p>Metrics specific to the SSTable index metadata.</p> @@ -1439,9 +1571,43 @@ lower by recycling on and off heap buffe <td>Counter</td> <td>Number of clients connected to this nodes native protocol server</td> </tr> -<tr class="row-odd"><td>connectedThriftClients</td> -<td>Counter</td> -<td>Number of clients connected to this nodes thrift protocol server</td> +</tbody> +</table> +</div> +<div class="section" id="batch-metrics"> +<h2>Batch Metrics<a class="headerlink" href="#batch-metrics" title="Permalink to this headline">¶</a></h2> +<p>Metrics specifc to batch statements.</p> +<p>Reported name format:</p> +<dl class="docutils"> +<dt><strong>Metric Name</strong></dt> +<dd><code class="docutils literal"><span class="pre">org.apache.cassandra.metrics.Batch.<MetricName></span></code></dd> +<dt><strong>JMX MBean</strong></dt> +<dd><code class="docutils literal"><span class="pre">org.apache.cassandra.metrics:type=Batch</span> <span class="pre">name=<MetricName></span></code></dd> +</dl> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="13%" /> +<col width="63%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>PartitionsPerCounterBatch</td> +<td>Histogram</td> +<td>Distribution of the number of partitions processed per counter batch</td> +</tr> +<tr class="row-odd"><td>PartitionsPerLoggedBatch</td> +<td>Histogram</td> +<td>Distribution of the number of partitions processed per logged batch</td> +</tr> +<tr class="row-even"><td>PartitionsPerUnloggedBatch</td> +<td>Histogram</td> +<td>Distribution of the number of partitions processed per unlogged batch</td> </tr> </tbody> </table> Modified: cassandra/site/publish/doc/latest/operating/read_repair.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/read_repair.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/read_repair.html (original) +++ cassandra/site/publish/doc/latest/operating/read_repair.html Tue May 16 02:01:22 2017 @@ -148,7 +148,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/operating/repair.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/repair.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/repair.html (original) +++ cassandra/site/publish/doc/latest/operating/repair.html Tue May 16 02:01:22 2017 @@ -132,7 +132,12 @@ <li class="toctree-l1 current"><a class="reference internal" href="index.html">Operating Cassandra</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="snitch.html">Snitch</a></li> <li class="toctree-l2"><a class="reference internal" href="topo_changes.html">Adding, replacing, moving and removing nodes</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="#">Repair</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Repair</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#incremental-and-full-repairs">Incremental and Full Repairs</a></li> +<li class="toctree-l3"><a class="reference internal" href="#usage-and-best-practices">Usage and Best Practices</a></li> +<li class="toctree-l3"><a class="reference internal" href="#other-options">Other Options</a></li> +</ul> +</li> <li class="toctree-l2"><a class="reference internal" href="read_repair.html">Read repair</a></li> <li class="toctree-l2"><a class="reference internal" href="hints.html">Hints</a></li> <li class="toctree-l2"><a class="reference internal" href="compaction.html">Compaction</a></li> @@ -148,7 +153,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -165,10 +170,74 @@ <div class="container"> <div class="section" id="repair"> -<h1>Repair<a class="headerlink" href="#repair" title="Permalink to this headline">¶</a></h1> -<div class="admonition-todo admonition" id="index-0"> -<p class="first admonition-title">Todo</p> -<p class="last">todo</p> +<span id="id1"></span><h1>Repair<a class="headerlink" href="#repair" title="Permalink to this headline">¶</a></h1> +<p>Cassandra is designed to remain available if one of it’s nodes is down or unreachable. However, when a node is down or +unreachable, it needs to eventually discover the writes it missed. Hints attempt to inform a node of missed writes, but +are a best effort, and aren’t guaranteed to inform a node of 100% of the writes it missed. These inconsistencies can +eventually result in data loss as nodes are replaced or tombstones expire.</p> +<p>These inconsistencies are fixed with the repair process. Repair synchronizes the data between nodes by comparing their +respective datasets for their common token ranges, and streaming the differences for any out of sync sections between +the nodes. It compares the data with merkle trees, which are a hierarchy of hashes.</p> +<div class="section" id="incremental-and-full-repairs"> +<h2>Incremental and Full Repairs<a class="headerlink" href="#incremental-and-full-repairs" title="Permalink to this headline">¶</a></h2> +<p>There are 2 types of repairs: full repairs, and incremental repairs. Full repairs operate over all of the data in the +token range being repaired. Incremental repairs only repair data that’s been written since the previous incremental repair.</p> +<p>Incremental repairs are the default repair type, and if run regularly, can significantly reduce the time and io cost of +performing a repair. However, it’s important to understand that once an incremental repair marks data as repaired, it won’t +try to repair it again. This is fine for syncing up missed writes, but it doesn’t protect against things like disk corruption, +data loss by operator error, or bugs in Cassandra. For this reason, full repairs should still be run occasionally.</p> +</div> +<div class="section" id="usage-and-best-practices"> +<h2>Usage and Best Practices<a class="headerlink" href="#usage-and-best-practices" title="Permalink to this headline">¶</a></h2> +<p>Since repair can result in a lot of disk and network io, it’s not run automatically by Cassandra. It is run by the operator +via nodetool.</p> +<p>Incremental repair is the default and is run with the following command:</p> +<div class="highlight-none"><div class="highlight"><pre>nodetool repair +</pre></div> +</div> +<p>A full repair can be run with the following command:</p> +<div class="highlight-none"><div class="highlight"><pre>nodetool repair --full +</pre></div> +</div> +<p>Additionally, repair can be run on a single keyspace:</p> +<div class="highlight-none"><div class="highlight"><pre>nodetool repair [options] <keyspace_name> +</pre></div> +</div> +<p>Or even on specific tables:</p> +<div class="highlight-none"><div class="highlight"><pre>nodetool repair [options] <keyspace_name> <table1> <table2> +</pre></div> +</div> +<p>The repair command only repairs token ranges on the node being repaired, it doesn’t repair the whole cluster. By default, repair +will operate on all token ranges replicated by the node you’re running repair on, which will cause duplicate work if you run it +on every node. The <code class="docutils literal"><span class="pre">-pr</span></code> flag will only repair the “primary” ranges on a node, so you can repair your entire cluster by running +<code class="docutils literal"><span class="pre">nodetool</span> <span class="pre">repair</span> <span class="pre">-pr</span></code> on each node in a single datacenter.</p> +<p>The specific frequency of repair that’s right for your cluster, of course, depends on several factors. However, if you’re +just starting out and looking for somewhere to start, running an incremental repair every 1-3 days, and a full repair every +1-3 weeks is probably reasonable. If you don’t want to run incremental repairs, a full repair every 5 days is a good place +to start.</p> +<p>At a minimum, repair should be run often enough that the gc grace period never expires on unrepaired data. Otherwise, deleted +data could reappear. With a default gc grace period of 10 days, repairing every node in your cluster at least once every 7 days +will prevent this, while providing enough slack to allow for delays.</p> +</div> +<div class="section" id="other-options"> +<h2>Other Options<a class="headerlink" href="#other-options" title="Permalink to this headline">¶</a></h2> +<dl class="docutils"> +<dt><code class="docutils literal"><span class="pre">-pr,</span> <span class="pre">--partitioner-range</span></code></dt> +<dd>Restricts repair to the ‘primary’ token ranges of the node being repaired. A primary range is just a token range for +which a node is the first replica in the ring.</dd> +<dt><code class="docutils literal"><span class="pre">-prv,</span> <span class="pre">--preview</span></code></dt> +<dd>Estimates the amount of streaming that would occur for the given repair command. This builds the merkle trees, and prints +the expected streaming activity, but does not actually do any streaming. By default, incremental repairs are estimated, +add the <code class="docutils literal"><span class="pre">--full</span></code> flag to estimate a full repair.</dd> +<dt><code class="docutils literal"><span class="pre">-vd,</span> <span class="pre">--validate</span></code></dt> +<dd>Verifies that the repaired data is the same across all nodes. Similiar to <code class="docutils literal"><span class="pre">--preview</span></code>, this builds and compares merkle +trees of repaired data, but doesn’t do any streaming. This is useful for troubleshooting. If this shows that the repaired +data is out of sync, a full repair should be run.</dd> +</dl> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="../tools/nodetool/repair.html#nodetool-repair"><span class="std std-ref">nodetool repair docs</span></a></p> +</div> </div> </div> Modified: cassandra/site/publish/doc/latest/operating/security.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/operating/security.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/operating/security.html (original) +++ cassandra/site/publish/doc/latest/operating/security.html Tue May 16 02:01:22 2017 @@ -156,7 +156,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
