You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2016/08/22 13:20:49 UTC
svn commit: r1757161 - in /karaf/site/production/manual/decanter/latest-1:
appenders.html architecture.html collectors.html custom-alerter.html
custom-appender.html custom-collector.html index.html introduction.html
sla.html
Author: jbonofre
Date: Mon Aug 22 13:20:49 2016
New Revision: 1757161
URL: http://svn.apache.org/viewvc?rev=1757161&view=rev
Log:
[scm-publish] Updating main site with Karaf Decanter documentation
Modified:
karaf/site/production/manual/decanter/latest-1/appenders.html
karaf/site/production/manual/decanter/latest-1/architecture.html
karaf/site/production/manual/decanter/latest-1/collectors.html
karaf/site/production/manual/decanter/latest-1/custom-alerter.html
karaf/site/production/manual/decanter/latest-1/custom-appender.html
karaf/site/production/manual/decanter/latest-1/custom-collector.html
karaf/site/production/manual/decanter/latest-1/index.html
karaf/site/production/manual/decanter/latest-1/introduction.html
karaf/site/production/manual/decanter/latest-1/sla.html
Modified: karaf/site/production/manual/decanter/latest-1/appenders.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/appenders.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/appenders.html (original)
+++ karaf/site/production/manual/decanter/latest-1/appenders.html Mon Aug 22 13:20:49 2016
@@ -1886,11 +1886,54 @@ cassandra.port=9042</pre>
</ul>
</div>
</div>
+<div class="sect3">
+<h4 id="_network_socket">Network socket</h4>
+<div class="paragraph">
+<p>The Decanter network socket appender send the collected data to a remote Decanter network socket collector.</p>
+</div>
+<div class="paragraph">
+<p>The use case could be to dedicate a Karaf instance as a central monitoring platform, receiving collected data from
+the other nodes.</p>
+</div>
+<div class="paragraph">
+<p>The <code>decanter-appender-socket</code> feature installs this appender:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> feature:install decanter-appender-socket</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>This feature installs the appender and a default <code>etc/org.apache.karaf.decanter.appender.socket.cfg</code> configuration file
+containing:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre># Decanter Socket Appender
+
+# Hostname (or IP address) where to send the collected data
+#host=localhost
+
+# Port number where to send the collected data
+#port=34343</pre>
+</div>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the <code>host</code> property contains the hostname or IP address of the remote network socket collector</p>
+</li>
+<li>
+<p>the <code>port</code> property contains the port number of the remote network socket collector</p>
+</li>
+</ul>
+</div>
+</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-04-19 17:05:26 CEST
+Last updated 2016-08-01 17:02:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/architecture.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/architecture.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/architecture.html (original)
+++ karaf/site/production/manual/decanter/latest-1/architecture.html Mon Aug 22 13:20:49 2016
@@ -541,7 +541,7 @@ these topics.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-03-28 08:08:39 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/collectors.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/collectors.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/collectors.html (original)
+++ karaf/site/production/manual/decanter/latest-1/collectors.html Mon Aug 22 13:20:49 2016
@@ -608,7 +608,8 @@ containing:</p>
# Decanter Log/Log4j Socket collector configuration
#
-#port=4560</pre>
+#port=4560
+#workers=10</pre>
</div>
</div>
<div class="ulist">
@@ -616,6 +617,9 @@ containing:</p>
<li>
<p>the <code>port</code> property defines the port number where the collector is bound and listen for incoming logging event. Default is 4560.</p>
</li>
+<li>
+<p>the <code>workers</code> properties defines the number of threads (workers) which can deal with multiple clients in the same time.</p>
+</li>
</ul>
</div>
</div>
@@ -1012,17 +1016,21 @@ in the Camel Tracer:</p>
# This collector executes system commands, retrieve the exec output/err
# sent to the appenders
#
-# The format is key=command
+# The format is command.key=command_to_execute
+# where command is a reserved keyword used to identify a command property
# for instance:
-# df=df -h
-# free=free
+#
+# command.df=df -h
+# command.free=free
+#
# You can also create a script containing command like:
#
# df -k / | awk -F " |%" '/dev/{print $8}'
#
# This script will get the available space on the / filesystem for instance.
# and call the script:
-# df=/bin/script
+#
+# command.df=/bin/script
#
# Another example of script to get the temperature:
#
@@ -1035,7 +1043,7 @@ in the Camel Tracer:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre>name=command</pre>
+<pre>command.name=system_command</pre>
</div>
</div>
<div class="paragraph">
@@ -1046,15 +1054,53 @@ in the Camel Tracer:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre>df=df -k / | awk -F " |%" '/dev/{print $8}'</pre>
+<pre>command.df=df -k / | awk -F " |%" '/dev/{print $8}'</pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_network_socket">Network socket</h4>
+<div class="paragraph">
+<p>The Decanter network socket collector listens for incoming messages coming from a remote network socket collector.</p>
+</div>
+<div class="paragraph">
+<p>The <code>decanter-collector-socket</code> feature installs the network socket collector:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> feature:install decanter-collector-socket</pre>
+</div>
</div>
+<div class="paragraph">
+<p>This feature installs a default <code>etc/org.apache.karaf.decanter.collector.socket.cfg</code> configuration file containing:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre># Decanter Socket Collector
+
+# Port number on which to listen
+#port=34343
+
+# Number of worker threads to deal with
+#workers=10</pre>
+</div>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the <code>port</code> property contains the port number where the network socket collector is listening</p>
+</li>
+<li>
+<p>the <code>workers</code> property contains the number of worker thread the socket collector is using for connection</p>
+</li>
+</ul>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-03-28 08:08:39 CEST
+Last updated 2016-08-01 17:04:38 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/custom-alerter.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/custom-alerter.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/custom-alerter.html (original)
+++ karaf/site/production/manual/decanter/latest-1/custom-alerter.html Mon Aug 22 13:20:49 2016
@@ -649,7 +649,7 @@ public class Activator implements Bundle
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-03-28 08:08:39 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/custom-appender.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/custom-appender.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/custom-appender.html (original)
+++ karaf/site/production/manual/decanter/latest-1/custom-appender.html Mon Aug 22 13:20:49 2016
@@ -649,7 +649,7 @@ public class Activator implements Bundle
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-04-28 17:30:11 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/custom-collector.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/custom-collector.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/custom-collector.html (original)
+++ karaf/site/production/manual/decanter/latest-1/custom-collector.html Mon Aug 22 13:20:49 2016
@@ -854,7 +854,7 @@ public class Activator implements Bundle
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-03-28 08:08:39 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/index.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/index.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/index.html (original)
+++ karaf/site/production/manual/decanter/latest-1/index.html Mon Aug 22 13:20:49 2016
@@ -524,6 +524,7 @@ table.CodeRay td.code>pre{padding:0}
<li><a href="#_camel_jmx">1.2.7. Camel (JMX)</a></li>
<li><a href="#_camel_tracer">1.2.8. Camel Tracer</a></li>
<li><a href="#_system">1.2.9. System</a></li>
+<li><a href="#_network_socket">1.2.10. Network socket</a></li>
</ul>
</li>
<li><a href="#_appenders">1.3. Appenders</a>
@@ -536,6 +537,7 @@ table.CodeRay td.code>pre{padding:0}
<li><a href="#_kafka">1.3.6. Kafka</a></li>
<li><a href="#_mqtt">1.3.7. MQTT</a></li>
<li><a href="#_cassandra">1.3.8. Cassandra</a></li>
+<li><a href="#_network_socket_2">1.3.9. Network socket</a></li>
</ul>
</li>
<li><a href="#_sla_service_level_agreement">1.4. SLA (Service Level Agreement)</a>
@@ -722,7 +724,8 @@ containing:</p>
# Decanter Log/Log4j Socket collector configuration
#
-#port=4560</pre>
+#port=4560
+#workers=10</pre>
</div>
</div>
<div class="ulist">
@@ -730,6 +733,9 @@ containing:</p>
<li>
<p>the <code>port</code> property defines the port number where the collector is bound and listen for incoming logging event. Default is 4560.</p>
</li>
+<li>
+<p>the <code>workers</code> properties defines the number of threads (workers) which can deal with multiple clients in the same time.</p>
+</li>
</ul>
</div>
</div>
@@ -1126,17 +1132,21 @@ in the Camel Tracer:</p>
# This collector executes system commands, retrieve the exec output/err
# sent to the appenders
#
-# The format is key=command
+# The format is command.key=command_to_execute
+# where command is a reserved keyword used to identify a command property
# for instance:
-# df=df -h
-# free=free
+#
+# command.df=df -h
+# command.free=free
+#
# You can also create a script containing command like:
#
# df -k / | awk -F " |%" '/dev/{print $8}'
#
# This script will get the available space on the / filesystem for instance.
# and call the script:
-# df=/bin/script
+#
+# command.df=/bin/script
#
# Another example of script to get the temperature:
#
@@ -1149,7 +1159,7 @@ in the Camel Tracer:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre>name=command</pre>
+<pre>command.name=system_command</pre>
</div>
</div>
<div class="paragraph">
@@ -1160,9 +1170,47 @@ in the Camel Tracer:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre>df=df -k / | awk -F " |%" '/dev/{print $8}'</pre>
+<pre>command.df=df -k / | awk -F " |%" '/dev/{print $8}'</pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_network_socket">1.2.10. Network socket</h4>
+<div class="paragraph">
+<p>The Decanter network socket collector listens for incoming messages coming from a remote network socket collector.</p>
+</div>
+<div class="paragraph">
+<p>The <code>decanter-collector-socket</code> feature installs the network socket collector:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> feature:install decanter-collector-socket</pre>
</div>
</div>
+<div class="paragraph">
+<p>This feature installs a default <code>etc/org.apache.karaf.decanter.collector.socket.cfg</code> configuration file containing:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre># Decanter Socket Collector
+
+# Port number on which to listen
+#port=34343
+
+# Number of worker threads to deal with
+#workers=10</pre>
+</div>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the <code>port</code> property contains the port number where the network socket collector is listening</p>
+</li>
+<li>
+<p>the <code>workers</code> property contains the number of worker thread the socket collector is using for connection</p>
+</li>
+</ul>
+</div>
</div>
</div>
<div class="sect2">
@@ -2541,6 +2589,49 @@ cassandra.port=9042</pre>
</ul>
</div>
</div>
+<div class="sect3">
+<h4 id="_network_socket_2">1.3.9. Network socket</h4>
+<div class="paragraph">
+<p>The Decanter network socket appender send the collected data to a remote Decanter network socket collector.</p>
+</div>
+<div class="paragraph">
+<p>The use case could be to dedicate a Karaf instance as a central monitoring platform, receiving collected data from
+the other nodes.</p>
+</div>
+<div class="paragraph">
+<p>The <code>decanter-appender-socket</code> feature installs this appender:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> feature:install decanter-appender-socket</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>This feature installs the appender and a default <code>etc/org.apache.karaf.decanter.appender.socket.cfg</code> configuration file
+containing:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre># Decanter Socket Appender
+
+# Hostname (or IP address) where to send the collected data
+#host=localhost
+
+# Port number where to send the collected data
+#port=34343</pre>
+</div>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the <code>host</code> property contains the hostname or IP address of the remote network socket collector</p>
+</li>
+<li>
+<p>the <code>port</code> property contains the port number of the remote network socket collector</p>
+</li>
+</ul>
+</div>
+</div>
</div>
<div class="sect2">
<h3 id="_sla_service_level_agreement">1.4. SLA (Service Level Agreement)</h3>
@@ -3498,7 +3589,7 @@ public class Activator implements Bundle
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-03-28 08:08:39 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/introduction.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/introduction.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/introduction.html (original)
+++ karaf/site/production/manual/decanter/latest-1/introduction.html Mon Aug 22 13:20:49 2016
@@ -571,7 +571,7 @@ is created and sent to alerters. Decante
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-04-28 17:30:47 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>
Modified: karaf/site/production/manual/decanter/latest-1/sla.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/decanter/latest-1/sla.html?rev=1757161&r1=1757160&r2=1757161&view=diff
==============================================================================
--- karaf/site/production/manual/decanter/latest-1/sla.html (original)
+++ karaf/site/production/manual/decanter/latest-1/sla.html Mon Aug 22 13:20:49 2016
@@ -818,7 +818,7 @@ alert.destination.uri=direct-vm:decanter
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-03-28 08:08:39 CEST
+Last updated 2016-07-03 08:10:09 CEST
</div>
</div>
</body>