You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ambari.apache.org by jo...@apache.org on 2017/05/31 14:37:28 UTC

[14/17] ambari git commit: AMBARI-21144 ADDENDUM - Create .md files to describe Log Search input configurations (oleewere)

AMBARI-21144 ADDENDUM - Create .md files to describe Log Search input configurations (oleewere)


Project: http://git-wip-us.apache.org/repos/asf/ambari/repo
Commit: http://git-wip-us.apache.org/repos/asf/ambari/commit/4f36e145
Tree: http://git-wip-us.apache.org/repos/asf/ambari/tree/4f36e145
Diff: http://git-wip-us.apache.org/repos/asf/ambari/diff/4f36e145

Branch: refs/heads/branch-feature-AMBARI-12556
Commit: 4f36e1454dd37396782ef6497629192c603d5baf
Parents: f0d970b
Author: oleewere <ol...@gmail.com>
Authored: Wed May 31 11:29:08 2017 +0200
Committer: oleewere <ol...@gmail.com>
Committed: Wed May 31 11:29:08 2017 +0200

----------------------------------------------------------------------
 .../ambari-logsearch-logfeeder/README.md             | 15 ++++++++-------
 .../ambari-logsearch-logfeeder/docs/filter.md        |  6 +++---
 .../ambari-logsearch-logfeeder/docs/input.md         |  6 +++---
 .../ambari-logsearch-logfeeder/docs/inputConfig.md   |  2 +-
 .../ambari-logsearch-logfeeder/docs/postMapValues.md | 10 +++++-----
 5 files changed, 20 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/ambari/blob/4f36e145/ambari-logsearch/ambari-logsearch-logfeeder/README.md
----------------------------------------------------------------------
diff --git a/ambari-logsearch/ambari-logsearch-logfeeder/README.md b/ambari-logsearch/ambari-logsearch-logfeeder/README.md
index c5c6848..5a64daf 100644
--- a/ambari-logsearch/ambari-logsearch-logfeeder/README.md
+++ b/ambari-logsearch/ambari-logsearch-logfeeder/README.md
@@ -17,26 +17,27 @@ limitations under the License.
 {% endcomment %}
 -->
 
-#Log Search - Log Feeder:
+# Log Search - Log Feeder:
 
 Log Feeder is a component of the Log Search service that reads logs, parses them and stores them in Apache Solr for the purpose
 of later analysis.
 
-#Compilation
+# Compilation
+```bash
 mvn clean compile package
-
-#Deploy
-##Copy to remote
+```
+# Deploy
+## Copy to remote
 copy target/logsearch-logfeeder.tgz to host machine
 
-##Setup environment
+## Setup environment
 ```bash
 mkdir /opt/logfeeder
 cd /opt/logfeeder
 tar xfz ~/logsearch-logfeeder.tar.gz 
 ```
 
-#Input Configuration
+# Input Configuration
 
 The configuration for the log feeder contains
 * description of the log files

http://git-wip-us.apache.org/repos/asf/ambari/blob/4f36e145/ambari-logsearch/ambari-logsearch-logfeeder/docs/filter.md
----------------------------------------------------------------------
diff --git a/ambari-logsearch/ambari-logsearch-logfeeder/docs/filter.md b/ambari-logsearch/ambari-logsearch-logfeeder/docs/filter.md
index 42c3271..129279b 100644
--- a/ambari-logsearch/ambari-logsearch-logfeeder/docs/filter.md
+++ b/ambari-logsearch/ambari-logsearch-logfeeder/docs/filter.md
@@ -17,7 +17,7 @@ limitations under the License.
 {% endcomment %}
 -->
 
-#Filter
+# Filter
 
 The filter element in the [input configuration](inputConfig.md) contains a list of filter descriptions, each describing one filter
 applied on an input.
@@ -35,7 +35,7 @@ The general elements in the json are the following:
 | is\_enabled           | A flag to show if the filter should be used                                                     | true        |
 
 
-##Grok Filter
+## Grok Filter
 
 Grok filters have the following additional parameters:
 
@@ -46,7 +46,7 @@ Grok filters have the following additional parameters:
 | message\_pattern   | The grok pattern to use to parse the log entry                                                             | -       |
 
 
-##Key-value Filter
+## Key-value Filter
 
 Key-value filters have the following additional parameters:
 

