aboutsummaryrefslogtreecommitdiff
path: root/docs/monitoring.md
diff options
context:
space:
mode:
authorPatrick Wendell <pwendell@gmail.com>2013-09-08 10:47:45 -0700
committerPatrick Wendell <pwendell@gmail.com>2013-09-08 13:46:28 -0700
commitc190b48bf5073b3349b5060c324c890d95bc4260 (patch)
tree3d0a16a75827ad0b449bd3a7b9479ab5ef9e788e /docs/monitoring.md
parent8de8ee5d3cf01fd225336064d9586380a4fb6ad4 (diff)
downloadspark-c190b48bf5073b3349b5060c324c890d95bc4260.tar.gz
spark-c190b48bf5073b3349b5060c324c890d95bc4260.tar.bz2
spark-c190b48bf5073b3349b5060c324c890d95bc4260.zip
Adding more docs and some code cleanup
Diffstat (limited to 'docs/monitoring.md')
-rw-r--r--docs/monitoring.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/monitoring.md b/docs/monitoring.md
index 0ec987107c..4c4f174503 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -31,6 +31,15 @@ set of sinks to which metrics are reported. The following instances are currentl
* `executor`: A Spark executor.
* `driver`: The Spark driver process (the process in which your SparkContext is created).
+Each instance can report to zero or more _sinks_. Sinks are contained in the
+`org.apache.spark.metrics.sink` package:
+
+* `ConsoleSink`: Logs metrics information to the console.
+* `CSVSink`: Exports metrics data to CSV files at regular intervals.
+* `GangliaSink`: Sends metrics to a Ganglia node or multicast group.
+* `JmxSink`: Registers metrics for viewing in a JXM console.
+* `MetricsServlet`: Adds a servlet within the existing Spark UI to serve metrics data as JSON data.
+
The syntax of the metrics configuration file is defined in an example configuration file,
`$SPARK_HOME/conf/metrics.conf.template`.