Project: Apache Heron (App Definition and Development / Streaming & Messaging)
File: observability-graphite.md

id: version-0.20.0-incubating-observability-graphite title: Observability with Graphite sidebar_label: Graphite original_id: observability-graphite <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> To observe Heron's runtime metrics, you can integrate Heron and the Heron UI with and . To accomplish this, you need to do the following: Export topology metrics from Heron Gather Aurora and Linux metrics with Diamond Set up a scripted dashboard with Grafana Configure the Heron UI to link to Grafana Heron supports custom metric exporters from the Metrics Manager. You can either build your own Graphite metrics sink or use the . In addition to the topology-specific data available from Heron, much more data is available directly from Aurora and the Linux kernel. These can help identify many operational problems, such as CPU throttling or crashes. A common way to collect data from these sources is via a system metrics collection daemon such as or Diamond has the following relevant collectors available: A convienent way to view topology-specific metrics in Graphite is to create a . The scripted dashboard should accept information such as the topology name as query arguments, which will allow the Heron UI to deep link to a specific topology's dashboard. Suggested targets for the scripted dashboard include: Component Backpressure: ```python 'aliasByNode(sortByMaxima(highestAverage(heron.' + topology_name + '.stmgr.stmgr-*. timespentbackpressureby_compid.*, 5)), 5)' ``` Fail Count by Component: ```python 'sumSeriesWithWildcards(aliasByNode(heron.' + topology_name + '...fail-count.default,2),3)'` ``` CPU Throttling periods: ```python aliasByNode(nonNegativeDerivative(mesos.tasks.prod..' + topology_name + '..cpu. nr_throttled), 4,5) ``` JVM Deaths: ```python 'aliasByNode(drawAsInfinite(maximumAbove(removeAboveValue(heron.' + topology_name + '...jvm. uptime-secs, 60),1)),2,3)' ``` Top 5 worst GC components: ```python 'aliasByNode(highestMax(nonNegativeDerivative(heron.' + topology_name + '...jvm.gc-time-ms. PS-*),5), 2,3,6)' ``` Finally, you can configure the Heron UI to deep link to scripted dashboards by specifying an [observability URL format] (https://github.com/apache/incubator-heron/blob/master/heron/tools/config/src/yaml/tracker/heron_tracker.yaml) (`viz.url.format`) in the Heron Tracker's configuration. This will add topology-specific buttons to the Heron UI enabling you to drill-down into your Grafana dashboards.