SPOI-6710 Initial pass at troubleshooting guide
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/commit/2136a3a9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/2136a3a9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/2136a3a9 Branch: refs/heads/master Commit: 2136a3a97bfdc804e8df22156936074629c965c3 Parents: aa04479 Author: sashadt <[email protected]> Authored: Thu Nov 5 19:38:22 2015 -0800 Committer: Thomas Weise <[email protected]> Committed: Sun Feb 28 22:46:38 2016 -0800 ---------------------------------------------------------------------- autometrics.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/2136a3a9/autometrics.md ---------------------------------------------------------------------- diff --git a/autometrics.md b/autometrics.md index ef6d957..f6000e8 100644 --- a/autometrics.md +++ b/autometrics.md @@ -1,8 +1,8 @@ -Apache Apex AutoMetric API -========================== +Apache Apex AutoMetrics +======================= # Introduction -Metrics help to collect some statistical information about a process which can be very useful for diagnosis. Auto Metrics in Apex can help monitor operators in a running application. The goal of *AutoMetric* API is to enable operator developer to define relevant metrics for an operator in a simple way which the platform collects and reports automatically. +Metrics collect various statistical information about a process which can be very useful for diagnosis. Auto Metrics in Apex can help monitor operators in a running application. The goal of *AutoMetric* API is to enable operator developer to define relevant metrics for an operator in a simple way which the platform collects and reports automatically. # Specifying AutoMetrics in an Operator An *AutoMetric* can be any object. It can be of a primitive type - int, long, etc. or a complex one. A field or a `get` method in an operator can be annotated with `@AutoMetric` to specify that its value is a metric. After every application end window, the platform collects the values of these fields/methods in a map and sends it to application master.
