karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject karaf-decanter git commit: Use article for documentation
Date Mon, 04 Jan 2016 15:20:56 GMT
Repository: karaf-decanter
Updated Branches:
  refs/heads/master 2e36de019 -> 258b970b6


Use article for documentation


Project: http://git-wip-us.apache.org/repos/asf/karaf-decanter/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf-decanter/commit/258b970b
Tree: http://git-wip-us.apache.org/repos/asf/karaf-decanter/tree/258b970b
Diff: http://git-wip-us.apache.org/repos/asf/karaf-decanter/diff/258b970b

Branch: refs/heads/master
Commit: 258b970b64ed95ae078362a33952967a26085e87
Parents: 2e36de0
Author: Jean-Baptiste Onofré <jbonofre@apache.org>
Authored: Mon Jan 4 16:20:38 2016 +0100
Committer: Jean-Baptiste Onofré <jbonofre@apache.org>
Committed: Mon Jan 4 16:20:38 2016 +0100

----------------------------------------------------------------------
 manual/pom.xml                                    |  4 ++--
 .../src/main/asciidoc/dev-guide/architecture.adoc |  2 +-
 .../main/asciidoc/dev-guide/custom-alerter.adoc   |  2 +-
 .../main/asciidoc/dev-guide/custom-appender.adoc  |  2 +-
 .../main/asciidoc/dev-guide/custom-collector.adoc |  8 ++++----
 manual/src/main/asciidoc/index.adoc               |  6 +++---
 .../src/main/asciidoc/user-guide/appenders.adoc   | 18 +++++++++---------
 .../src/main/asciidoc/user-guide/collectors.adoc  | 17 ++++++++---------
 .../main/asciidoc/user-guide/introduction.adoc    |  2 +-
 manual/src/main/asciidoc/user-guide/sla.adoc      | 12 ++++++------
 10 files changed, 36 insertions(+), 37 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/pom.xml
----------------------------------------------------------------------
diff --git a/manual/pom.xml b/manual/pom.xml
index f611198..a48c706 100644
--- a/manual/pom.xml
+++ b/manual/pom.xml
@@ -49,7 +49,7 @@
                         <configuration>
                             <sourceHighlighter>coderay</sourceHighlighter>
                             <backend>html5</backend>
-                            <doctype>book</doctype>
+                            <doctype>article</doctype>
                             <attributes>
                                 <toc/>
                                 <linkcss>false</linkcss>
@@ -60,7 +60,7 @@
                 <configuration>
                     <sourceDirectory>src/main/asciidoc</sourceDirectory>
                     <headerFooter>true</headerFooter>
-                    <imagesDir>../resources/images</imagesDir>
+                    <imagesDir>src/main/asciidoc/images</imagesDir>
                 </configuration>
             </plugin>
             <plugin>

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/dev-guide/architecture.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/dev-guide/architecture.adoc b/manual/src/main/asciidoc/dev-guide/architecture.adoc
index d5780a1..cfc3c77 100644
--- a/manual/src/main/asciidoc/dev-guide/architecture.adoc
+++ b/manual/src/main/asciidoc/dev-guide/architecture.adoc
@@ -12,7 +12,7 @@
 // limitations under the License.
 //
 
-== Architecture
+=== Architecture
 
 Apache Karaf Decanter uses OSGi EventAdmin to dispatch the harvested data between the collectors
and the appenders,
 and also to throw the alerts to the alerters:

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/dev-guide/custom-alerter.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/dev-guide/custom-alerter.adoc b/manual/src/main/asciidoc/dev-guide/custom-alerter.adoc
index c72bded..5707c8a 100644
--- a/manual/src/main/asciidoc/dev-guide/custom-alerter.adoc
+++ b/manual/src/main/asciidoc/dev-guide/custom-alerter.adoc
@@ -12,7 +12,7 @@
 // limitations under the License.
 //
 
