[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16735934#comment-16735934 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #92 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/92/]) AMBARI-23456. Update development docs (oleewere: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=0ace4f5d15ce6f8eb3d3ef2e0ab6ba722319d435]) * (edit) docs/development.md > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > Time Spent: 50m > Remaining Estimate: 0h > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16735892#comment-16735892 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #91 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/91/]) AMBARI-23456. Update development docs (oleewere: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=423635b74231f3bb2766e26c8dc294b6837199ca]) * (edit) docs/development.md > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > Time Spent: 50m > Remaining Estimate: 0h > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16735830#comment-16735830 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #90 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/90/]) AMBARI-23456. Make rest api doc generation configureable & doc fixes (github: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=eeb9da1d5ae1df5cb17bb3294d4c698dd3d86d17]) * (edit) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchDocumentationGenerator.java * (edit) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/ServiceLogsResource.java * (edit) Makefile * (edit) ambari-logsearch-docs/pom.xml * (edit) docs/api-docs/logsearch-swagger.yaml > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > Time Spent: 50m > Remaining Estimate: 0h > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16734527#comment-16734527 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #88 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/88/]) AMBARI-23456. Fix typos. (oleewere: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=f5074e7a24407abca08c0a2d95db1f14daa2b267]) * (edit) README.md * (edit) docs/index.md * (edit) docs/development.md > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > Time Spent: 0.5h > Remaining Estimate: 0h > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16734450#comment-16734450 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #87 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/87/]) AMBARI-23456. Add developement guide markdowns & remove some old docs (github: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=1deed01e48015519c3e566762f53e2e5a38bb3eb]) * (delete) ambari-logsearch-server/README.md * (edit) docs/development.md * (edit) README.md * (delete) ambari-logsearch-logfeeder/README.md > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > Time Spent: 0.5h > Remaining Estimate: 0h > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16715940#comment-16715940 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #80 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/80/]) AMBARI-23456. Add more markdown docs (oleewere: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=2e218a8670c41354df5eed2952f281f57c4f9b13]) * (edit) ambari-logsearch-docs/pom.xml * (add) docs/images/test_sample.jpg * (edit) docs/add_new_input.md * (add) docs/images/test_sample_result.jpg * (edit) pom.xml * (add) docs/images/add_service_wizard.png * (add) docs/images/edit_configs.jpg * (add) docs/images/architecture_overview.jpg * (edit) docs/about.md * (delete) docs/getting_started.md * (edit) docs/cloud_mode.md * (edit) docs/docs.md * (add) docs/images/add_service.png * (add) docs/installation.md * (edit) mkdocs.yml * (delete) docs/schema_fields.md * (edit) docs/index.md * (add) docs/collections.md * (add) docs/development.md > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16715931#comment-16715931 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #79 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/79/]) AMBARI-23456. Add more markdown docs (oleewere: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=b2c1602b0dda3e999d4db5735edd300e37483b64]) * (add) docs/installation.md * (edit) mkdocs.yml * (add) docs/development.md * (delete) docs/getting_started.md * (add) docs/images/edit_configs.jpg * (add) docs/images/test_sample_result.jpg * (edit) docs/cloud_mode.md * (add) docs/images/add_service.png * (edit) pom.xml * (edit) docs/about.md * (edit) docs/add_new_input.md * (delete) docs/schema_fields.md * (edit) docs/docs.md * (edit) ambari-logsearch-docs/pom.xml * (add) docs/images/test_sample.jpg * (edit) docs/index.md * (add) docs/collections.md * (add) docs/images/architecture_overview.jpg * (add) docs/images/add_service_wizard.png > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710272#comment-16710272 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #68 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/68/]) AMBARI-23456. Add mkdocs support & markdown skeletons (#54) (github: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=6ff4dc21dd428bd57afd2bc95ba7c2ab4f6a7f8c]) * (edit) ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputConfigImpl.java * (edit) ambari-logsearch-server/pom.xml * (add) docs/docs.md * (edit) pom.xml * (add) ambari-logsearch-docs/src/main/resources/docs.md * (add) docs/add_new_input.md * (edit) ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/ConditionsImpl.java * (edit) ambari-logsearch-docs/pom.xml * (edit) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/ShipperConfigDescriptionDataHolder.java * (edit) ambari-logsearch-logfeeder/src/main/java/org/apache/ambari/logfeeder/conf/LogFeederProps.java * (add) docs/getting_started.md * (add) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchDocumentationGenerator.java * (edit) ambari-logsearch-logfeeder-plugin-api/src/main/java/org/apache/ambari/logfeeder/plugin/output/Output.java * (edit) ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/FieldsImpl.java * (add) docs/index.md * (add) docs/api-docs/logsearch-swagger.yaml * (add) docs/schema_fields.md * (edit) ambari-logsearch-logfeeder/src/main/java/org/apache/ambari/logfeeder/output/OutputSolr.java * (delete) docs/.keep * (add) docs/about.md * (delete) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java * (add) docs/logfeeder_properties.md * (edit) ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputS3FileDescriptorImpl.java * (edit) ambari-logsearch-docs/src/main/resources/templates/shipper_configurations.md.ftl * (edit) .gitignore * (edit) Makefile * (add) mkdocs.yml * (edit) ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/FilterGrokDescriptorImpl.java * (add) docs/logsearch_properties.md * (add) docs/shipper_configurations.md * (add) docs/cloud_mode.md > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710121#comment-16710121 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-444502771 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/112/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710098#comment-16710098 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-95424 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/111/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710093#comment-16710093 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-92508 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/110/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710090#comment-16710090 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-91157 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/109/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710085#comment-16710085
]
ASF GitHub Bot commented on AMBARI-23456:
-
oleewere 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_r239068143
##
File path:
ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputConfigImpl.java
##
@@ -39,15 +39,17 @@
@ShipperConfigElementDescription(
path = "/input",
type = "list of json objects",
-description = "A list of input descriptions"
+description = "A list of input descriptions",
+examples = {"{\"input\" : [ {\"type\": \"myinput_service_type\"}] }"}
Review comment:
@kasakrisz ok, could be
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 2.8.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 2.8.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710080#comment-16710080
]
ASF GitHub Bot commented on AMBARI-23456:
-
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_r239064714
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchDocumentationGenerator.java
##
@@ -130,12 +140,32 @@ public static void main(String[] args) {
File shipperConfigsOutputFile = Paths.get(outputDir,
SHIPPER_CONFIGURATIONS_MARKDOWN_OUTPUT).toFile();
writeMarkdown(freemarkerConfiguration,
SHIPPER_CONFIGURATIONS_MARKDOWN_TEMPLATE_FILE, shipperConfigModels,
shipperConfigsOutputFile);
+ String swaggerYaml = generateSwaggerYaml();
+ File swaggerYamlFile = Paths.get(outputDir, SWAGGER_API_DOC_FOLDER,
SWAGGER_YAML_FILE_NAME).toFile();
+ FileUtils.writeStringToFile(swaggerYamlFile, swaggerYaml,
Charset.defaultCharset());
} catch (Exception e) {
e.printStackTrace();
System.exit(1);
}
}
+ private static String generateSwaggerYaml() throws Exception {
+ApiDocConfig apiDocConfig = new ApiDocConfig();
+BeanConfig beanConfig = apiDocConfig.swaggerConfig();
+Swagger swagger = beanConfig.getSwagger();
+swagger.addSecurityDefinition("basicAuth", new BasicAuthDefinition());
+beanConfig.configure(swagger);
+beanConfig.scanAndRead();
+String yaml = Yaml.mapper().writeValueAsString(swagger);
+StringBuilder b = new StringBuilder();
+String[] parts = yaml.split("\n");
+for (String part : parts) {
+ b.append(part);
+ b.append("\n");
+}
+return b.toString();
Review comment:
What is the difference between the result of `b.toString()` and `yaml` ?
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 2.8.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 2.8.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710082#comment-16710082
]
ASF GitHub Bot commented on AMBARI-23456:
-
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_r239059077
##
File path:
ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputConfigImpl.java
##
@@ -39,15 +39,17 @@
@ShipperConfigElementDescription(
path = "/input",
type = "list of json objects",
-description = "A list of input descriptions"
+description = "A list of input descriptions",
+examples = {"{\"input\" : [ {\"type\": \"myinput_service_type\"}] }"}
Review comment:
What do you think? Would adding the following is helpful:
```
where myinput_service_type is like ambari_server, hdfs_namenode etc...
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 2.8.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 2.8.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710079#comment-16710079 ] ASF GitHub Bot commented on AMBARI-23456: - 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_r239062724 ## File path: ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputS3FileDescriptorImpl.java ## @@ -34,7 +34,7 @@ @ShipperConfigElementDescription( path = "/input/[]/s3_access_key", type = "string", -description = "The access key used for AWS credentials." +description = "The access key used for AWS credentials. (Not supported yet through shipper configurations)" Review comment: Is it possible to omit these not supported properties from the doc? I think these should only be included if the functionality is supported. lines: 37, 46, 55 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710083#comment-16710083
]
ASF GitHub Bot commented on AMBARI-23456:
-
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}|
-|`/output`|A list of output descriptors|`{}`||
+|`/output`|A list of output descriptors|`{}`|`{"output":
[{"is_enabled" : "true", "destination": "solr", "myfield":
"myvalue"}]`|
+|`/global`|A map that contains field/value pairs|`EMPTY`|`{"global":
{"myfield": "myvalue"}}`|
-### 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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 2.8.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 2.8.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710084#comment-16710084
]
ASF GitHub Bot commented on AMBARI-23456:
-
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_r239066570
##
File path:
ambari-logsearch-docs/src/main/resources/templates/shipper_configurations.md.ftl
##
@@ -38,8 +136,97 @@ limitations under the License.
-### Filter Descriptor Sections
+### Filter Descriptor
+Filter configurations can be defined in the filter descriptor section.
+Example:
+```json
+{
+ "input" : [
+ ],
+ "filter": [
+{
+ "filter": "json",
+ "conditions": {
+"fields": {
+ "type": [
+"simple_service_json"
+ ]
+}
+ }
+}
+{
+ "filter": "grok",
+ "deep_extract": "false",
+ "conditions":{
+"fields":{
+ "type":[
+"simple_service",
+"simple_audit_service",
+"docker_service"
+ ]
+}
+ },
+ "log4j_format":"%d{ISO8601} %5p [%t] %c{1}:%L - %m%n",
+ "multiline_pattern":"^(%{TIMESTAMP_ISO8601:logtime})",
+
"message_pattern":"(?m)^%{TIMESTAMP_ISO8601:logtime}%{SPACE}%{LOGLEVEL:level}%{SPACE}\\[%{DATA:thread_name}\\]%{SPACE}%{JAVACLASS:logger_name}:%{INT:line_number}%{SPACE}-%{SPACE}%{GREEDYDATA:log_message}",
Review comment:
Including some lines of sample log can be useful to understand what log
entries can be parsed with this pattern.
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 2.8.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 2.8.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710081#comment-16710081
]
ASF GitHub Bot commented on AMBARI-23456:
-
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_r239061724
##
File path:
ambari-logsearch-config-json/src/main/java/org/apache/ambari/logsearch/config/json/model/inputconfig/impl/InputConfigImpl.java
##
@@ -39,15 +39,17 @@
@ShipperConfigElementDescription(
path = "/input",
type = "list of json objects",
-description = "A list of input descriptions"
+description = "A list of input descriptions",
+examples = {"{\"input\" : [ {\"type\": \"myinput_service_type\"}] }"}
)
@Expose
private List input;
@ShipperConfigElementDescription(
path = "/filter",
type = "list of json objects",
-description = "A list of filter descriptions"
+description = "A list of filter descriptions",
+examples = {"{\"filter\" : [ {\"filter\": \"json\", \"conditions\":
{\"fields\": { \"type\": [\"mytype1\", \"mytype2\"]} } } ]}"}
Review comment:
Same as above (line 43). Giving a concrete example could be useful.
```
"filter":[
{
"filter":"json",
"conditions":{
"fields":{
"type":[
"logsearch_app",
"logsearch_feeder",
"logsearch_perf"
]
}
}
}
]
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 2.8.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 2.8.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16709977#comment-16709977 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-61394 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/107/ Test FAILed. Test FAILured. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16709984#comment-16709984 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-63348 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/108/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16709973#comment-16709973 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54#issuecomment-60373 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/106/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16709971#comment-16709971 ] ASF GitHub Bot commented on AMBARI-23456: - oleewere opened a new pull request #54: AMBARI-23456. Add mkdocs support & markdown skeletons URL: https://github.com/apache/ambari-logsearch/pull/54 # What changes were proposed in this pull request? - fix some docs - generate output shipper configs as well - add mkdocs support - put javadoc + rest api doc as well to generated site - add markdown skeletons (i will need to fill those + add nice pictures) note: probably we will use docker for mkdocs build, right now it is expected to be installed ## How was this patch tested? full test: `make serve-site`, it can take long because of 2 web build, if modules are already installed then its enough to run: `make javadoc`, `make prop-docs-only` then `make serve-site-only` Please review @g-boros 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 2.8.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 2.8.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708619#comment-16708619 ] Hudson commented on AMBARI-23456: - SUCCESS: Integrated in Jenkins build Ambari-LogSearch-master-Commit #66 (See [https://builds.apache.org/job/Ambari-LogSearch-master-Commit/66/]) AMBARI-23456. Generate markdown docs from internal annotations. (#53) (github: [https://gitbox.apache.org/repos/asf?p=ambari-logsearch.git&a=commit&h=a1f1c6755d862d32806bcb003008db516e60d1df]) * (edit) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java * (edit) Makefile * (add) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/ShipperConfigDescriptionDataHolder.java * (edit) ambari-logsearch-logfeeder/src/main/java/org/apache/ambari/logfeeder/conf/output/S3OutputConfig.java * (edit) pom.xml * (delete) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/model/response/PropertyDescriptionData.java * (add) ambari-logsearch-docs/src/main/resources/templates/shipper_configurations.md.ftl * (edit) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/InfoResource.java * (add) ambari-logsearch-docs/pom.xml * (delete) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/common/ShipperConfigDescriptionStorage.java * (add) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/AbstractDescriptionData.java * (edit) ambari-logsearch-logfeeder/src/main/java/org/apache/ambari/logfeeder/conf/LogFeederProps.java * (add) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java * (add) ambari-logsearch-docs/src/main/resources/log4j2.xml * (add) ambari-logsearch-docs/src/main/resources/templates/logsearch_properties.md.ftl * (add) docs/.keep * (add) ambari-logsearch-docs/src/main/resources/templates/logfeeder_properties.md.ftl * (delete) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/model/response/ShipperConfigDescriptionData.java * (edit) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/manager/InfoManager.java * (delete) ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/common/PropertyDescriptionStorage.java * (add) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/PropertyDescriptionData.java * (add) ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/ShipperConfigDescriptionData.java > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708615#comment-16708615
]
ASF GitHub Bot commented on AMBARI-23456:
-
oleewere closed pull request #53: AMBARI-23456. Generate markdown docs from
internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/Makefile b/Makefile
index 5f9c8b0f0a..cfeaada1d6 100644
--- a/Makefile
+++ b/Makefile
@@ -46,6 +46,12 @@ rpm:
deb:
$(MAVEN_BINARY) clean package -Dbuild-deb -DskipTests
-Djdk.version=$(LOGSEARCH_JAVA_VERSION)
+prop-docs: install
+ $(MAVEN_BINARY) -pl ambari-logsearch-docs exec:java -DskipTests
-Djdk.version=$(LOGSEARCH_JAVA_VERSION)
+
+prop-docs-only:
+ $(MAVEN_BINARY) -pl ambari-logsearch-docs clean package exec:java
-DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION)
+
update-version:
$(MAVEN_BINARY) versions:set-property -Dproperty=revision
-DnewVersion=$(new-version) -DgenerateBackupPoms=false
diff --git a/ambari-logsearch-docs/pom.xml b/ambari-logsearch-docs/pom.xml
new file mode 100644
index 00..f43117c40a
--- /dev/null
+++ b/ambari-logsearch-docs/pom.xml
@@ -0,0 +1,87 @@
+
+
+http://maven.apache.org/POM/4.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+
+ambari-logsearch
+org.apache.ambari
+${revision}
+
+ 4.0.0
+ jar
+ http://maven.apache.org
+ Ambari Logsearch Docs
+ ambari-logsearch-docs
+
+
+
+src/main/resources
+true
+
+
+
+
+org.apache.maven.plugins
+maven-compiler-plugin
+
+ ${jdk.version}
+ ${jdk.version}
+
+
+
+org.codehaus.mojo
+exec-maven-plugin
+1.2.1
+
+
+
+ java
+
+
+
+
+
org.apache.ambari.logsearch.doc.LogSearchMarkdownGenerator
+
+--output-dir
+${project.basedir}/../docs
+
+
+
+
+
+
+
+
+ org.apache.logging.log4j
+ log4j-api
+
+
+ org.apache.ambari
+ ambari-logsearch-logfeeder
+ ${project.version}
+
+
+ org.apache.ambari
+ ambari-logsearch-server
+ ${project.version}
+
+
+
+
+
\ No newline at end of file
diff --git
a/ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/AbstractDescriptionData.java
b/ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/AbstractDescriptionData.java
new file mode 100644
index 00..e95d2eaa5c
--- /dev/null
+++
b/ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/AbstractDescriptionData.java
@@ -0,0 +1,68 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+public abstract class AbstractDescriptionData {
+
+ private final String description;
+ private final String defaultValue;
+ private final String examples;
+
+ public AbstractDescriptionData(String description, String defaultStr,
String[] examplesArr) {
+this.description = description;
+examples = generateExamplesString(examplesArr);
+defaultValue = generateDefaultValue(defaultStr);
+ }
+
+ protected String generateDefaultValue(String defaultValue) {
+if (defaultValue == null || defaultValue.length() == 0) {
+ return "`EMPTY`";
+} else {
+ return defaultValue;
+}
+ }
+
+ protected String generateExamplesString(String[] examples) {
+if (examples == null) {
+ return "";
+} else {
+ final StringBuilder stringBuilder = new StringBuilder();
+ if(examples.length > 0){
+stringBuilder.append("");
+for( String example : example
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708613#comment-16708613 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-444078714 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/105/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708612#comment-16708612 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-444077960 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/104/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708610#comment-16708610 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-444077337 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/103/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708605#comment-16708605
]
ASF GitHub Bot commented on AMBARI-23456:
-
adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238634299
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/ShipperConfigDescritionDataHolder.java
##
@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import java.util.List;
+
+public class ShipperConfigDescritionDataHolder {
Review comment:
Sorry, but it's still not right.
```suggestion
public class ShipperConfigDescriptionDataHolder {
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 3.0.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 3.0.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708594#comment-16708594
]
ASF GitHub Bot commented on AMBARI-23456:
-
adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238632213
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/ShipperConfigDesritionDataHolder.java
##
@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import java.util.List;
+
+public class ShipperConfigDesritionDataHolder {
Review comment:
```suggestion
public class ShipperConfigDescriptionDataHolder {
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 3.0.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 3.0.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708590#comment-16708590 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-444073469 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/102/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708213#comment-16708213 ] ASF GitHub Bot commented on AMBARI-23456: - kasakrisz commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238527060 ## File path: ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java ## @@ -0,0 +1,223 @@ +/* + * 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. + */ +package org.apache.ambari.logsearch.doc; + +import com.google.common.collect.ImmutableList; Review comment: You can use `java.util.Collections.unmodifiableList` instead of `com.google.common.collect.ImmutableList` 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708210#comment-16708210
]
ASF GitHub Bot commented on AMBARI-23456:
-
kasakrisz commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238529400
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java
##
@@ -0,0 +1,223 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import com.google.common.collect.ImmutableList;
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import org.apache.ambari.logsearch.config.api.LogSearchPropertyDescription;
+import org.apache.ambari.logsearch.config.api.ShipperConfigElementDescription;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.io.FileUtils;
+import org.reflections.Reflections;
+import org.reflections.scanners.FieldAnnotationsScanner;
+import org.reflections.scanners.MethodAnnotationsScanner;
+import org.springframework.core.io.ClassPathResource;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.StringWriter;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.Charset;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+public class LogSearchMarkdownGenerator {
+
+ private static final String TOP_LEVEL_SECTIONS = "topLevelSections";
+ private static final String INPUT_CONFIG_SECTION = "inputConfigSection";
+ private static final String FILTER_CONFIG_SECTION = "filterConfigSection";
+ private static final String POST_MAP_VALUES_SECTION = "postMapValuesSection";
+ private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearchProperties";
+ private static final String LOGFEEDER_PROPERTIES_TEMPLATE_KEY =
"logfeederProperties";
+
+ private static final String OUTPUT_DIR_OPTION = "output-dir";
+
+ private static final String LOGSEARCH_PACKAGE =
"org.apache.ambari.logsearch";
+ private static final String LOGFEEDER_PACKAGE =
"org.apache.ambari.logfeeder";
+ private static final String CONFIG_API_PACKAGE =
"org.apache.ambari.logsearch.config.json.model.inputconfig.impl";
+
+ private static final String TEMPLATES_FOLDER = "templates";
+
+ private static final String LOGSEARCH_PROPERTIES = "logsearch.properties";
+ private static final String LOGSEARCH_PROPERTIES_MARKDOWN_TEMPLATE_FILE =
"logsearch_properties.md.ftl";
+ private static final String LOGSEARCH_PROPERTIES_MARKDOWN_OUTPUT =
"logsearch_properties.md";
+
+ private static final String LOGFEEDER_PROPERTIES = "logfeeder.properties";
+ private static final String LOGFEEDER_PROPERTIES_MARKDOWN_TEMPLATE_FILE =
"logfeeder_properties.md.ftl";
+ private static final String LOGFEEDER_PROPERTIES_MARKDOWN_OUTPUT =
"logfeeder_properties.md";
+
+ private static final String SHIPPER_CONFIGURATIONS_MARKDOWN_TEMPLATE_FILE =
"shipper_configurations.md.ftl";
+ private static final String SHIPPER_CONFIGURATIONS_MARKDOWN_OUTPUT =
"shipper_configurations.md";
+
+
+ public static void main(String[] args) {
+try {
+ Options options = new Options();
+ options.addOption(Option.builder()
+.desc("Output folder of the markdowns")
+.longOpt(OUTPUT_DIR_OPTION)
+.hasArg()
+.required()
+.type(String.class)
+.build());
+ CommandLineParser parser = new DefaultParser();
+ CommandLine cmdLine = parser.parse(options, args);
+
+ String outputDir = cmdLine.getOptionValue(OUTPUT_DIR_OPTION);
+ File outputFileDir = new File(outputDi
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708211#comment-16708211
]
ASF GitHub Bot commented on AMBARI-23456:
-
kasakrisz commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238528708
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java
##
@@ -0,0 +1,223 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import com.google.common.collect.ImmutableList;
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import org.apache.ambari.logsearch.config.api.LogSearchPropertyDescription;
+import org.apache.ambari.logsearch.config.api.ShipperConfigElementDescription;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.io.FileUtils;
+import org.reflections.Reflections;
+import org.reflections.scanners.FieldAnnotationsScanner;
+import org.reflections.scanners.MethodAnnotationsScanner;
+import org.springframework.core.io.ClassPathResource;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.StringWriter;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.Charset;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+public class LogSearchMarkdownGenerator {
+
+ private static final String TOP_LEVEL_SECTIONS = "topLevelSections";
+ private static final String INPUT_CONFIG_SECTION = "inputConfigSection";
+ private static final String FILTER_CONFIG_SECTION = "filterConfigSection";
+ private static final String POST_MAP_VALUES_SECTION = "postMapValuesSection";
+ private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearchProperties";
+ private static final String LOGFEEDER_PROPERTIES_TEMPLATE_KEY =
"logfeederProperties";
+
+ private static final String OUTPUT_DIR_OPTION = "output-dir";
+
+ private static final String LOGSEARCH_PACKAGE =
"org.apache.ambari.logsearch";
+ private static final String LOGFEEDER_PACKAGE =
"org.apache.ambari.logfeeder";
+ private static final String CONFIG_API_PACKAGE =
"org.apache.ambari.logsearch.config.json.model.inputconfig.impl";
+
+ private static final String TEMPLATES_FOLDER = "templates";
+
+ private static final String LOGSEARCH_PROPERTIES = "logsearch.properties";
+ private static final String LOGSEARCH_PROPERTIES_MARKDOWN_TEMPLATE_FILE =
"logsearch_properties.md.ftl";
+ private static final String LOGSEARCH_PROPERTIES_MARKDOWN_OUTPUT =
"logsearch_properties.md";
+
+ private static final String LOGFEEDER_PROPERTIES = "logfeeder.properties";
+ private static final String LOGFEEDER_PROPERTIES_MARKDOWN_TEMPLATE_FILE =
"logfeeder_properties.md.ftl";
+ private static final String LOGFEEDER_PROPERTIES_MARKDOWN_OUTPUT =
"logfeeder_properties.md";
+
+ private static final String SHIPPER_CONFIGURATIONS_MARKDOWN_TEMPLATE_FILE =
"shipper_configurations.md.ftl";
+ private static final String SHIPPER_CONFIGURATIONS_MARKDOWN_OUTPUT =
"shipper_configurations.md";
+
+
+ public static void main(String[] args) {
+try {
+ Options options = new Options();
+ options.addOption(Option.builder()
+.desc("Output folder of the markdowns")
+.longOpt(OUTPUT_DIR_OPTION)
+.hasArg()
+.required()
+.type(String.class)
+.build());
+ CommandLineParser parser = new DefaultParser();
+ CommandLine cmdLine = parser.parse(options, args);
+
+ String outputDir = cmdLine.getOptionValue(OUTPUT_DIR_OPTION);
+ File outputFileDir = new File(outputDi
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708212#comment-16708212
]
ASF GitHub Bot commented on AMBARI-23456:
-
kasakrisz commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238526407
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/AbstractDescriptionData.java
##
@@ -0,0 +1,68 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+public abstract class AbstractDescriptionData {
+
+ private final String description;
+ private final String defaultValue;
+ private final String examples;
+
+ public AbstractDescriptionData(String description, String defaultStr,
String[] examplesArr) {
+this.description = description;
+examples = generateExamplesString(examplesArr);
+defaultValue = generateDefaultValue(defaultStr);
+ }
+
+ protected String generateDefaultValue(String defaultValue) {
+if (defaultValue == null || defaultValue.length() == 0) {
+ return "`EMPTY`";
+} else {
+ return defaultValue;
+}
+ }
+
+ protected String generateExamplesString(String[] examples) {
+if (examples == null) {
+ return "";
+} else {
+ final StringBuilder stringBuilder = new StringBuilder();
+ if(examples.length > 0){
+stringBuilder.append("");
+for( String example : examples){
+ stringBuilder.append("").append("`").append(example).append("`");
Review comment:
Is an `append("")` missing from the end?
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 3.0.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 3.0.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707934#comment-16707934 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-443902728 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/101/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707930#comment-16707930 ] ASF GitHub Bot commented on AMBARI-23456: - oleewere commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238470558 ## File path: Makefile ## @@ -46,6 +46,9 @@ rpm: deb: $(MAVEN_BINARY) clean package -Dbuild-deb -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION) +prop-docs: + $(MAVEN_BINARY) -pl ambari-logsearch-docs clean package exec:java -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION) Review comment: @adoroszlai , i have added a prop-docs-only as well without install dependency, as building the web package is really slow 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707926#comment-16707926 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-44398 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/100/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707911#comment-16707911 ] ASF GitHub Bot commented on AMBARI-23456: - adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238452094 ## File path: Makefile ## @@ -46,6 +46,9 @@ rpm: deb: $(MAVEN_BINARY) clean package -Dbuild-deb -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION) +prop-docs: + $(MAVEN_BINARY) -pl ambari-logsearch-docs clean package exec:java -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION) Review comment: With this command, one needs to install logsearch into local maven repo first to avoid build failure: ``` $ make prop-docs mvn -pl ambari-logsearch-docs clean package exec:java -DskipTests -Djdk.version="1.8" ... [ERROR] Failed to execute goal on project ambari-logsearch-docs: Could not resolve dependencies for project org.apache.ambari:ambari-logsearch-docs:jar:3.0.0.0-SNAPSHOT: The following artifacts could not be resolved: org.apache.ambari:ambari-logsearch-logfeeder:jar:3.0.0.0-SNAPSHOT, org.apache.ambari:ambari-logsearch-server:jar:3.0.0.0-SNAPSHOT: Could not find artifact org.apache.ambari:ambari-logsearch-logfeeder:jar:3.0.0.0-SNAPSHOT in apache-hadoop (http://repo.hortonworks.com/content/groups/public/) -> [Help 1] ``` Possible fixes: 1. make: * declare make dependency `prop-docs: install` * remove `clean package` from `prop-docs` target 2. maven ([source](https://stackoverflow.com/a/11094503) for second step): * add `-am` flag to `mvn` command * move configuration of `exec-maven-plugin` to the parent pom's `pluginManagement` section, and bind the execution to a lifecycle phase, eg. `prepare-package` * remove `ambari-logsearch-docs` from the module list to reduce overlap between `prop-docs` and `package` targets 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707918#comment-16707918 ] ASF GitHub Bot commented on AMBARI-23456: - adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238452094 ## File path: Makefile ## @@ -46,6 +46,9 @@ rpm: deb: $(MAVEN_BINARY) clean package -Dbuild-deb -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION) +prop-docs: + $(MAVEN_BINARY) -pl ambari-logsearch-docs clean package exec:java -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION) Review comment: With this command, one needs to install logsearch into local maven repo first to avoid build failure: ``` $ make prop-docs mvn -pl ambari-logsearch-docs clean package exec:java -DskipTests -Djdk.version="1.8" ... [ERROR] Failed to execute goal on project ambari-logsearch-docs: Could not resolve dependencies for project org.apache.ambari:ambari-logsearch-docs:jar:3.0.0.0-SNAPSHOT: The following artifacts could not be resolved: org.apache.ambari:ambari-logsearch-logfeeder:jar:3.0.0.0-SNAPSHOT, org.apache.ambari:ambari-logsearch-server:jar:3.0.0.0-SNAPSHOT: Could not find artifact org.apache.ambari:ambari-logsearch-logfeeder:jar:3.0.0.0-SNAPSHOT in apache-hadoop (http://repo.hortonworks.com/content/groups/public/) -> [Help 1] ``` Possible fixes: 1. make: * declare make dependency `prop-docs: install` * remove `clean package` from `prop-docs` target 2. maven ([source](https://stackoverflow.com/a/11094503) for second step): * add `-am` flag to `mvn` command * move configuration of `exec-maven-plugin` to the parent pom's `pluginManagement` section, and bind the execution to a lifecycle phase, eg. `prepare-package` * remove `ambari-logsearch-docs` from the module list to reduce overlap between `prop-docs` and `package` targets (Either 1 or 2 could work, only one of them is needed.) 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707917#comment-16707917 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-443895974 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/99/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707912#comment-16707912
]
ASF GitHub Bot commented on AMBARI-23456:
-
adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238464056
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java
##
@@ -0,0 +1,223 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import com.google.common.collect.ImmutableList;
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import org.apache.ambari.logsearch.config.api.LogSearchPropertyDescription;
+import org.apache.ambari.logsearch.config.api.ShipperConfigElementDescription;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.io.FileUtils;
+import org.reflections.Reflections;
+import org.reflections.scanners.FieldAnnotationsScanner;
+import org.reflections.scanners.MethodAnnotationsScanner;
+import org.springframework.core.io.ClassPathResource;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.StringWriter;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.Charset;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+public class LogSearchMarkdownGenerator {
+
+ private static final String TOP_LEVEL_SECTIONS = "topLevelSections";
+ private static final String INPUT_CONFIG_SECTION = "inputConfigSection";
+ private static final String FILTER_CONFIG_SECTION = "filterConfigSection";
+ private static final String POST_MAP_VALUES_SECTION = "postMapValuesSection";
+ private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearchProperies";
Review comment:
```suggestion
private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearchProperties";
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 3.0.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 3.0.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707910#comment-16707910 ] ASF GitHub Bot commented on AMBARI-23456: - adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238448369 ## File path: ambari-logsearch-docs/src/main/resources/templates/logsearch_properties.md.ftl ## @@ -0,0 +1,25 @@ + +## Log Search Configurations + +| `Name` | `Description` | `Default` | `Examples` | +|---|---|---|---| +<#if logsearchProperies??> +<#list logsearchProperies as logsearchProperty> Review comment: ```suggestion <#list logsearchProperties as logsearchProperty> ``` 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707908#comment-16707908 ] ASF GitHub Bot commented on AMBARI-23456: - adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238448075 ## File path: ambari-logsearch-docs/src/main/resources/templates/logfeeder_properties.md.ftl ## @@ -0,0 +1,25 @@ + +## Log Feeder Configurations + +| `Name` | `Description` | `Default` | `Examples` | +|---|---|---|---| +<#if logfeederProperies??> Review comment: ```suggestion <#if logfeederProperties??> ``` 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707915#comment-16707915
]
ASF GitHub Bot commented on AMBARI-23456:
-
adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238447099
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java
##
@@ -0,0 +1,223 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import com.google.common.collect.ImmutableList;
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import org.apache.ambari.logsearch.config.api.LogSearchPropertyDescription;
+import org.apache.ambari.logsearch.config.api.ShipperConfigElementDescription;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.io.FileUtils;
+import org.reflections.Reflections;
+import org.reflections.scanners.FieldAnnotationsScanner;
+import org.reflections.scanners.MethodAnnotationsScanner;
+import org.springframework.core.io.ClassPathResource;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.StringWriter;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.Charset;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+public class LogSearchMarkdownGenerator {
+
+ private static final String TOP_LEVEL_SECTIONS = "topLevelSections";
+ private static final String INPUT_CONFIG_SECTION = "inputConfigSection";
+ private static final String FILTER_CONFIG_SECTION = "filterConfigSection";
+ private static final String POST_MAP_VALUES_SECTION = "postMapValuesSection";
+ private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearcProperies";
Review comment:
```suggestion
private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearchProperties";
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 3.0.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 3.0.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707913#comment-16707913 ] ASF GitHub Bot commented on AMBARI-23456: - adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238448119 ## File path: ambari-logsearch-docs/src/main/resources/templates/logfeeder_properties.md.ftl ## @@ -0,0 +1,25 @@ + +## Log Feeder Configurations + +| `Name` | `Description` | `Default` | `Examples` | +|---|---|---|---| +<#if logfeederProperies??> +<#list logfeederProperies as logfeederProperty> Review comment: ```suggestion <#list logfeederProperties as logfeederProperty> ``` 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[
https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707909#comment-16707909
]
ASF GitHub Bot commented on AMBARI-23456:
-
adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate
markdown docs from internal annotations.
URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238447985
##
File path:
ambari-logsearch-docs/src/main/java/org/apache/ambari/logsearch/doc/LogSearchMarkdownGenerator.java
##
@@ -0,0 +1,223 @@
+/*
+ * 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.
+ */
+package org.apache.ambari.logsearch.doc;
+
+import com.google.common.collect.ImmutableList;
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import org.apache.ambari.logsearch.config.api.LogSearchPropertyDescription;
+import org.apache.ambari.logsearch.config.api.ShipperConfigElementDescription;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.io.FileUtils;
+import org.reflections.Reflections;
+import org.reflections.scanners.FieldAnnotationsScanner;
+import org.reflections.scanners.MethodAnnotationsScanner;
+import org.springframework.core.io.ClassPathResource;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.StringWriter;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.Charset;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+public class LogSearchMarkdownGenerator {
+
+ private static final String TOP_LEVEL_SECTIONS = "topLevelSections";
+ private static final String INPUT_CONFIG_SECTION = "inputConfigSection";
+ private static final String FILTER_CONFIG_SECTION = "filterConfigSection";
+ private static final String POST_MAP_VALUES_SECTION = "postMapValuesSection";
+ private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY =
"logsearcProperies";
+ private static final String LOGFEEDER_PROPERTIES_TEMPLATE_KEY =
"logfeederProperies";
Review comment:
```suggestion
private static final String LOGFEEDER_PROPERTIES_TEMPLATE_KEY =
"logfeederProperties";
```
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
> Log Search: generate mardown docs for properties and logfeeder configs based
> on annotations
> ---
>
> Key: AMBARI-23456
> URL: https://issues.apache.org/jira/browse/AMBARI-23456
> Project: Ambari
> Issue Type: Bug
> Components: ambari-logsearch
>Affects Versions: 3.0.0
>Reporter: Olivér Szabó
>Assignee: Olivér Szabó
>Priority: Major
> Labels: pull-request-available
> Fix For: 3.0.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707914#comment-16707914 ] ASF GitHub Bot commented on AMBARI-23456: - adoroszlai commented on a change in pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#discussion_r238448313 ## File path: ambari-logsearch-docs/src/main/resources/templates/logsearch_properties.md.ftl ## @@ -0,0 +1,25 @@ + +## Log Search Configurations + +| `Name` | `Description` | `Default` | `Examples` | +|---|---|---|---| +<#if logsearchProperies??> Review comment: ```suggestion <#if logsearchProperties??> ``` 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707904#comment-16707904 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-443895080 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/98/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707783#comment-16707783 ] ASF GitHub Bot commented on AMBARI-23456: - asfgit commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-443868036 Refer to this link for build results (access rights to CI server needed): https://builds.apache.org/job/Ambari-LogSearch-Github-PR-Builder/97/ Test PASSed. 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707774#comment-16707774 ] ASF GitHub Bot commented on AMBARI-23456: - oleewere commented on issue #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53#issuecomment-443866045 retest this please 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (AMBARI-23456) Log Search: generate mardown docs for properties and logfeeder configs based on annotations
[ https://issues.apache.org/jira/browse/AMBARI-23456?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16707759#comment-16707759 ] ASF GitHub Bot commented on AMBARI-23456: - oleewere opened a new pull request #53: AMBARI-23456. Generate markdown docs from internal annotations. URL: https://github.com/apache/ambari-logsearch/pull/53 # What changes were proposed in this pull request? - remove /properties endpoint - generate markdown files based on annotations (for later usage - probably with mkdocs, but at least in README.md files on github) - create docs folder (empty one) - do not fill those folders yet, i will try to create better examples for shipper configurations. - generate docs with maven exec plugin + use it with make (i used prop-docs instead of docs - probably the docs will be with javadoc + prop-docs + mkdoc output) ## How was this patch tested? manually in IDE and with maven Please review @g-boros 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 > Log Search: generate mardown docs for properties and logfeeder configs based > on annotations > --- > > Key: AMBARI-23456 > URL: https://issues.apache.org/jira/browse/AMBARI-23456 > Project: Ambari > Issue Type: Bug > Components: ambari-logsearch >Affects Versions: 3.0.0 >Reporter: Olivér Szabó >Assignee: Olivér Szabó >Priority: Major > Labels: pull-request-available > Fix For: 3.0.0 > > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
