Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/metron/pull/656#discussion_r129231691
--- Diff: metron-analytics/metron-profiler/README.md ---
@@ -275,27 +280,105 @@ The Profiler runs as an independent Storm topology.
The configuration for the P
The values can be changed on disk and then the Profiler topology must be
restarted.
-| Setting | Description
-|--- |---
-| profiler.workers | The number of worker processes
to create for the topology.
-| profiler.executors | The number of executors to spawn
per component.
-| profiler.input.topic | The name of the Kafka topic from
which to consume data.
-| profiler.output.topic | The name of the Kafka topic to
which profile data is written. Only used with profiles that use the [`triage`
result field](#result).
-| profiler.period.duration | The duration of each profile
period. This value should be defined along with
`profiler.period.duration.units`.
-| profiler.period.duration.units | The units used to specify the
`profiler.period.duration`.
-| profiler.ttl | If 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.units | The units used to specify the
`profiler.ttl`.
-| profiler.hbase.salt.divisor | A salt is prepended to the row
key to help prevent hotspotting. This constant is used to generate the salt.
Ideally, this constant should be roughly equal to the number of nodes in the
Hbase cluster.
-| profiler.hbase.table | The name of the HBase table that
profiles are written to.
-| profiler.hbase.column.family | The column family used to store
profiles.
-| profiler.hbase.batch | The number of puts that are
written in a single batch.
-| profiler.hbase.flush.interval.seconds | The maximum number of seconds
between batch writes to HBase.
-
-After altering the configuration, start the Profiler.
+| Setting
| Description
+|---
|---
+| [`profiler.input.topic`](#profilerinputtopic)
| The name of the Kafka topic from which to consume data.
+| [`profiler.output.topic`](#profileroutputtopic)
| The name of the Kafka topic to which profile data is written. Only used
with profiles that define the [`triage` result field](#result).
+| [`profiler.period.duration`](#profilerperiodduration)
| The duration of each profile period.
+| [`profiler.period.duration.units`](#profilerperioddurationunits)
| The units used to specify the
[`profiler.period.duration`](#profilerperiodduration).
+| [`profiler.workers`](#profilerworkers)
| The number of worker processes for the topology.
+| [`profiler.executors`](#profilerexecutors)
| The number of executors to spawn per component.
+| [`profiler.ttl`](#profilerttl)
| If 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.
+| [`profiler.ttl.units`](#profilerttlunits)
| The units used to specify the `profiler.ttl`.
+| [`profiler.hbase.salt.divisor`](#profilerhbasesaltdivisor)
| A salt is prepended to the row key to help prevent hotspotting.
+| [`profiler.hbase.table`](#profilerhbasetable)
| The name of the HBase table that profiles are written to.
+| [`profiler.hbase.column.family`](#profilerhbasecolumnfamily)
| The column family used to store profiles.
+| [`profiler.hbase.batch`](#profilerhbasebatch)
| The number of puts that are written to HBase in a single batch.
+|
[`profiler.hbase.flush.interval.seconds`](#profilerhbaseflushintervalseconds) |
The maximum number of seconds between batch writes to HBase.
-```
-$ $METRON_HOME/start_profiler_topology.sh
-```
+### `profiler.input.topic`
+
+*Default*: indexing
+
+The name of the Kafka topic from which to consume data. By default, the
Profiler consumes data from the `indexing` topic so that it has access to fully
enriched telemetry.
+
+### `profiler.output.topic`
+
+*Default*: enrichments
+
+The name of the Kafka topic to which profile data is written. This
property is only applicable to profiles that define the [`triage` result
field](#result). This allows Profile data to be selectively triaged like any
other source of telemetry in Metron.
--- End diff --
Suggest: link text should be: \[\`result\` \`triage\` field\], resulting in
[`result` `triage` field](#result)
---
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.
---