-== Custom SLA Alerter
+=== Custom SLA Alerter
 
 A Decanter SLA Alerter is basically a special kind of appender.
 

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/dev-guide/custom-appender.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/dev-guide/custom-appender.adoc b/manual/src/main/asciidoc/dev-guide/custom-appender.adoc
index 4b50a0d..d3a29d0 100644
--- a/manual/src/main/asciidoc/dev-guide/custom-appender.adoc
+++ b/manual/src/main/asciidoc/dev-guide/custom-appender.adoc
@@ -12,7 +12,7 @@
 // limitations under the License.
 //
 
-== Custom Appender
+=== Custom Appender
 
 A Decanter Appender is an OSGi EventAdmin EventHandler: it's listening of `decanter/collect/*`
EventAdmin topics, and
 receives the monitoring data coming from the collectors.

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/dev-guide/custom-collector.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/dev-guide/custom-collector.adoc b/manual/src/main/asciidoc/dev-guide/custom-collector.adoc
index 7bc3697..9070a6c 100644
--- a/manual/src/main/asciidoc/dev-guide/custom-collector.adoc
+++ b/manual/src/main/asciidoc/dev-guide/custom-collector.adoc
@@ -12,7 +12,7 @@
 // limitations under the License.
 //
 
-== Custom Collector
+=== Custom Collector
 
 A Decanter collector sends an OSGi EventAdmin event to a `decanter/collect/*` topic.
 
@@ -21,7 +21,7 @@ You can create two kinds of collector:
 * event driven collector automatically reacts to some internal events. It creates an event
sent to a topic.
 * polled collector is a Runnable OSGi service periodically executed by the Decanter Scheduler.
 
-=== Event Driven Collector
+==== Event Driven Collector
 
 For instance, the log collector is event driven: it automatically reacts to internal log
events.
 
@@ -30,7 +30,7 @@ changes (installed, started, stopped, uninstalled).
 
 The purpose is to send a monitoring event in a collect topic. This monitoring event can be
consumed by the appenders.
 
-We create the following `BundleCollector` class implemetings `SynchronousBundleListener`
interface:
+We create the following `BundleCollector` class implementing `SynchronousBundleListener`
interface:
 
 ----
 package org.apache.karaf.decanter.sample.collector;
