id: version-0.20.0-observability-scribe title: Observability with Scribe sidebar_label: Scribe original_id: observability-scribe

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

classThe Java class used to control Prometheus sink behaviororg.apache.heron.metricsmgr.sink.ScribeSink
flush-frequency-msHow frequently, in milliseconds, the flush() method is called60000 (one minute)
sink-restart-attemptsHow many times Heron should attempt to publish metrics to Scribe before no longer attempting-1 (forever)
scribe-hostThe Scribe host to export metrics to127.0.0.1
scribe-portThe Scribe port to export metrics to1463
scribe-categoryThe Scribe category to export metrics toscribe-category
service-namespaceThe service name for the category in scribe-categoryheron
scribe-timeout-msThe timeout, in millisconds, when attempting to export metrics to Scribe200
scribe-connect-server-attemptsThe maximum number of retry attempts when connecting to Scribe on the configured host and port2
scribe-retry-attemptsThe maximum number of retry attempts when writing metrics to Scribe5
scribe-retry-interval-msThe time interval, in milliseconds, at which Heron attempts to write metrics to Scribe100