aboutsummaryrefslogtreecommitdiff
path: root/docs/monitoring.md
diff options
context:
space:
mode:
authorPatrick Wendell <pwendell@gmail.com>2014-03-11 11:16:59 -0700
committerPatrick Wendell <pwendell@gmail.com>2014-03-11 11:16:59 -0700
commit16788a654246067fd966033b5dc9bc0d4c759b70 (patch)
tree5df5783341fa51fc538f67364eb62f8d2603cc97 /docs/monitoring.md
parent2a2c9645e4ea08cd1408151a33d2d52f6752404a (diff)
downloadspark-16788a654246067fd966033b5dc9bc0d4c759b70.tar.gz
spark-16788a654246067fd966033b5dc9bc0d4c759b70.tar.bz2
spark-16788a654246067fd966033b5dc9bc0d4c759b70.zip
SPARK-1167: Remove metrics-ganglia from default build due to LGPL issues...
This patch removes Ganglia integration from the default build. It allows users willing to link against LGPL code to use Ganglia by adding build flags or linking against a new Spark artifact called spark-ganglia-lgpl. This brings Spark in line with the Apache policy on LGPL code enumerated here: https://www.apache.org/legal/3party.html#options-optional Author: Patrick Wendell <pwendell@gmail.com> Closes #108 from pwendell/ganglia and squashes the following commits: 326712a [Patrick Wendell] Responding to review feedback 5f28ee4 [Patrick Wendell] SPARK-1167: Remove metrics-ganglia from default build due to LGPL issues.
Diffstat (limited to 'docs/monitoring.md')
-rw-r--r--docs/monitoring.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/monitoring.md b/docs/monitoring.md
index e9b1d2b2f4..15bfb04178 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -48,11 +48,22 @@ Each instance can report to zero or more _sinks_. Sinks are contained in the
* `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.
* `GraphiteSink`: Sends metrics to a Graphite node.
+Spark also supports a Ganglia sink which is not included in the default build due to
+licensing restrictions:
+
+* `GangliaSink`: Sends metrics to a Ganglia node or multicast group.
+
+To install the `GangliaSink` you'll need to perform a custom build of Spark. _**Note that
+by embedding this library you will include [LGPL](http://www.gnu.org/copyleft/lesser.html)-licensed
+code in your Spark package**_. For sbt users, set the
+`SPARK_GANGLIA_LGPL` environment variable before building. For Maven users, enable
+the `-Pspark-ganglia-lgpl` profile. In addition to modifying the cluster's Spark build
+user applications will need to link to the `spark-ganglia-lgpl` artifact.
+
The syntax of the metrics configuration file is defined in an example configuration file,
`$SPARK_HOME/conf/metrics.properties.template`.