kasakrisz commented on a change in pull request #54: AMBARI-23456. Add mkdocs
support & markdown skeletons
URL: https://github.com/apache/ambari-logsearch/pull/54#discussion_r239066254
##########
File path:
ambari-logsearch-docs/src/main/resources/templates/shipper_configurations.md.ftl
##########
@@ -17,19 +17,117 @@ limitations under the License.
## Log Feeder Shipper Descriptor
-### Top Level Descriptor Sections
+### Top Level Descriptors
+Input, Filter and Output configurations are defined in 3 (at least) different
files. (note: there can be multiple input configuration files, but only 1
output and global configuration)
+
+input.config-myservice.json example:
+```json
+{
+ "input" : [
+ ],
+ "filter" : [
+ ]
+}
+```
+output.config.json example:
+```json
+{
+ "output" : [
+ ]
+}
+```
+global.config.json example:
+```json
+{
+ "global" : {
+ "source" : "file",
+ "add_fields":{
+ "cluster":"cl1"
+ },
+ "tail" : "true"
+ }
+}
+```
| `Path` | `Description` | `Default` | `Examples` |
|---|---|---|---|
-<#if shipperConfigs.topLevelSections??>
- <#list shipperConfigs.topLevelSections as section>
+<#if shipperConfigs.topLevelConfigSections??>
+ <#list shipperConfigs.topLevelConfigSections as section>
|`${section.path}`|${section.description}|${section.defaultValue}|${section.examples}|
</#list>
</#if>
-|`/output`|A list of output descriptors|`{}`||
+|`/output`|A list of output descriptors|`{}`|<ul><li>`{"output":
[{"is_enabled" : "true", "destination": "solr", "myfield":
"myvalue"}]`</li></ul>|
+|`/global`|A map that contains field/value pairs|`EMPTY`|<ul><li>`{"global":
{"myfield": "myvalue"}}`</li></ul>|
-### Input Descriptor Sections
+### Input Descriptor
+Input configurations (for monitoring logs) can be defined in the input
descriptor section.
+Example:
+```json
+{
+ "input" : [
+ {
+ "type": "simple_service",
+ "rowtype": "service",
+ "path": "/var/logs/my/service/service_sample.txt",
Review comment:
Maybe `service_sample.log` would be more useful.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