http://git-wip-us.apache.org/repos/asf/ambari/blob/4f36e145/ambari-logsearch/ambari-logsearch-logfeeder/docs/input.md
----------------------------------------------------------------------
diff --git a/ambari-logsearch/ambari-logsearch-logfeeder/docs/input.md b/ambari-logsearch/ambari-logsearch-logfeeder/docs/input.md
index e95401a..661eeb8 100644
--- a/ambari-logsearch/ambari-logsearch-logfeeder/docs/input.md
+++ b/ambari-logsearch/ambari-logsearch-logfeeder/docs/input.md
@@ -17,7 +17,7 @@ limitations under the License.
 {% endcomment %}
 -->
 
-#Input
+# Input
 
 The input element in the [input configuration](inputConfig.md) contains a list of input descriptions, each describing one source
 of input.
@@ -42,7 +42,7 @@ The general elements in the json are the following:
 | is\_enabled                 | A flag to show if the input should be used                                                            | true         |
 
 
-##File Input
+## File Input
 
 File inputs have the following parameters too:
 
@@ -53,7 +53,7 @@ File inputs have the following parameters too:
 | copy\_file               | Should the file be copied \(only if not processed\)                | false   |
 
 
-##S3 File Input
+## S3 File Input
 
 S3 file inputs have the following parameters in addition to the general file parameters:
 

http://git-wip-us.apache.org/repos/asf/ambari/blob/4f36e145/ambari-logsearch/ambari-logsearch-logfeeder/docs/inputConfig.md
----------------------------------------------------------------------
diff --git a/ambari-logsearch/ambari-logsearch-logfeeder/docs/inputConfig.md b/ambari-logsearch/ambari-logsearch-logfeeder/docs/inputConfig.md
index ae7ac05..a507bfd 100644
--- a/ambari-logsearch/ambari-logsearch-logfeeder/docs/inputConfig.md
+++ b/ambari-logsearch/ambari-logsearch-logfeeder/docs/inputConfig.md
@@ -17,7 +17,7 @@ limitations under the License.
 {% endcomment %}
 -->
 
-#Input Configuration
+# Input Configuration
 
 The input configurations are stored in json files. Each of them are describing the processing of the log files of a service.
 

http://git-wip-us.apache.org/repos/asf/ambari/blob/4f36e145/ambari-logsearch/ambari-logsearch-logfeeder/docs/postMapValues.md
----------------------------------------------------------------------
diff --git a/ambari-logsearch/ambari-logsearch-logfeeder/docs/postMapValues.md b/ambari-logsearch/ambari-logsearch-logfeeder/docs/postMapValues.md
index aa381cd..906359a 100644
--- a/ambari-logsearch/ambari-logsearch-logfeeder/docs/postMapValues.md
+++ b/ambari-logsearch/ambari-logsearch-logfeeder/docs/postMapValues.md
@@ -17,14 +17,14 @@ limitations under the License.
 {% endcomment %}
 -->
 
-#Post Map Values
+# Post Map Values
 
 The Post Map Values element in the [filter](filter.md) field names as keys, the values are lists of sets of post map values, each
 describing one mapping done on a field named before obtained after filtering.
 
 Currently there are four kind of mappings are supported:
 
-##Map Date
+## Map Date
 
 The name of the mapping element should be map\_date. The value json element may contain the following parameters:
 
@@ -34,7 +34,7 @@ The name of the mapping element should be map\_date. The value json element may
 | target\_date\_pattern | If 'epoch' then the field is parsed as seconds from 1970, otherwise the content used as pattern        |
 
 
-##Map Copy
+## Map Copy
 
 The name of the mapping element should be map\_copy. The value json element should contain the following parameter:
 
@@ -43,7 +43,7 @@ The name of the mapping element should be map\_copy. The value json element shou
 | copy\_name | The name of the copied field  |
 
 
-##Map Field Name
+## Map Field Name
 
 The name of the mapping element should be map\_fieldname. The value json element should contain the following parameter:
 
@@ -51,7 +51,7 @@ The name of the mapping element should be map\_fieldname. The value json element
 |------------------|-------------------------------|
 | new\_field\_name | The name of the renamed field |
 
-##Map Field Value
+## Map Field Value
 
 The name of the mapping element should be map\_fieldvalue. The value json element should contain the following parameter: