Merge pull request apache#11013: Add metrics export to documentation …

…on the website.
jto · Mar 3, 2020 · b853016 · b853016
2 parents dba6aa7 + 6da25ef
commit b853016
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/website/src/_includes/section-menu/documentation.html b/website/src/_includes/section-menu/documentation.html
@@ -119,6 +119,7 @@
         <li><a href="{{ site.baseurl }}/documentation/programming-guide/#types-of-metrics">Types of metrics</a></li>
         <li><a href="{{ site.baseurl }}/documentation/programming-guide/#querying-metrics">Querying metrics</a></li>
         <li><a href="{{ site.baseurl }}/documentation/programming-guide/#using-metrics">Using metrics in pipeline</a></li>
+        <li><a href="{{ site.baseurl }}/documentation/programming-guide/#export-metrics">Export metrics</a></li>
       </ul>
     </li>
     <li class="section-nav-item--collapsible">

diff --git a/website/src/documentation/programming-guide.md b/website/src/documentation/programming-guide.md
@@ -3121,6 +3121,15 @@ public class MyMetricsDoFn extends DoFn<Integer, Integer> {
   }
 }
 ```  
+### 9.5 Export metrics {#export-metrics}
+Beam metrics can be exported to external sinks. If a metrics sink is set up in the configuration, the runner will push metrics to it at a default 5s period. 
+The configuration is held in the [MetricsOptions](https://beam.apache.org/releases/javadoc/2.19.0/org/apache/beam/sdk/metrics/MetricsOptions.html) class.
+It contains push period configuration and also sink specific options such as type and URL. As for now only the REST HTTP and the Graphite sinks are supported and only
+Flink and Spark runners support metrics export.
+
+Also Beam metrics are exported to inner Spark and Flink dashboards to be consulted in their respective UI.
+
+
 
 ## 10. State and Timers {#state-and-timers}
 Beam's windowing and triggering facilities provide a powerful abstraction for grouping and aggregating unbounded input