[
https://issues.apache.org/jira/browse/METRON-1050?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16099647#comment-16099647
]
ASF GitHub Bot commented on METRON-1050:
----------------------------------------
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/metron/pull/656#discussion_r129219973
--- Diff: metron-analytics/metron-profiler/README.md ---
@@ -17,7 +17,7 @@ Any field contained within a message can be used to
generate a profile. A profi
Follow these instructions to install the Profiler. This assumes that core
Metron has already been installed and validated.
-1. Build the Metron RPMs by [following these
instructions](../../metron-deployment#rpm).
+1. Build the Metron RPMs (see Building the
[RPM](../../metron-deployment#rpm)s).
--- End diff --
Suggest: please consider changing the referenced h2 title in
metron-deployment/README.md to "RPMs", so that you can then include the entire
actual header anchor text in the square brackets and corresponding link name in
the parentheses; ie, \[RPMs\]\(../../metron-deployment#rpms\) Chunking it like
this patch makes the fix-up semantics much harder to reason about (and gives
ugly links that aren't whole words).
> Improve Docs of `profiler.period.duration`
> -------------------------------------------
>
> Key: METRON-1050
> URL: https://issues.apache.org/jira/browse/METRON-1050
> Project: Metron
> Issue Type: Bug
> Affects Versions: 0.4.0
> Reporter: Nick Allen
> Assignee: Nick Allen
> Fix For: 0.4.1
>
>
> It is a common mistake for new user's of the Profiler, to alter the
> Profiler's `profiler.period.duration` property, but not alter the
> corresponding `profiler.client.period.duration` property. The new user is
> then unable to read the profile data as they would expect.
> More should be done, but this JIRA focuses on improving the documentation
> around this common error experienced by new users.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
