You can integrate Heron with Scribe to monitor and gather runtime metrics exported by Heron topologies.

Exporting topology metrics from Heron to Scribe

Heron supports custom metric exporters from the Metrics Manager. You can either build your own Scribe metrics sink or use the provided Scribe sink.

To set up your Heron cluster to export to Scribe, you need to make two changes to the metrics_sinks.yaml configuration file:

  • Add scribe-sink to the sinks list
  • Add a scribe-sink map to the file that sets values for the parameters listed below. You can uncomment the existing prometheus-sink map to get the default configuration.

Scribe parameters

Parameter Description Default
class The Java class used to control Prometheus sink behavior com.twitter.heron.metricsmgr.sink.ScribeSink
flush-frequency-ms How frequently, in milliseconds, the flush() method is called 60000 (one minute)
sink-restart-attempts How many times Heron should attempt to publish metrics to Scribe before no longer attempting -1 (forever)
scribe-host The Scribe host to export metrics to
scribe-port The Scribe port to export metrics to 1463
scribe-category The Scribe category to export metrics to scribe-category
service-namespace The service name for the category in scribe-category heron
scribe-timeout-ms The timeout, in millisconds, when attempting to export metrics to Scribe 200
scribe-connect-server-attempts The maximum number of retry attempts when connecting to Scribe on the configured host and port 2
scribe-retry-attempts The maximum number of retry attempts when writing metrics to Scribe 5
scribe-retry-interval-ms The time interval, in milliseconds, at which Heron attempts to write metrics to Scribe 100