[
https://issues.apache.org/jira/browse/METRON-590?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16405296#comment-16405296
]
ASF GitHub Bot commented on METRON-590:
---------------------------------------
Github user cestella commented on a diff in the pull request:
https://github.com/apache/metron/pull/965#discussion_r175553846
--- Diff: metron-analytics/metron-profiler/README.md ---
@@ -328,6 +328,62 @@ Continuing the previous running example, at this
point, you have seen how your p
## Anatomy of a Profile
+### Profiler
+
+The Profiler configuration contains only two fields; only one of which is
required.
+
+```
+{
+ "profiles": [
+ { "profile": "one", ... },
+ { "profile": "two", ... }
+ ],
+ "timestampField": "timestamp"
+}
+```
+
+| Name | | Description
+|--- |--- |---
+| [profiles](#profiles) | Required | A list of zero or
more Profile definitions.
+| [timestampField](#timestampfield) | Optional | Indicates whether
processing time or event time should be used.
--- End diff --
Can we indicate the default here in the description (for quicker reference)?
> Enable Use of Event Time in Profiler
> ------------------------------------
>
> Key: METRON-590
> URL: https://issues.apache.org/jira/browse/METRON-590
> Project: Metron
> Issue Type: Improvement
> Reporter: Nick Allen
> Assignee: Nick Allen
> Priority: Major
>
> There are at least two different times that are important to consider when
> handling the telemetry messages received by Metron.
> (1) Processing time is the time at which Metron processed the message.
> (2) Event time is the time at which the event actually occurred.
> If Metron is consuming live data and all is well, the processing and event
> times may remain close and consistent. When processing time differs from
> event time the data produced by the Profiler may be inaccurate. There are a
> few scenarios under which these times might differ greatly which would
> negatively impact the feature set produced by the Profiler.
> (1) When the system has experienced an outage, for example, a scheduled
> maintenance window. When restarted a high volume of messages will need to be
> processed by the Profiler. The output of the Profiler will indicate an
> increase in activity, although no change in activity actually occurred on the
> target network. This could happen whether the outage was Metron itself or an
> upstream system that feeds data to Metron.
> (2) If the user attempts to replay historical telemetry through the Profiler,
> the Profiler will attribute the activity to the time period in which it was
> processed. Obviously the activity should be attributed to the time period in
> which the raw telemetry events originated in.
> There are some scenarios when processing time might be preferred and other
> use cases where event time is preferred. The Profiler should be enhanced to
> allow it to produce profiles based on either processing time or event time.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
