[
https://issues.apache.org/jira/browse/METRON-1050?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16091681#comment-16091681
]
ASF GitHub Bot commented on METRON-1050:
----------------------------------------
GitHub user nickwallen opened a pull request:
https://github.com/apache/metron/pull/656
METRON-1050 Improve Docs of 'profile.period.duration'
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.
- [ ] When the site-book is generated, the links that I have embedded for
each property do not seem to work. It works just fine when rendered by Github.
I am not sure what the problem is.
## Pull Request Checklist
- [x] Have you ensured that format looks appropriate for the output in
which it is rendered by building and verifying the site-book? If not then run
the following commands and the verify changes via
`site-book/target/site/index.html`:
```
cd site-book
mvn site
```
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/nickwallen/metron METRON-1050
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/656.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #656
----
commit d5d85bdda82dd2b0d4e39d9635a65697098afd31
Author: Nick Allen <[email protected]>
Date: 2017-07-18T14:57:40Z
METRON-1050 Improve Docs of 'profile.period.duration'
----
> 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)
