[METRON-1050] Improve Docs of `profiler.period.duration`

• Type: Bug
• Status: Done
• Priority: Major
• Resolution: Done
• Affects Version/s: 0.4.0
• Fix Version/s: 0.4.1
• Assignee: Nick Allen
• Reporter: Nick Allen
• Created: 18/Jul/17 14:56
• Updated: 16/Aug/17 21:57
• Resolved: 16/Aug/17 21:57

Description

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.

Issue Links

• links to: GitHub Pull Request #656