Also available as:
loading table of contents...

Configuring the Profiler

A profile describes the behavior of an entity on a network. This feature is typically used by a data scientist and you should coordinate with the data scientist determine if they will need your assistance with customizing the Profiler values.

The Profiler is installed in the HCP install and runs as an independent Storm topology. The configuration for the Profiler topology is stored in ZooKeeper at /metron/topology/profiler. These properties also exist in the default installation of HCP at $METRON_HOME/config/zookeeper/profiler.json. The values can be changed on disk and then uploaded to ZooKeeper using $METRON_HOME/bin/

For more information on creating a profile, see Creating Profiles.


The Profiler can persist any serializable object, not just numeric values.

Table 3.2. Profiler Properties

profiler.workersThe number of worker processes to create for the topology.
profiler.executorsThe number of executors to spawn per component.
profiler.input.topicThe name of the Kafka topic from which to consume data.
profiler.output.topicThe name of the Kafka topic to which profile data is written. Only used with profiles that use the [`triage` result field](#result).
profiler.period.durationThe duration of each profile period. This value should be define along with profiler.period.duration.units.
profiler.period.duration.unitsThe units used to specify the profile period duration. This value should be defined along with profiler.period.duration.
profiler.ttlIf a message has not been applied to a Profile in this period of time, the Profile will be forgotten and its resources will be cleaned up. This value should be defined along with `profiler.ttl.units`.
profiler.ttl.unitsThe units used to specify the `profiler.ttl`
profiler.hbase.salt.divisorA salt is prepended to the row key to help prevent hotspotting. This constant is used to generate the sale. Ideally, this constant should be roughly equal to the number of nodes in the HBase cluster.
profiler.hbase.tableThe name of the HBase table that profiles are written to.
profiler.hbase.column.familyThe column family used to store profiles.
profiler.hbase.batchThe number of puts that are written in a single batch.
profiler.hbase.flush.interval.secondsThe maximum number of seconds between batch writes to HBase.