Repository: karaf-decanter Updated Branches: refs/heads/master 5b1777f59 -> 11b0d1d61
Update manual Project: http://git-wip-us.apache.org/repos/asf/karaf-decanter/repo Commit: http://git-wip-us.apache.org/repos/asf/karaf-decanter/commit/11b0d1d6 Tree: http://git-wip-us.apache.org/repos/asf/karaf-decanter/tree/11b0d1d6 Diff: http://git-wip-us.apache.org/repos/asf/karaf-decanter/diff/11b0d1d6 Branch: refs/heads/master Commit: 11b0d1d6132575ee112712068a7ba390ebcdad11 Parents: 5b1777f Author: Jean-Baptiste Onofré <[email protected]> Authored: Wed Nov 2 07:31:55 2016 +0100 Committer: Jean-Baptiste Onofré <[email protected]> Committed: Wed Nov 2 07:31:55 2016 +0100 ---------------------------------------------------------------------- ...g.apache.karaf.decanter.appender.mongodb.cfg | 6 +- manual/pom.xml | 2 +- .../src/main/asciidoc/user-guide/appenders.adoc | 102 +++++++++++- .../main/asciidoc/user-guide/collectors.adoc | 160 ++++++++++++++++++- 4 files changed, 263 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/11b0d1d6/appender/mongodb/src/main/cfg/org.apache.karaf.decanter.appender.mongodb.cfg ---------------------------------------------------------------------- diff --git a/appender/mongodb/src/main/cfg/org.apache.karaf.decanter.appender.mongodb.cfg b/appender/mongodb/src/main/cfg/org.apache.karaf.decanter.appender.mongodb.cfg index 4c4abdc..7d45d82 100644 --- a/appender/mongodb/src/main/cfg/org.apache.karaf.decanter.appender.mongodb.cfg +++ b/appender/mongodb/src/main/cfg/org.apache.karaf.decanter.appender.mongodb.cfg @@ -1,6 +1,6 @@ -############################### -# Decanter Kafka Configuration -############################### +################################ +# Decanter MongoDB Configuration +################################ # MongoDB connection URI #uri=mongodb://localhost http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/11b0d1d6/manual/pom.xml ---------------------------------------------------------------------- diff --git a/manual/pom.xml b/manual/pom.xml index ae70a38..ad934e0 100644 --- a/manual/pom.xml +++ b/manual/pom.xml @@ -24,7 +24,7 @@ <parent> <groupId>org.apache.karaf</groupId> <artifactId>decanter</artifactId> - <version>1.2.0-SNAPSHOT</version> + <version>1.3.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/11b0d1d6/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 98825a3..f58c188 100644 --- a/manual/src/main/asciidoc/user-guide/appenders.adoc +++ b/manual/src/main/asciidoc/user-guide/appenders.adoc @@ -1012,6 +1012,72 @@ This file allows you to define how the messages are sent to the Kafka broker: It's also possible to enable SSL security (with Kafka 0.9.x) using the SSL properties. +==== Redis + +The Decanter Redis appender sends the data (collected by the collectors) to a Redis broker. + +The `decanter-appender-redis` feature installs the Redis appender: + +---- +karaf@root()> feature:install decanter-appender-redis +---- + +This feature also installs a default `etc/org.apache.karaf.decanter.appender.redis.cfg` configuration file containing: + +---- +####################################### +# Decanter Redis Appender Configuration +####################################### + +# +# Location of the Redis broker +# It's possible to use a list of brokers, for instance: +# host= locahost:6389,localhost:6332,localhost:6419 +# +# Default is localhost:6379 +# +address=localhost:6379 + +# +# Define the connection mode. +# Possible modes: Single (default), Master_Slave, Sentinel, Cluster +# +mode=Single + +# +# Name of the Redis map +# Default is Decanter +# +map=Decanter + +# +# For Master_Slave mode, we define the location of the master +# Default is localhost:6379 +# +#masterAddress=localhost:6379 + +# +# For Sentinel model, define the name of the master +# Default is myMaster +# +#masterName=myMaster + +# +# For Cluster mode, define the scan interval of the nodes in the cluster +# Default value is 2000 (2 seconds). +# +#scanInterval=2000 +---- + +This file allows you to configure the Redis broker to use: + +* the `address` property contains the location of the Redis broker +* the `mode` property defines the Redis topology to use (Single, Master_Slave, Sentinel, Cluster) +* the `map` property contains the name of the Redis map to use +* the `masterAddress` is the location of the master when using the Master_Slave topology +* the `masterName` is the name of the master when using the Sentinel topology +* the `scanInternal` is the scan interval of the nodes when using the Cluster topology + ==== MQTT The Decanter MQTT appender sends the data (collected by the collectors) to a MQTT broker. @@ -1030,7 +1096,7 @@ This feature installs a default `etc/org.apache.karaf.decanter.appender.mqtt.cfg #topic=decanter ---- -This file allows you to configuration the location and where to send in the MQTT broker: +This file allows you to configure the location and where to send in the MQTT broker: * the `server` contains the location of the MQTT broker * the `clientId` identifies the appender on the MQTT broker @@ -1038,7 +1104,7 @@ This file allows you to configuration the location and where to send in the MQTT ==== Cassandra -The Decanter Cassandra appender allows your to store the data (coming from the collectors) into an Apache Cassandra database. +The Decanter Cassandra appender allows you to store the data (coming from the collectors) into an Apache Cassandra database. The `decanter-appender-cassandra` feature installs this appender: @@ -1072,6 +1138,38 @@ cassandra.port=9042 * the `cassandra.host` property contains the hostname or IP address where the Cassandra instance is running (default is localhost) * the `cassandra.port` property contains the port number of the Cassandra instance (default is 9042) +==== MongoDB + +The Decanter MongoDB appender allows you to store the data (coming from the collectors) into a MongoDB database. + +The `decanter-appender-mongodb` feature installs this appender: + +---- +karaf@root()> feature:install decanter-appender-mongodb +---- + +This feature installs the appender and a default `etc/org.apache.karaf.decanter.appender.mongodb.cfg` configuration file +containing: + +---- +################################ +# Decanter MongoDB Configuration +################################ + +# MongoDB connection URI +#uri=mongodb://localhost + +# MongoDB database name +#database=decanter + +# MongoDB collection name +#collection=decanter +---- + +* the `uri` property contains the location of the MongoDB instance +* the `database` property contains the name of the MongoDB database +* the `collection` property contains the name of the MongoDB collection + ==== Network socket The Decanter network socket appender send the collected data to a remote Decanter network socket collector. http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/11b0d1d6/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 16df819..257a6e1 100644 --- a/manual/src/main/asciidoc/user-guide/collectors.adoc +++ b/manual/src/main/asciidoc/user-guide/collectors.adoc @@ -437,4 +437,162 @@ This feature installs a default `etc/org.apache.karaf.decanter.collector.socket. ---- * the `port` property contains the port number where the network socket collector is listening -* the `workers` property contains the number of worker thread the socket collector is using for connection \ No newline at end of file +* the `workers` property contains the number of worker thread the socket collector is using for connection + +==== JMS + +The Decanter JMS collector consumes the data from a JMS queue or topic. It's a way to aggregate collected data coming +from remote and several machines. + +The `decanter-collector-jms` feature installs the JMS collector: + +---- +karaf@root()> feature:install decanter-collector-jms +---- + +This feature also installs a default `etc/org.apache.karaf.decanter.collector.jms.cfg` configuration file containing: + +---- +###################################### +# Decanter JMS Collector Configuration +###################################### + +# Name of the JMS connection factory +connection.factory.name=jms/decanter + +# Name of the destination +destination.name=decanter + +# Type of the destination (queue or topic) +destination.type=queue + +# Connection username +# username= + +# Connection password +# password= +---- + +* the `connection.factory.name` is the name of the ConnectionFactory OSGi service to use +* the `destination.name` is the name of the queue or topic where to consume messages from the JMS broker +* the `destination.type` is the type of the destination (queue or topic) +* the `username` and `password` properties are the credentials to use with a secured connection factory + +==== MQTT + +The Decanter MQTT collector receives collected messages from a MQTT broker. It's a way to aggregate collected data coming +from remote and several machines. + +The `decanter-collector-mqtt` feature installs the MQTT collector: + +---- +karaf@root()> feature:install decanter-collector-mqtt +---- + +This feature also installs a default `etc/org.apache.karaf.decanter.collector.mqtt.cfg` configuration file containing: + +---- +####################################### +# Decanter MQTT Collector Configuration +####################################### + +# URI of the MQTT broker +server.uri=tcp://localhost:61616 + +# MQTT Client ID +client.id=decanter + +# MQTT topic name +topic=decanter +---- + +* the `server.uri` is the location of the MQTT broker +* the `client.id` is the Decanter MQTT client ID +* the `topic` is the MQTT topic pattern where to receive the messages + +==== Kafka + +The Decanter Kafka collector receives collected messages from a Kafka broker. It's a way to aggregate collected data coming +from remote and several machines. + +The `decanter-collector-kafka` feature installs the Kafka collector: + +---- +karaf@root()> feature:install decanter-collector-kafka +---- + +This feature also installs a default `etc/org.apache.karaf.decanter.collector.kafka.cfg` configuration file containing: + +---- +############################### +# Decanter Kafka Configuration +############################### + +# A list of host/port pairs to use for establishing the initial connection to the Kafka cluster +#bootstrap.servers=localhost:9092 + +# An id string to identify the group where the consumer belongs to +#group.id=decanter + +# Enable auto commit of consumed messages +#enable.auto.commit=true + +# Auto commit interval (in ms) triggering the commit +#auto.commit.interval.ms=1000 + +# Timeout on the consumer session +#session.timeout.ms=30000 + +# Serializer class for key that implements the Serializer interface +#key.serializer=org.apache.kafka.common.serialization.StringSerializer + +# Serializer class for value that implements the Serializer interface. +#value.serializer=org.apache.kafka.common.serialization.StringSerializer + +# Name of the topic +#topic=decanter + +# Security (SSL) +#security.protocol=SSL + +# SSL truststore location (Kafka broker) and password +#ssl.truststore.location=${karaf.etc}/keystores/keystore.jks +#ssl.truststore.password=karaf + +# SSL keystore (if client authentication is required) +#ssl.keystore.location=${karaf.etc}/keystores/clientstore.jks +#ssl.keystore.password=karaf +#ssl.key.password=karaf + +# (Optional) SSL provider (default uses the JVM one) +#ssl.provider= + +# (Optional) SSL Cipher suites +#ssl.cipher.suites= + +# (Optional) SSL Protocols enabled (default is TLSv1.2,TLSv1.1,TLSv1) +#ssl.enabled.protocols=TLSv1.2,TLSv1.1,TLSv1 + +# (Optional) SSL Truststore type (default is JKS) +#ssl.truststore.type=JKS + +# (Optional) SSL Keystore type (default is JKS) +#ssl.keystore.type=JKS + +# Security (SASL) +# For SASL, you have to configure Java System property as explained in http://kafka.apache.org/documentation.html#security_ssl +---- + +The configuration is similar to the Decanter Kafka appender. Please, see Kafka collector for details. + +==== Rest Servlet + +The Decanter Rest Servlet collector registers a servlet on the OSGi HTTP service (by default on `/decanter/collect`). + +It listens for incoming collected messages on this servlet. + +The `decanter-collector-rest-servlet` feature installs the collector: + +---- +karaf@root()> feature:install decanter-collector-rest-servlet +----
