You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by ba...@apache.org on 2014/09/29 16:41:13 UTC
svn commit: r1628195 - in /jackrabbit/site/live/oak/docs/coldstandby:
client_mbean_server_died.png client_mbean_server_working.png
client_mbean_server_works_again.png coldstandby.html mbeans.png
Author: baedke
Date: Mon Sep 29 14:41:13 2014
New Revision: 1628195
URL: http://svn.apache.org/r1628195
Log:
OAK-936: Site checkin for project Oak Documentation-1.1-SNAPSHOT
Added:
jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_died.png
jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_working.png
jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_works_again.png
jackrabbit/site/live/oak/docs/coldstandby/mbeans.png
Modified:
jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html
Added: jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_died.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_died.png?rev=1628195&view=auto
==============================================================================
(empty)
Added: jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_working.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_working.png?rev=1628195&view=auto
==============================================================================
(empty)
Added: jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_works_again.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/coldstandby/client_mbean_server_works_again.png?rev=1628195&view=auto
==============================================================================
(empty)
Modified: jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html?rev=1628195&r1=1628194&r2=1628195&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html (original)
+++ jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html Mon Sep 29 14:41:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-24
+ | Generated by Apache Maven Doxia at 2014-09-29
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<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="20140924" />
+ <meta name="Date-Revision-yyyymmdd" content="20140929" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Cold Standby</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -182,7 +182,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-24</li>
+ <li id="publishDate">Last Published: 2014-09-29</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -470,7 +470,7 @@
<div class="section">
<div class="section">
<h5>Client<a name="Client"></a></h5>
-<p>Observing a client you will notice exactly one node (the id is either a generic UUID or the name specified by the <tt>failOverID</tt> system property). This node has three readonly attributes:</p>
+<p>Observing a client you will notice exactly one node (the id is either a generic UUID or the name specified by the <tt>failOverID</tt> system property). This node has five readonly attributes:</p>
<ul>
@@ -479,6 +479,10 @@
<li><tt>Mode</tt>: always <tt>Client:</tt> followed by the ID described above</li>
<li><tt>Status</tt>: a textual representation of the current state (like <tt>running</tt>, <tt>stopped</tt> and others)</li>
+
+<li><tt>FailedRequests</tt>: the number of consecutive errors</li>
+
+<li><tt>SecondsSinceLastSuccess</tt>: the number of seconds since the last successful communication with the server or -1 if there is none</li>
</ul>
<p>There are also two invokable methods:</p>
@@ -487,16 +491,28 @@
<li><tt>start()</tt>: start the sync process</li>
<li><tt>stop()</tt>: stop the sync process</li>
-</ul></div>
+</ul>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+<p>A typical communication with the server can look like this (the server is contacted every five seconds and there is no error at all): </p>
+<p><img src="client_mbean_server_working.png" alt="Screenshot showing MBeans with working server" /></p>
+<p>The server can not be contacted anyore:</p>
+<p><img src="client_mbean_server_died.png" alt="Screenshot showing MBeans with server died" /></p>
+<p>The server is live and reachable again and after some errors everythings is up and running again:</p>
+<p><img src="client_mbean_server_works_again.png" alt="Screenshot showing MBeans with server working again" /></p></div></div>
<div class="section">
<h5>Master<a name="Master"></a></h5>
-<p>Observing the master exposes some general (non client-specific) informations via a MBean whose id value is the port number the <tt>Cold Standby</tt> service is using (usually <tt>8023</tt>). There are the same attributes and methods as described above but the values differ:</p>
+<p>Observing the master exposes some general (non client-specific) informations via a MBean whose id value is the port number the <tt>Cold Standby</tt> service is using (usually <tt>8023</tt>). There are almost the same attributes and methods as described above but the values differ:</p>
<ul>
<li><tt>Mode</tt>: always the constant value <tt>master</tt></li>
<li><tt>Status</tt>: has more values like <tt>got message</tt></li>
+
+<li><tt>FailedRequests</tt>: not available in master mode</li>
+
+<li><tt>SecondsSinceLastSuccess</tt>: not available in master mode</li>
</ul>
<p>Furthermore informations for each (up to 10) clients can be retrieved. The MBean id is the name of the client (see above). There are no invokable methods for these MBeans but some very useful readonly attributes:</p>
@@ -516,7 +532,8 @@
<li><tt>TransferredSegmentBytes</tt>: the total number of bytes transferred to this client</li>
</ul>
-<p>A typical state might look like this: <img src="mbeans.png" alt="Screenshot showing MBeans" /></p></div></div></div>
+<p>A typical state might look like this:</p>
+<p><img src="mbeans.png" alt="Screenshot showing MBeans" /></p></div></div></div>
<div class="section">
<h3>Performance<a name="Performance"></a></h3>
<div class="section">
Added: jackrabbit/site/live/oak/docs/coldstandby/mbeans.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/coldstandby/mbeans.png?rev=1628195&view=auto
==============================================================================
(empty)