[30/30] karaf-decanter git commit: Add NOTICE and README files

[jb...@apache.org]

Add NOTICE and README files


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

Branch: refs/heads/master
Commit: 08fefefcc7a98864d610db99caf7ea8013d2fcc8
Parents: cfdd210
Author: Jean-Baptiste Onofré <jb...@apache.org>
Authored: Wed Feb 4 17:29:38 2015 +0100
Committer: Jean-Baptiste Onofré <jb...@apache.org>
Committed: Wed Feb 4 17:29:38 2015 +0100

----------------------------------------------------------------------
 NOTICE | 36 +++++++++++++++++++++++
 README | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 131 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/08fefefc/NOTICE
----------------------------------------------------------------------
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..1c93fe3
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,36 @@
+Apache Karaf Decanter
+Copyright 2015 The Apache Software Foundation
+
+
+I. Included Software
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+Licensed under the Apache License 2.0.
+
+This product includes software developed at
+Elasticsearch BV (http://elasticsearch.org).
+Licensed under the Apache License 2.0.
+
+II. Used Software
+
+This product uses software developed at
+The OSGi Alliance (http://www.osgi.org/).
+Copyright (c) OSGi Alliance (2000, 2010).
+Licensed under the Apache License 2.0.
+
+This product uses software developed at
+OPS4J (http://www.ops4j.org/).
+Licensed under the Apache License 2.0.
+
+This product uses software developed at
+FUSE Source (http://www.fusesource.org/).
+Licensed under the Apache License 2.0.
+
+This product uses software developed at
+SLF4J (http://www.slf4j.org/).
+Licensed under the MIT License.
+
+III. License Summary
+- Apache License 2.0
+- MIT License

http://git-wip-us.apache.org/repos/asf/karaf-decanter/blob/08fefefc/README
----------------------------------------------------------------------
diff --git a/README b/README
new file mode 100644
index 0000000..f5a18e6
--- /dev/null
+++ b/README
@@ -0,0 +1,95 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+Welcome to Apache Karaf Decanter
+================================
+Apache Karaf Decanter is a complete monitoring platform for Apache Karaf.
+
+Apache Karaf Decanter is very extensible, flexible, easy to install and use.
+
+Apache Karaf Decanter is composed by:
+    * Collectors and SLA Policies
+      The collectors are OSGi services responsible of harvesting monitoring data.
+      Two kinds of collectors are available:
+      - the polling collectors are invoked periodically by a scheduler
+      - the event driven collectors react to some events.
+      It's very dynamic (thanks to the OSGi services), so it's possible to add
+      a new custom collector (user/custom implementations).
+      The collectors are also responsible of checking the SLA, and delegate to
+      a notifier.
+    * Scheduler
+      The scheduler service is responsible to call the Polling Collectors,
+      gather the harvested data, and delegate to the dispatcher.
+    * Dispatcher
+      The dispatcher is called by the scheduler or the event driven collectors
+      to dispatch the collected data to the appenders.
+    * Appenders
+      The appenders are responsible to send/store the collected data to target
+      systems.
+    * Notifier
+      The notifier is called by the collectors' SLA. The notifier uses external
+      system to "publish" the SLA alert.
+    * Console & Web UI
+      The console is responsible of both SLA configuration and dashboard view.
+
+Getting Started
+===============
+Apache Karaf Decanter is available as a Karaf features.
+
+You have to register the Decater features repository:
+
+karaf@root()> feature:repo-add mvn:org.apache.karaf.decanter/decanter/3.0.0-SNAPSHOT/xml/features
+
+It's up to you to choose the features to install, depending of the systems that you want:
+
+* decanter-simple-scheduler
+This feature installs a very simple Decanter Scheduler using a Thread.
+
+karaf@root()> feature:install decanter-simple-schedular
+
+* decanter-collector-log
+This feature installs a Decanter Collector listening for all log messages happening in Karaf.
+
+karaf@root()> feature:install decanter-collector-log
+
+* decanter-collector-jmx
+This feature installs a Decanter Collector harvesting the JMX MBeans metrics.
+
+karaf@root()> feature:install decanter-collector-jmx
+
+* decanter-appender-log
+This feature installs a Decanter Appender that sends the collected data as log messages.
+
+karaf@root()> feature:install decanter-appender-log
+
+* decanter-appender-elasticsearch
+This feature installs a Decanter Appender that sends the collected data to a Elasticsearch
+database.
+
+karaf@root()> feature:install decanter-appender-elasticsearch
+
+* Optional features
+For convenience, Decanter also provides elasticsearch and kibana features installing elasticsearch
+and kibana directly in the Karaf instance.
+
+
+
+Thanks for using Apache Karaf Decanter !
+
+--
+The Karaf Team
+