[
https://issues.apache.org/jira/browse/METRON-529?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15626336#comment-15626336
]
ASF GitHub Bot commented on METRON-529:
---------------------------------------
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/334#discussion_r85986521
--- Diff: metron-analytics/metron-profiler-client/README.md ---
@@ -41,13 +41,20 @@ Retrieve all values of 'snort-alerts' from '10.0.0.1'
that occurred on 'weekdays
PROFILE_GET('snort-alerts', '10.0.0.1', 1, 'MONTHS', 'weekdays')
```
-### Period Duration
+### Configuration
-*WARNING*
+By default, the Profiler creates Profiles with a period duration of 15
minutes. This means that data is accumulated, summarized and flushed every 15
minutes. The Client API must also have knowledge of this duration to correctly
retrieve the profile data. If the client API is expecting 15 minute periods, it
will not be able to read data generated by a Profiler that has been configured
with a 1 hour period.
-By default, the Profiler creates Profiles with a period duration of 15
minutes. This means that data is accumulated, summarized and flushed every 15
minutes. The Client API must also have knowledge of this duration to correctly
retrieve the profile data. If the client API is expected 15 minute periods, it
will not be able to read data generated by a Profiler that has been configured
with a 1 hour period.
+The period duration can be configured in the Profiler by altering the
Profiler topology's static properties file. The Stellar Client API can be
configured by setting the following properties in Metron's global configuration.
-The period duration can be configured in the Profiler by altering the
Profiler topology's static properties file. The Stellar Client API currently
provides no means to configure the period duration and defaults also to 15
minutes. This means that the Stellar Client API can only read profiles with a
period duration of 15 minutes. This is a known limitation that has not yet
been addressed.
+| Key | Description
| Required | Default |
+| ------------------------------------- |
----------------------------------------------------------------------------------------------------------------------------------
| -------- | -------- |
+| profiler.client.hbase.table | The name of the HBase table used
to store profile data.
| Optional | profiler |
+| profiler.client.column.family | The name of the HBase column
family used to store profile data.
| Optional | P |
+| profiler.client.hbase.table.provider | The name of the
HBaseTableProvider implementation class.
| Optional | |
+| profiler.client.period.duration | The duration of each profile
period. This value should be defined along with
`profiler.client.period.duration.units`. | Optional | 15 |
+| profiler.client.period.duration.units | The units used to specify the
profile period duration. This value should be defined along with
`profiler.client.period.duration`. | Optional | MINUTES |
--- End diff --
Profiler topology only specifies window duration in seconds. Since this
has to be the same, suggest just using seconds, and not allowing units.
> Allow Configurable Periods for Profiler Client
> ----------------------------------------------
>
> Key: METRON-529
> URL: https://issues.apache.org/jira/browse/METRON-529
> Project: Metron
> Issue Type: Improvement
> Reporter: Nick Allen
> Assignee: Nick Allen
>
> By default, the Profiler creates Profiles with a period duration of 15
> minutes. This means that data is accumulated, summarized and flushed every 15
> minutes. The Client API must also have knowledge of this duration to
> correctly retrieve the profile data. If the client API is expecting 15 minute
> periods, it will not be able to read data generated by a Profiler that has
> been configured with a 1 hour period.
> The period duration can be configured in the Profiler by altering the
> Profiler topology's static properties file. The Stellar Client API currently
> provides no means to configure the period duration and defaults also to 15
> minutes. This means that the Stellar Client API can only read profiles with a
> period duration of 15 minutes. This is a known limitation that has not yet
> been addressed.
> https://github.com/apache/incubator-metron/blob/e31705029fd7518bd03c22eece0c2a8eb1187abf/metron-analytics/metron-profiler-client/README.md#period-duration
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