@@ -171,7 +171,7 @@ Now, we just need a Maven `pom.xml` to package the bundle with the correct
OSGi
 You can now enable this collector, just by installing the bundle in Apache Karaf (using the
deploy folder, or the
 `bundle:install` command.
 
-=== Polled Collector
+==== Polled Collector
 
 You can also create a polled collector.
 

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/index.adoc b/manual/src/main/asciidoc/index.adoc
index 91440ae..d5431cd 100644
--- a/manual/src/main/asciidoc/index.adoc
+++ b/manual/src/main/asciidoc/index.adoc
@@ -15,14 +15,14 @@
 Apache Karaf Decanter 1.x - Documentation
 =========================================
 Apache Software Foundation
-:doctype: book
+:doctype: article
 :toc: left
 :toclevels: 3
 :toc-position: left
 :toc-title: Apache Karaf Decanter 1.x - Documentation
 :numbered:
 
-= User Guide
+== User Guide
 
 include::user-guide/introduction.adoc[]
 
@@ -32,7 +32,7 @@ include::user-guide/appenders.adoc[]
 
 include::user-guide/sla.adoc[]
 
-= Developer Guide
+== Developer Guide
 
 include::dev-guide/architecture.adoc[]
 

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/user-guide/appenders.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/appenders.adoc b/manual/src/main/asciidoc/user-guide/appenders.adoc
index b8955aa..df3357f 100644
--- a/manual/src/main/asciidoc/user-guide/appenders.adoc
+++ b/manual/src/main/asciidoc/user-guide/appenders.adoc
@@ -12,11 +12,11 @@
 // limitations under the License.
 //
 
-== Appenders
+=== Appenders
 
 Decanter appenders receive the data from the collectors, and store the data into a storage
backend.
 
-=== Log
+==== Log
 
 The Decanter Log Appender creates a log message for each event received from the collectors.
 
@@ -28,7 +28,7 @@ karaf@root()> feature:install decanter-appender-log
 
 The log appender doesn't require any configuration.
 
-=== Elasticsearch
+==== Elasticsearch
 
 The Decanter Elasticsearch Appender stores the data (coming from the collectors) into an
Elasticsearch instance.
 
@@ -64,7 +64,7 @@ This file contains the elasticsearch instance connection properties:
 * the `port` property contains the port number of the Elasticsearch instance
 * the `clusterName` property contains the name of the Elasticsearch cluster where to send
the data
 
-==== Embedding Decanter Elasticsearch
+===== Embedding Decanter Elasticsearch
 
 For convenience, Decanter provides an `elasticsearch` feature starting an embedded Elasticsearch
instance:
 
@@ -476,7 +476,7 @@ You can override the following elasticsearch properties in this configuration
fi
 The advantage of using this file is that the elasticsearch node is automatically restarted
in order to reload the
 settings as soon as you change the cfg file.
 
-==== Embedding Decanter Kibana
+===== Embedding Decanter Kibana
 
 In addition of the embedded elasticsearch instance, Decanter also provides an embedded Kibana
instance, containing
 ready to use Decanter dashboards.
@@ -513,7 +513,7 @@ instance by providing the elasticsearch parameter on the URL like this
for insta
 http://localhost:8181/kibana?elasticsearch=http://localhost:9400
 ----
 
-==== Elasticsearch Head console
+===== Elasticsearch Head console
 
 In addition of the embedded elasticsearch instance, Decanter also provides a web console
allowing you to monitor and
 manage your elasticsearch cluster. It's a ready to use elastisearch-head console, directly
embedded in Karaf.
@@ -526,7 +526,7 @@ karaf@root()> feature:install elasticsearch-head
 
 By default, the elasticsearch-head web console is available on `http://host:8181/elasticsearch-head`.
 
-=== JDBC
+==== JDBC
 
 The Decanter JDBC appender allows your to store the data (coming from the collectors) into
a database.
 
@@ -570,7 +570,7 @@ the table for you, but you can create the table by yourself. The table
is simple
 * the `dialect` property allows you to specify the database type (generic, mysql, derby).
This property is only used for
 the table creation.
 
-=== JMS
+==== JMS
 
 The Decanter JMS appender "forwards" the data (collected by the collectors) to a JMS broker.
 
@@ -614,7 +614,7 @@ factory using the `jms:create` command (provided by the `jms` feature).
 * the `username` property is optional and specifies the username to connect to the destination.
 * the `password` property is optional and specifies the username to connect to the destination.
 
-=== Camel
+==== Camel
 
 The Decanter Camel appender sends the data (collected by the collectors) to a Camel endpoint.
 

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/user-guide/collectors.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/collectors.adoc b/manual/src/main/asciidoc/user-guide/collectors.adoc
index 5724c9f..d4ab1f1 100644
--- a/manual/src/main/asciidoc/user-guide/collectors.adoc
+++ b/manual/src/main/asciidoc/user-guide/collectors.adoc
@@ -12,7 +12,7 @@
 // limitations under the License.
 //
 
-== Collectors
+=== Collectors
 
 Decanter collectors harvest the monitoring data, and send this data to the Decanter appenders.
 
@@ -22,7 +22,7 @@ Two kinds of collector are available:
 * Polled Collectors are periodically executed by the Decanter Scheduler. When executed, the
collectors harvest the
 data and send to the appenders.
 
-=== Log
+==== Log
 
 The Decanter Log Collector is an event driven collector. It automatically reacts when a log
occurs, and
 send the log details (level, logger name, message, etc) to the appenders.
@@ -35,7 +35,7 @@ karaf@root()> feature:install decanter-collector-log
 
 The log collector doesn't need any configuration, the installation of the decanter-collector-log
feature is enough.
 
-=== File
+==== File
 
 The Decanter File Collector is an event driven collector. It automatically reacts when new
lines are appended into
 a file (especially a log file). It acts like the tail Unix command. Basically, it's an alternative
to the log collector.
@@ -79,8 +79,7 @@ my=stuff
 
 The file collector will tail on karaf.log file, and send any new line in this log file as
collected data.
 
-
-=== JMX
+==== JMX
 
 The Decanter JMX Collector is a polled collector, executed periodically by the Decanter Scheduler.
 
@@ -139,7 +138,7 @@ additional data, and create queries based on this data.
 You can retrieve multiple MBean servers. For that, you just create a new configuration file
using the file name format
 `etc/org.apache.karaf.decanter.collector.jmx-[ANYNAME].cfg`.
 
-=== ActiveMQ (JMX)
+==== ActiveMQ (JMX)
 
 The ActiveMQ JMX collector is just a special configuration of the JMX collector.
 
@@ -180,7 +179,7 @@ object.name=org.apache.activemq:*
 
 This configuration actually contains a filter to retrieve only the ActiveMQ JMX MBeans.
 
-=== Camel (JMX)
+==== Camel (JMX)
 
 The Camel JMX collector is just a special configuration of the JMX collector.
 
@@ -221,7 +220,7 @@ object.name=org.apache.camel:context=*,type=routes,name=*
 
 This configuration actually contains a filter to retrieve only the Camel Routes JMX MBeans.
 
-=== Camel Tracer
+==== Camel Tracer
 
 The Camel Tracer provides a Camel Tracer Handler that you can set on a Camel Tracer.
 
@@ -267,7 +266,7 @@ in the Camel Tracer:
 </blueprint>
 ----
 
-=== System
+==== System
 
 The system collector is a polled collector (periodically executed by the Decanter Scheduler).
 

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/user-guide/introduction.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/introduction.adoc b/manual/src/main/asciidoc/user-guide/introduction.adoc
index 5a3f87d..707a31d 100644
--- a/manual/src/main/asciidoc/user-guide/introduction.adoc
+++ b/manual/src/main/asciidoc/user-guide/introduction.adoc
@@ -12,7 +12,7 @@
 // limitations under the License.
 //
 
-== Introduction
+=== Introduction
 
 Apache Karaf Decanter is monitoring solution running in Apache Karaf.
 

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/258b970b/manual/src/main/asciidoc/user-guide/sla.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/sla.adoc b/manual/src/main/asciidoc/user-guide/sla.adoc
index 398c3bf..1fa3195 100644
--- a/manual/src/main/asciidoc/user-guide/sla.adoc
+++ b/manual/src/main/asciidoc/user-guide/sla.adoc
@@ -12,12 +12,12 @@
 // limitations under the License.
 //
 
-== SLA (Service Level Agreement)
+=== SLA (Service Level Agreement)
 
 Decanter provides a SLA (Service Level Agreement) layer. It allows you to check values of
harvested data (coming from
 the collectors) and send alerts when the data is not in the expected state.
 
-=== Checker
+==== Checker
 
 The SLA checker is automatically installed as soon as you install a SLA alerter feature.
 
@@ -89,13 +89,13 @@ You can also use "complex" regex:
 loggerName.warn=match:(.*)my\.loggger\.name\.(.*)
 ----
 
-=== Alerters
+==== Alerters
 
 When the value doesn't verify the check in the checker configuration, an alert is created
an sent to the alerters.
 
 Apache Karaf Decanter provides ready to use alerters.
 
-==== Log
+===== Log
 
 The Decanter SLA Log alerter log a message for each alert.
 
@@ -107,7 +107,7 @@ karaf@root()> feature:install decanter-sla-log
 
 This alerter doesn't need any configuration.
 
-==== E-mail
+===== E-mail
 
 The Decanter SLA e-mail alerter sends an e-mail for each alert.
 
@@ -161,7 +161,7 @@ ssl=false
 * the `username` property is optional and specifies the username to connect to the SMTP server
 * the `password` property is optional and specifies the password to connect to the SMTP server
 
-==== Camel
+===== Camel
 
 The Decanter SLA Camel alerter sends each alert to a Camel endpoint.
 


Mime
View raw message