Use md format and update RELEASE-NOTES in preparation for the 2.1.0 release
diff --git a/README b/README
deleted file mode 100644
index d41f5de..0000000
--- a/README
+++ /dev/null
@@ -1,121 +0,0 @@
-/*
- * 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.
-It is very extensible, flexible, easy to install and use.
-
-Apache Karaf Decanter is composed into:
- * Collectors
- 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).
- * 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.
- * Alerting
- The alerting layer provides a checker, responsible of testing values of
- harvested data (coming from the collectors) and send alerts when the data
- is not in the expected state.
-
-Getting Started
-===============
-Apache Karaf Decanter is available as a Karaf features. The following command registers
-the Karaf Decanter features repository.
-
-feature:repo-add decanter
-
-Depending of what you want to monitor and collect, you have to install the corresponding features
-using feature:install command.
-
-Features
-========
-
-See user guide for the details of Decanter features:
-
-Collectors
------------
-* decanter-collector-camel
-* decanter-collector-dropwizard
-* decanter-collector-eventadmin
-* decanter-collector-file
-* decanter-collector-jms
-* decanter-collector-jmx
-* decanter-collector-kafka
-* decanter-collector-log
-* decanter-collector-log4j-socket
-* decanter-collector-mqtt
-* decanter-collector-process
-* decanter-collector-rest
-* decanter-collector-rest-servlet
-* decanter-collector-socket
-* decanter-collector-system
-
-Appenders
----------
-* decanter-appender-camel
-* decanter-appender-cassandra
-* decanter-appender-dropwizard
-* decanter-appender-elasticsearch-jest
-* decanter-appender-elasticsearch-native-1.x
-* decanter-appender-elasticsearch-native-2.x
-* decanter-appender-elasticsearch-rest
-* decanter-appender-file
-* decanter-appender-jdbc
-* decanter-appender-jms
-* decanter-appender-kafka
-* decanter-appender-log
-* decanter-appender-mongodb
-* decanter-appender-mqtt
-* decanter-appender-orientdb
-* decanter-appender-redis
-* decanter-appender-rest
-* decanter-appender-socket
-
-Alerters
-------------
-* decanter-alerting-log
-* decanter-alerting-email
-* decanter-alerting-camel
-
-Additional features
--------------------
-WARNING: Since Apache Karaf Decanter 2.0.0, it's not recommended to use the embedded instances of these backends.
-We encourage users to install, setup and start backends.
-
-* elasticsearch 1.7.4
-* elasticsearch 2.2.0
-* elasticsearch 5.6.3
-* elasticsearch 6.1.1
-* elasticsearch-head 1.7.4
-* elasticsearch-head 2.2.0
-* kibana 3.1.1
-* kibana 4.1.2
-* kibana 6.1.1
-* orientdb 2.2.31
-
-Thanks for using Apache Karaf Decanter !
-
---
-The Karaf Team
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..96c58c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,122 @@
+<!--
+ 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.
+-->
+
+# Apache Karaf Decanter
+
+Apache Karaf Decanter is a complete monitoring platform for Apache Karaf.
+It is very extensible, flexible, easy to install and use.
+
+## Overview
+
+* **Collectors**: The collectors are 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).
+* **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
+ backend systems.
+* **Alerting**: the alerting layer provides a checker, responsible of testing values of
+ harvested data (coming from the collectors) and send alerts when the data
+ is not in the expected state.
+
+## Getting Started
+
+Apache Karaf Decanter is available as a Karaf features. The following command registers
+the Karaf Decanter features repository.
+
+```
+karaf@root()> feature:repo-add decanter
+```
+
+Depending of what you want to monitor and collect, you have to install the corresponding features
+using `feature:install` command.
+
+## Features
+
+See user guide for the details of Decanter features:
+
+### Collectors
+
+* `decanter-collector-camel`
+* `decanter-collector-dropwizard`
+* `decanter-collector-eventadmin`
+* `decanter-collector-file`
+* `decanter-collector-jdbc`
+* `decanter-collector-jms`
+* `decanter-collector-jmx`
+* `decanter-collector-kafka`
+* `decanter-collector-log`
+* `decanter-collector-log4j-socket`
+* `decanter-collector-mqtt`
+* `decanter-collector-process`
+* `decanter-collector-rest`
+* `decanter-collector-rest-servlet`
+* `decanter-collector-socket`
+* `decanter-collector-system`
+
+### Appenders
+
+* `decanter-appender-camel`
+* `decanter-appender-cassandra`
+* `decanter-appender-dropwizard`
+* `decanter-appender-elasticsearch-jest`
+* `decanter-appender-elasticsearch-native-1.x`
+* `decanter-appender-elasticsearch-native-2.x`
+* `decanter-appender-elasticsearch-rest`
+* `decanter-appender-file`
+* `decanter-appender-jdbc`
+* `decanter-appender-jms`
+* `decanter-appender-kafka`
+* `decanter-appender-log`
+* `decanter-appender-mongodb`
+* `decanter-appender-mqtt`
+* `decanter-appender-orientdb`
+* `decanter-appender-redis`
+* `decanter-appender-rest`
+* `decanter-appender-socket`
+
+### Alerters
+
+* `decanter-alerting-log`
+* `decanter-alerting-email`
+* `decanter-alerting-camel`
+
+### (Optional) Additional backend features
+
+WARNING: Since Apache Karaf Decanter 2.0.0, it's not recommended to use the embedded instances of these backends.
+We encourage users to install, setup and start backends for production system.
+
+* `elasticsearch 1.7.4`
+* `elasticsearch 2.2.0`
+* `elasticsearch 5.6.3`
+* `elasticsearch 6.2.4`
+* `elasticsearch-head 1.7.4`
+* `elasticsearch-head 2.2.0`
+* `kibana 3.1.1`
+* `kibana 4.1.2`
+* `kibana 6.1.1`
+* `orientdb 2.2.31`
+
+Thanks for using Apache Karaf Decanter !
+
+
+**The Apache Karaf Team**
diff --git a/RELEASE-NOTES b/RELEASE-NOTES.md
similarity index 74%
rename from RELEASE-NOTES
rename to RELEASE-NOTES.md
index cf79d22..91113e3 100644
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES.md
@@ -1,24 +1,76 @@
-/*
- * 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.
- */
+<!--
+ 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
- Apache Karaf Decanter 2.0.0
- ===========================
- Overview
- --------
+ 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.
+-->
+
+## Apache Karaf Decanter 2.1.0
+
+### Overview
+
+Apache Karaf Decanter 2.1.0 is a maintenance release on the 2.x series. It provides lot of improvements and bug fixes.
+
+Especially:
+
+* New JDBC collector
+* Fix and improvements on the JMS collector and appender
+* Upgrade Kafka collector and appender to support Kafka 1.x
+* Improvements on the JMX collector to be able to execute MBean operations
+* Add new raw and parser services
+
+Take a look on ChangeLog for details.
+
+### ChangeLog
+
+#### Bug
+ * [KARAF-5890] - Decanter JMS Collector/Appender features has a requirement on ConnectionFactory service
+ * [KARAF-5891] - Decanter Log Collector creates a recursive log in Pax Logging
+
+#### New Feature
+ * [KARAF-5802] - Add JDBC collector
+
+#### Improvement
+ * [KARAF-5653] - Add a feature for the decanter manual
+ * [KARAF-5747] - Add append file capability in decanter-appender-file
+ * [KARAF-5754] - Make Decanter elasticsearch-jest appender support HTTPS/XPack enabled ES
+ * [KARAF-5785] - Add JMXMP support in JMX collector
+ * [KARAF-5792] - Support add, rename, remove to the custom fields of Decanter collectors
+ * [KARAF-5793] - Provide an option replace the dot or not in json field in the JsonMarshaller
+ * [KARAF-5799] - Be able to execute JMX operation in the collector
+ * [KARAF-5801] - Add regex filtering on collector file
+ * [KARAF-5864] - Add triming in system command output in the system collector to allow clean type conversion
+ * [KARAF-5888] - Be able to define a line parser service in the file collector
+ * [KARAF-5892] - Decanter JMS Collector should deal with "raw" message when no unmarshaller is provided
+ * [KARAF-5894] - Introduce a raw marshaller/unmarshaller (identity)
+
+#### Task
+ * [KARAF-5889] - Enable RAT on Decanter and fix all missing ASF headers
+
+#### Dependency upgrade
+ * [KARAF-5659] - Upgrade to Kafka 1.1.x
+ * [KARAF-5660] - Upgrade to elasticsearch 6.2.x (and corresponding bundle)
+ * [KARAF-5744] - Upgrade to elasticsearch 6.2.4
+ * [KARAF-5817] - Upgrade to maven-bundle-plugin 3.5.1
+ * [KARAF-5884] - Upgrade Kafka Collector and Appender to support Kafka 1.x
+ * [KARAF-5885] - Upgrade to commons-io 2.6 and improve Tailer configuration
+
+## Apache Karaf Decanter 2.0.0
+
+### Overview
+
Apache Karaf Decanter 2.0.0 is a new Decanter series, providing new features and bug fixes.
It's designed to work specifically on Apache Karaf 4.x.
@@ -31,13 +83,13 @@
NB: Apache Karaf Decanter 2.0.0 still provides embedded backend instances, like Elasticsearch 6, Kibana 6, OrientDB
and much more. However, for production, we recommend to use a dedicated and isolatic instance of these backends.
-For details, see the ChangeLog:
+### ChangeLog
-** Bug
+#### Bug
* [KARAF-5492] - Increase collectors scheduler period
* [KARAF-5587] - Deal with client error in appenders
-** New Feature
+#### New Feature
* [KARAF-4818] - Remove Jest client to use "native" REST elasticsearch client
* [KARAF-5391] - Add decanter:alert* commands and MBeans
* [KARAF-5462] - Provide Decanter DropWizard Metric integration
@@ -45,26 +97,25 @@
* [KARAF-5501] - Upgrade to Kibana 6.x
* [KARAF-5502] - Add OrientDB appender (with the corresponding inner feature)
-** Improvement
+#### Improvement
* [KARAF-5454] - Collector socket - Add UDP protocol support
* [KARAF-5510] - Add custom fields support in log collector and appenders
* [KARAF-5557] - Support custom unmarshaller in socket collector
* [KARAF-5575] - Upgrade file appender to use SCR config property
* [KARAF-5577] - Define the marshaller in collector/appender configuration
-** Task
+#### Task
* [KARAF-5576] - Move all backends in an unique module
* [KARAF-5579] - Rename SLA bundles to Alerting
* [KARAF-5580] - Rename tools-jar-wraper to tools-jar-wrapper
-** Dependency upgrade
+#### Dependency upgrade
* [KARAF-5500] - Upgrade to Elasticsearch 5.x & 6.x
- Apache Karaf Decanter 1.4.0
- ===========================
+## Apache Karaf Decanter 1.4.0
- Overview
- --------
+### Overview
+
Apache Karaf Decanter 1.4.0 is a maintenance release, providing new features (Karaf scheduler, email alerter improvements, ...) and bug fixes.
Decanter is a completed monitoring and alerting solution for Apache Karaf container, and related applications
@@ -72,11 +123,9 @@
You can use Decanter in any Karaf version.
-For details, see the ChangeLog:
+### ChangeLog
- ChangeLog
- ---------
-** Bug
+#### Bug
* [KARAF-4906] - Decanter e-mail alerter can't use javamail authentication
* [KARAF-5141] - Decanter log collector seems to consume lot of resources on Karaf 4.1.x
* [KARAF-5186] - [DECANTER] - Fails work in case the event topic contains arbitrary characters like %
@@ -85,10 +134,10 @@
* [KARAF-5239] - JMX collector doesn't full harvest metrics
* [KARAF-5240] - Default Kibana dashboard doesn't render correctly
-** Dependency upgrade
+#### Dependency upgrade
* [KARAF-4541] - Upgrade to Kafka 0.11.0.0
-** Improvement
+#### Improvement
* [KARAF-3696] - Decanter: Switch to Karaf provided Scheduler (Cron-based)
* [KARAF-4645] - Alerters should be throttable
* [KARAF-4850] - Be able to specify several object names for the JMX collector
@@ -97,15 +146,14 @@
* [KARAF-5192] - Decanter collector should be able to filter some loggers
* [KARAF-5244] - Refactor kafka config handling
-** New Feature
+#### New Feature
* [KARAF-3890] - Provide Decanter CXF interceptor collector
* [KARAF-5033] - Provide a Camel EventNotifier collector
- Apache Karaf Decanter 1.3.0
- ===========================
+## Apache Karaf Decanter 1.3.0
- Overview
- --------
+### Overview
+
Apache Karaf Decanter 1.3.0 is a major new Decanter release, providing new features (new collectors, new
appenders) and bug fixes.
@@ -116,28 +164,27 @@
For details, see the ChangeLog:
- ChangeLog
- ---------
-** Bug
+### ChangeLog
+
+#### Bug
* [KARAF-4647] - Can't append into Elasticsearch with JMS
* [KARAF-4757] - Decanter: elasticsearch-appender-rest shouldn't be dependent on http
* [KARAF-4767] - Decanter: collectors and appenders can't be re-used without default configuration
-** Improvement
+#### Improvement
* [KARAF-4749] - Support range, equal, and notequal for BigDecimal in org/apache/karaf/decanter/sla/checker/Checker.java
* [KARAF-4791] - Decanter: elasticsearch-rest appender should support multipe addresses
* [KARAF-4794] - Decanter: make sure the discovery is disabled if only one address is configured
* [KARAF-4799] - JMS collector should support TextMessage
-** New Feature
+#### New Feature
* [KARAF-4706] - Create MQTT collector
* [KARAF-4742] - Decanter: Add Java Process JMX Collector
- Apache Karaf Decanter 1.2.0
- ===========================
+## Apache Karaf Decanter 1.2.0
- Overview
- --------
+### Overview
+
Apache Karaf Decanter 1.2.0 is a major new Decanter release, providing lot of new features (new collectors, new
appenders) and bug fixes.
@@ -146,11 +193,9 @@
You can use Decanter in any Karaf version.
-For details, see the ChangeLog:
+### ChangeLog
- ChangeLog
- ---------
-** Bug
+#### Bug
* [KARAF-4516] - Extend Karaf feature import version range in Decanter Kibana bundle
* [KARAF-4525] - Decanter log collector should not ignore the log alerter category
* [KARAF-4532] - SystemCollector throws IOException
@@ -162,27 +207,26 @@
* [KARAF-4625] - JMS appender should use MapMessage property instead of JMS properties
* [KARAF-4629] - Can't append into Elasticsearch
-** Dependency upgrade
+#### Dependency upgrade
* [KARAF-4558] - Upgrade to Elasticsearch 1.7.4
* [KARAF-4560] - Upgrade to ActiveMQ 5.13.3
* [KARAF-4561] - Upgrade to Johnzon 0.9.3-incubating
-** Improvement
+#### Improvement
* [KARAF-4565] - Set ConfigurationPolicy.REQUIRE for decanter appenders and collectors
* [KARAF-4610] - Improve Decanter scheduler to reduce latency
-** New Feature
+#### New Feature
* [KARAF-4298] - Add MongoDB appender
* [KARAF-4320] - Create socket collector and appender
* [KARAF-4530] - Create Kafka collector
* [KARAF-4531] - Create JMS collector
* [KARAF-4546] - Support embedding decanter into spring boot apps
- Apache Karaf Decanter 1.1.0
- ===========================
+## Apache Karaf Decanter 1.1.0
- Overview
- --------
+### Overview
+
Apache Karaf Decanter 1.1.0 is the first release on the Decanter 1.1.x serie. It's a complete new version of Decanter
including a lot of new features and bug fixes.
@@ -191,11 +235,9 @@
You can use Decanter in any Karaf version.
-For details, see the ChangeLog:
+### ChangeLog
- ChangeLog
- ---------
-** Bug
+#### Bug
* [KARAF-4059] - Exception thrown during elasticsearch restart
* [KARAF-4121] - Escape characters in the log collection
* [KARAF-4125] - Elasticsearch clusterName and nodeName can't be changed
@@ -209,12 +251,12 @@
* [KARAF-4453] - Marshaller doesn't include subject property
* [KARAF-4480] - LogAppender should use timestamp instead of timeStamp
-** Dependency upgrade
+#### Dependency upgrade
* [KARAF-3624] - Provide Kibana 4.1 feature
* [KARAF-4331] - Upgrade to elasticsearch 2.2.0
* [KARAF-4431] - Upgrade to kafka 0.9.0.0
-** Improvement
+#### Improvement
* [KARAF-4113] - Be able to use a remote elasticsearch instance in Decanter Kibana
* [KARAF-4170] - Authentication to access Kibana dashboard on karaf-decanter
* [KARAF-4171] - Authentication to access elasticsearch-head on karaf-decanter
@@ -231,7 +273,7 @@
* [KARAF-4481] - LogAppender should check if the event is ignored earlier to avoid useless processing
* [KARAF-4495] - Add custom fields support in all collectors
-** New Feature
+#### New Feature
* [KARAF-3698] - Add decanter cassandra appender
* [KARAF-3773] - Add decanter redis appender
* [KARAF-4120] - Provide elasticsearch 2.x feature
@@ -243,11 +285,9 @@
* [KARAF-4404] - Create eventadmin collector
* [KARAF-4443] - Create default dahboards in Decanter Kibana 4.x
- Apache Karaf Decanter 1.0.1
- ===========================
+## Apache Karaf Decanter 1.0.1
- Overview
- --------
+### Overview
Apache Karaf Decanter 1.0.1 is a fix version on the decanter-1.x serie. It also brings new features like the file collector.
@@ -256,31 +296,27 @@
You can use Decanter in any Karaf version.
-For details, see the ChangeLog:
+### ChangeLog
- ChangeLog
- ---------
-** Bug
+#### Bug
* [KARAF-4061] - Decanter ElasticSearchAppender - NumberFormatException
-** Dependency upgrade
+#### Dependency upgrade
* [KARAF-4063] - Upgrade to elasticsearch 1.7.1
* [KARAF-4101] - Upgrade to elasticsearch 1.7.3
-** Improvement
+#### Improvement
* [KARAF-3979] - Be able to define a SLA check for a given type
* [KARAF-4008] - Add custom fields support in JMX collector
* [KARAF-4014] - Add a warning in Decanter System dashboard
-** New Feature
+#### New Feature
* [KARAF-3904] - Add elasticsearch eshead plugin in embedded instance
* [KARAF-3905] - Provide file collector (as in logstash)
- Apache Karaf Decanter 1.0.0
- ===========================
+## Apache Karaf Decanter 1.0.0
- Overview
- --------
+### Overview
Apache Karaf Decanter 1.0.0 is the first release of Decanter.
@@ -289,21 +325,19 @@
You can use Decanter in any Karaf version.
-For details, see the ChangeLog:
+### ChangeLog
- ChangeLog
- ---------
-** Bug
+#### Bug
* [KARAF-3815] - Decanter can't retrieve metrics for ObjectName containing white spaces
* [KARAF-3855] - Decanter JMX collector create bunch of threads
* [KARAF-3884] - ElasticsearchAppender sometimes throws NullPointer Exception when adding o.toString() to arrayBuilder
* [KARAF-3889] - The clusterName for the elasticsearch appender isn't an optional configuration as it should be.
-** Dependency upgrade
+#### Dependency upgrade
* [KARAF-3845] - Upgrade to elasticsearch 1.6.0
* [KARAF-3847] - Upgrade to kibana 3.1.2
-** Improvement
+#### Improvement
* [KARAF-3777] - Add Karaf source IP address or hostname in the collected data
* [KARAF-3836] - Add a configuration allowing to define the period of the simple scheduler
* [KARAF-3848] - Be able to define the embedded elasticsearch node by configuration
@@ -311,7 +345,7 @@
* [KARAF-3851] - Be able to poll remote MBeanServer
* [KARAF-3883] - The elasticsearch appender uses the default clustername of Elasticsearch client, this needs to be configurable
-** New Feature
+#### New Feature
* [KARAF-3637] - Decanter: JDBC appender
* [KARAF-3771] - Add decanter system collector
* [KARAF-3772] - Add Decanter SLA support
@@ -323,5 +357,5 @@
* [KARAF-3870] - Create SLA email alerting
* [KARAF-3881] - The embedded ElasticSearch Node should be configurable through config-admin
-** Wish
+#### Wish
* [KARAF-3675] - Check if recent Johnzon snapshot is OSGi ready
