karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject [karaf-decanter] branch master updated: Update documentation with OrientDB (appender and embedded instance).
Date Mon, 01 Jan 2018 09:33:28 GMT
This is an automated email from the ASF dual-hosted git repository.

jbonofre pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/karaf-decanter.git


The following commit(s) were added to refs/heads/master by this push:
     new 5d8eb38  Update documentation with OrientDB (appender and embedded instance).
5d8eb38 is described below

commit 5d8eb386637acebaf7a112177653d6e4c340990e
Author: Jean-Baptiste Onofré <jbonofre@apache.org>
AuthorDate: Mon Jan 1 10:33:09 2018 +0100

    Update documentation with OrientDB (appender and embedded instance).
---
 README                                             |   3 +-
 manual/src/main/asciidoc/user-guide/appenders.adoc | 104 ++++++++++++++++++++-
 2 files changed, 105 insertions(+), 2 deletions(-)

diff --git a/README b/README
index a3ac53e..41ec653 100644
--- a/README
+++ b/README
@@ -51,7 +51,7 @@ Apache Karaf Decanter is available as a Karaf features. The commands below
start
 the jmx collector, log collector and an appender to a local elasticsearch instance
 on the default port. Prerquisite is a running elasticsearch instance.
 
-feature:repo-add decanter 1.3.0
+feature:repo-add decanter
 
 Depending of what you want to monitor and collect, you have to install the corresponding
features
 using feature:install command.
@@ -97,6 +97,7 @@ Appenders
 * decanter-appender-socket
 * decanter-appender-redis
 * decanter-appender-rest
+* decanter-appender-orientdb
 
 SLA/Alerters
 ------------
diff --git a/manual/src/main/asciidoc/user-guide/appenders.adoc b/manual/src/main/asciidoc/user-guide/appenders.adoc
index f58c188..fe98372 100644
--- a/manual/src/main/asciidoc/user-guide/appenders.adoc
+++ b/manual/src/main/asciidoc/user-guide/appenders.adoc
@@ -1197,4 +1197,106 @@ containing:
 ----
 
 * the `host` property contains the hostname or IP address of the remote network socket collector
-* the `port` property contains the port number of the remote network socket collector
\ No newline at end of file
+* the `port` property contains the port number of the remote network socket collector
+
+==== OrientDB
+
+The Decanter OrientDB appender stores the collected data into OrientDB Document database.
+
+You can use an external OrientDB instance or you can use an embedded instance provided by
Decanter.
+
+===== OrientDB appender
+
+The `decanter-appender-orientdb` feature installs the OrientDB appender.
+
+This feature installs the `etc/org.apache.karaf.decanter.appender.orientdb.cfg` configuration
file allowing you to setup the location
+of the OrientDB database to use:
+
+----
+#################################
+# Decanter OrientDB Configuration
+#################################
+
+# OrientDB connection URL
+#url=remote:localhost/decanter
+
+# OrientDB database username
+#username=root
+
+# OrientDB database password
+#password=decanter
+----
+
+where:
+
+* `url` is the location of the OrientDB Document database. By default, it uses `remote:localhost/decanter`
corresponding to the OrientDB embedded instance.
+* `username` is the username to connect to the remote OrientDB Document database.
+* `password` is the password to connect to the remote OrientDB Document database.
+
+===== OrientDB embedded instance
+
+The `orientdb` feature starts an OrientDB embedded datase. It also installs the `etc/orientdb-server-config.xml`
configuration file allowing you to configure the OrientBD instance:
+
+----
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<orient-server>
+    <handlers>
+        <handler class="com.orientechnologies.orient.graph.handler.OGraphServerHandler">
+            <parameters>
+                <parameter value="true" name="enabled"/>
+                <parameter value="50" name="graph.pool.max"/>
+            </parameters>
+        </handler>
+        <handler class="com.orientechnologies.orient.server.handler.OJMXPlugin">
+            <parameters>
+                <parameter value="false" name="enabled"/>
+                <parameter value="true" name="profilerManaged"/>
+            </parameters>
+        </handler>
+        <handler class="com.orientechnologies.orient.server.handler.OServerSideScriptInterpreter">
+            <parameters>
+                <parameter value="true" name="enabled"/>
+                <parameter value="SQL" name="allowedLanguages"/>
+            </parameters>
+        </handler>
+    </handlers>
+    <network>
+        <protocols>
+            <protocol implementation="com.orientechnologies.orient.server.network.protocol.binary.ONetworkProtocolBinary"
name="binary"/>
+            <protocol implementation="com.orientechnologies.orient.server.network.protocol.http.ONetworkProtocolHttpDb"
name="http"/>
+        </protocols>
+        <listeners>
+            <listener protocol="binary" socket="default" port-range="2424-2430" ip-address="0.0.0.0"/>
+            <listener protocol="http" socket="default" port-range="2480-2490" ip-address="0.0.0.0">
+                <commands>
+                    <command implementation="com.orientechnologies.orient.server.network.protocol.http.command.get.OServerCommandGetStaticContent"
pattern="GET|www GET|studio/ GET| GET|*.htm GET|*.html GET|*.xml GET|*.jpeg GET|*.jpg GET|*.png
GET|*.gif GET|*.js GET|*.css GET|*.swf GET|*.ico GET|*.txt GET|*.otf GET|*.pjs GET|*.svg GET|*.json
GET|*.woff GET|*.woff2 GET|*.ttf GET|*.svgz" stateful="false">
+                        <parameters>
+                            <entry value="Cache-Control: no-cache, no-store, max-age=0,
must-revalidate\r\nPragma: no-cache" name="http.cache:*.htm *.html"/>
+                            <entry value="Cache-Control: max-age=120" name="http.cache:default"/>
+                        </parameters>
+                    </command>
+                    <command implementation="com.orientechnologies.orient.graph.server.command.OServerCommandGetGephi"
pattern="GET|gephi/*" stateful="false"/>
+                </commands>
+                <parameters>
+                    <parameter value="utf-8" name="network.http.charset"/>
+                    <parameter value="true" name="network.http.jsonResponseError"/>
+                </parameters>
+            </listener>
+        </listeners>
+    </network>
+    <storages/>
+    <users>
+    </users>
+    <properties>
+        <entry value="1" name="db.pool.min"/>
+        <entry value="50" name="db.pool.max"/>
+        <entry value="false" name="profiler.enabled"/>
+    </properties>
+    <isAfterFirstTime>true</isAfterFirstTime>
+</orient-server>
+----
+
+Most of the values can be let as they are, however, you can tweak some:
+
+* `<listener/>` allows you to configure the protocol and port numbers used by the OrientDB
instance. You can define the IP address on which the instance is bound (`ip-address`), the
port numbers range to use (`port-range`) for each protocol (`binary` or `http`).
+* the `db.pool.min` and `db.pool.max` can be increased if you have a large number of connections
on the instance.
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
['"commits@karaf.apache.org" <commits@karaf.apache.org>'].

Mime
View raw message