Github user cestella commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/230#discussion_r76412714
--- Diff:
metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/profiler/ProfileConfig.java
---
@@ -27,36 +29,57 @@
public class ProfileConfig implements Serializable {
/**
- * The name of the profile.
+ * A unique name identifying the profile. The field is treated as a
string.
*/
private String profile;
/**
- * Stella code that when executed results in the name of the entity
being profiled. A
- * profile is created 'for-each' of these; hence the name.
+ * A separate profile is maintained for each of these. This is
effectively the
+ * entity that the profile is describing. The field is expected to
contain a
+ * Stellar expression whose result is the entity name. For example, if
`ip_src_addr`
+ * then a separate profile would be maintained for each unique IP source
address in
+ * the data; 10.0.0.1, 10.0.0.2, etc.
*/
private String foreach;
/**
- * Stella code that when executed determines whether a message should be
included in this
- * profile.
+ * An expression that determines if a message should be applied to the
profile. A
+ * Stellar expression is expected that when executed returns a boolean.
A message
+ * is only applied to a profile if this condition is true. This allows a
profile
+ * to filter the messages that it receives.
*/
private String onlyif;
/**
- * Stella code that when executed results in a single measurement that
is stored with the Profile.
+ * A set of expressions that is executed at the start of a window
period. A map is
+ * expected where the key is the variable name and the value is a
Stellar expression.
+ * The map can contain 0 or more variables/expressions. At the start of
each window
+ * period the expression is executed once and stored in a variable with
the given
+ * name.
*/
- private String result;
+ private Map<String, String> init = new HashMap<>();
/**
- * Defines how the state is initialized before any messages are received.
+ * A set of expressions that is executed when a message is applied to
the profile.
+ * A map is expected where the key is the variable name and the value is
a Stellar
+ * expression. The map can include 0 or more variables/expressions.
*/
- private Map<String, String> init = new HashMap<>();
+ private Map<String, String> update = new HashMap<>();
/**
- * Defines how the state is updated when a new message is received.
+ * A list of Stellar expressions that is executed in order and used to
group the
+ * resulting profile data.
+ * TODO
--- End diff --
What is the TODO there for?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
