2015-09-22 06:03:21 -04:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
#
|
|
|
|
|
2013-07-30 01:09:22 -04:00
|
|
|
# syntax: [instance].sink|source.[name].[options]=[value]
|
2013-07-03 08:31:53 -04:00
|
|
|
|
2013-07-30 01:09:22 -04:00
|
|
|
# This file configures Spark's internal metrics system. The metrics system is
|
|
|
|
# divided into instances which correspond to internal components.
|
|
|
|
# Each instance can be configured to report its metrics to one or more sinks.
|
2013-08-06 04:19:37 -04:00
|
|
|
# Accepted values for [instance] are "master", "worker", "executor", "driver",
|
2015-06-05 01:45:25 -04:00
|
|
|
# and "applications". A wildcard "*" can be used as an instance name, in
|
2013-07-30 01:09:22 -04:00
|
|
|
# which case all instances will inherit the supplied property.
|
2013-07-15 22:57:19 -04:00
|
|
|
#
|
2013-07-30 01:09:22 -04:00
|
|
|
# Within an instance, a "source" specifies a particular set of grouped metrics.
|
|
|
|
# there are two kinds of sources:
|
|
|
|
# 1. Spark internal sources, like MasterSource, WorkerSource, etc, which will
|
|
|
|
# collect a Spark component's internal state. Each instance is paired with a
|
|
|
|
# Spark source that is added automatically.
|
|
|
|
# 2. Common sources, like JvmSource, which will collect low level state.
|
|
|
|
# These can be added through configuration options and are then loaded
|
|
|
|
# using reflection.
|
2013-07-15 22:57:19 -04:00
|
|
|
#
|
2013-07-30 01:09:22 -04:00
|
|
|
# A "sink" specifies where metrics are delivered to. Each instance can be
|
|
|
|
# assigned one or more sinks.
|
2013-07-15 22:57:19 -04:00
|
|
|
#
|
2013-08-06 04:19:37 -04:00
|
|
|
# The sink|source field specifies whether the property relates to a sink or
|
2013-07-30 01:09:22 -04:00
|
|
|
# source.
|
2013-07-15 22:57:19 -04:00
|
|
|
#
|
2013-07-30 01:09:22 -04:00
|
|
|
# The [name] field specifies the name of source or sink.
|
2013-07-15 22:57:19 -04:00
|
|
|
#
|
2013-07-30 01:09:22 -04:00
|
|
|
# The [options] field is the specific property of this source or sink. The
|
|
|
|
# source or sink is responsible for parsing this property.
|
2013-07-15 22:57:19 -04:00
|
|
|
#
|
|
|
|
# Notes:
|
2013-08-06 04:19:37 -04:00
|
|
|
# 1. To add a new sink, set the "class" option to a fully qualified class
|
2013-07-30 01:09:22 -04:00
|
|
|
# name (see examples below).
|
|
|
|
# 2. Some sinks involve a polling period. The minimum allowed polling period
|
2013-09-08 13:47:45 -04:00
|
|
|
# is 1 second.
|
2015-06-05 01:45:25 -04:00
|
|
|
# 3. Wildcard properties can be overridden by more specific properties.
|
2013-08-06 04:19:37 -04:00
|
|
|
# For example, master.sink.console.period takes precedence over
|
2013-07-30 01:09:22 -04:00
|
|
|
# *.sink.console.period.
|
2013-07-15 22:57:19 -04:00
|
|
|
# 4. A metrics specific configuration
|
|
|
|
# "spark.metrics.conf=${SPARK_HOME}/conf/metrics.properties" should be
|
2013-07-30 01:09:22 -04:00
|
|
|
# added to Java properties using -Dspark.metrics.conf=xxx if you want to
|
|
|
|
# customize metrics system. You can also put the file in ${SPARK_HOME}/conf
|
|
|
|
# and it will be loaded automatically.
|
2016-01-27 04:27:11 -05:00
|
|
|
# 5. The MetricsServlet sink is added by default as a sink in the master,
|
|
|
|
# worker and driver, and you can send HTTP requests to the "/metrics/json"
|
|
|
|
# endpoint to get a snapshot of all the registered metrics in JSON format.
|
|
|
|
# For master, requests to the "/metrics/master/json" and
|
|
|
|
# "/metrics/applications/json" endpoints can be sent separately to get
|
|
|
|
# metrics snapshots of the master instance and applications. This
|
|
|
|
# MetricsServlet does not have to be configured.
|
2013-08-06 04:19:37 -04:00
|
|
|
|
2015-06-05 01:45:25 -04:00
|
|
|
## List of available common sources and their properties.
|
|
|
|
|
|
|
|
# org.apache.spark.metrics.source.JvmSource
|
2016-01-27 04:27:11 -05:00
|
|
|
# Note: Currently, JvmSource is the only available common source.
|
|
|
|
# It can be added to an instance by setting the "class" option to its
|
|
|
|
# fully qualified class name (see examples below).
|
2015-06-05 01:45:25 -04:00
|
|
|
|
2013-09-08 13:47:45 -04:00
|
|
|
## List of available sinks and their properties.
|
|
|
|
|
|
|
|
# org.apache.spark.metrics.sink.ConsoleSink
|
|
|
|
# Name: Default: Description:
|
|
|
|
# period 10 Poll period
|
2016-01-27 04:27:11 -05:00
|
|
|
# unit seconds Unit of the poll period
|
2013-09-08 13:47:45 -04:00
|
|
|
|
|
|
|
# org.apache.spark.metrics.sink.CSVSink
|
|
|
|
# Name: Default: Description:
|
|
|
|
# period 10 Poll period
|
2016-01-27 04:27:11 -05:00
|
|
|
# unit seconds Unit of the poll period
|
2013-09-08 13:47:45 -04:00
|
|
|
# directory /tmp Where to store CSV files
|
|
|
|
|
|
|
|
# org.apache.spark.metrics.sink.GangliaSink
|
|
|
|
# Name: Default: Description:
|
2016-01-27 04:27:11 -05:00
|
|
|
# host NONE Hostname or multicast group of the Ganglia server,
|
|
|
|
# must be set
|
|
|
|
# port NONE Port of the Ganglia server(s), must be set
|
2013-09-08 13:47:45 -04:00
|
|
|
# period 10 Poll period
|
2016-01-27 04:27:11 -05:00
|
|
|
# unit seconds Unit of the poll period
|
2013-09-08 13:47:45 -04:00
|
|
|
# ttl 1 TTL of messages sent by Ganglia
|
2014-02-14 13:01:01 -05:00
|
|
|
# mode multicast Ganglia network mode ('unicast' or 'multicast')
|
2013-09-08 13:47:45 -04:00
|
|
|
|
|
|
|
# org.apache.spark.metrics.sink.JmxSink
|
|
|
|
|
|
|
|
# org.apache.spark.metrics.sink.MetricsServlet
|
|
|
|
# Name: Default: Description:
|
|
|
|
# path VARIES* Path prefix from the web server root
|
2016-01-27 04:27:11 -05:00
|
|
|
# sample false Whether to show entire set of samples for histograms
|
|
|
|
# ('false' or 'true')
|
2013-09-08 13:47:45 -04:00
|
|
|
#
|
2016-01-27 04:27:11 -05:00
|
|
|
# * Default path is /metrics/json for all instances except the master. The
|
|
|
|
# master has two paths:
|
2014-12-19 16:56:04 -05:00
|
|
|
# /metrics/applications/json # App information
|
|
|
|
# /metrics/master/json # Master information
|
2013-09-08 13:47:45 -04:00
|
|
|
|
2013-11-08 19:36:03 -05:00
|
|
|
# org.apache.spark.metrics.sink.GraphiteSink
|
|
|
|
# Name: Default: Description:
|
2016-01-27 04:27:11 -05:00
|
|
|
# host NONE Hostname of the Graphite server, must be set
|
|
|
|
# port NONE Port of the Graphite server, must be set
|
2013-11-08 19:36:03 -05:00
|
|
|
# period 10 Poll period
|
2016-01-27 04:27:11 -05:00
|
|
|
# unit seconds Unit of the poll period
|
|
|
|
# prefix EMPTY STRING Prefix to prepend to every metric's name
|
2015-02-01 02:41:05 -05:00
|
|
|
# protocol tcp Protocol ("tcp" or "udp") to use
|
2013-11-08 19:36:03 -05:00
|
|
|
|
2013-09-08 13:47:45 -04:00
|
|
|
## Examples
|
2013-07-15 22:57:19 -04:00
|
|
|
# Enable JmxSink for all instances by class name
|
2013-09-08 19:06:32 -04:00
|
|
|
#*.sink.jmx.class=org.apache.spark.metrics.sink.JmxSink
|
2013-07-15 22:57:19 -04:00
|
|
|
|
|
|
|
# Enable ConsoleSink for all instances by class name
|
2013-09-08 19:06:32 -04:00
|
|
|
#*.sink.console.class=org.apache.spark.metrics.sink.ConsoleSink
|
2013-07-03 22:11:30 -04:00
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Polling period for the ConsoleSink
|
2013-07-03 08:31:53 -04:00
|
|
|
#*.sink.console.period=10
|
2016-01-27 04:27:11 -05:00
|
|
|
# Unit of the polling period for the ConsoleSink
|
2013-07-15 22:57:19 -04:00
|
|
|
#*.sink.console.unit=seconds
|
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Polling period for the ConsoleSink specific for the master instance
|
2013-07-15 22:57:19 -04:00
|
|
|
#master.sink.console.period=15
|
2016-01-27 04:27:11 -05:00
|
|
|
# Unit of the polling period for the ConsoleSink specific for the master
|
|
|
|
# instance
|
2013-07-15 22:57:19 -04:00
|
|
|
#master.sink.console.unit=seconds
|
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Enable CsvSink for all instances by class name
|
2013-09-08 19:06:32 -04:00
|
|
|
#*.sink.csv.class=org.apache.spark.metrics.sink.CsvSink
|
2013-07-15 22:57:19 -04:00
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Polling period for the CsvSink
|
2013-07-15 22:57:19 -04:00
|
|
|
#*.sink.csv.period=1
|
2016-01-27 04:27:11 -05:00
|
|
|
# Unit of the polling period for the CsvSink
|
2013-07-15 22:57:19 -04:00
|
|
|
#*.sink.csv.unit=minutes
|
|
|
|
|
|
|
|
# Polling directory for CsvSink
|
|
|
|
#*.sink.csv.directory=/tmp/
|
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Polling period for the CsvSink specific for the worker instance
|
2013-07-15 22:57:19 -04:00
|
|
|
#worker.sink.csv.period=10
|
2016-01-27 04:27:11 -05:00
|
|
|
# Unit of the polling period for the CsvSink specific for the worker instance
|
2013-07-15 22:57:19 -04:00
|
|
|
#worker.sink.csv.unit=minutes
|
2013-07-03 08:31:53 -04:00
|
|
|
|
2015-02-24 15:50:16 -05:00
|
|
|
# Enable Slf4jSink for all instances by class name
|
|
|
|
#*.sink.slf4j.class=org.apache.spark.metrics.sink.Slf4jSink
|
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Polling period for the Slf4JSink
|
2015-05-24 16:48:27 -04:00
|
|
|
#*.sink.slf4j.period=1
|
2016-01-27 04:27:11 -05:00
|
|
|
# Unit of the polling period for the Slf4jSink
|
2015-05-24 16:48:27 -04:00
|
|
|
#*.sink.slf4j.unit=minutes
|
2015-02-24 15:50:16 -05:00
|
|
|
|
2016-01-27 04:27:11 -05:00
|
|
|
# Enable JvmSource for instance master, worker, driver and executor
|
2013-09-08 19:06:32 -04:00
|
|
|
#master.source.jvm.class=org.apache.spark.metrics.source.JvmSource
|
2013-07-03 08:31:53 -04:00
|
|
|
|
2013-09-08 19:06:32 -04:00
|
|
|
#worker.source.jvm.class=org.apache.spark.metrics.source.JvmSource
|
2013-07-03 08:31:53 -04:00
|
|
|
|
2013-09-08 19:06:32 -04:00
|
|
|
#driver.source.jvm.class=org.apache.spark.metrics.source.JvmSource
|
2013-07-03 08:31:53 -04:00
|
|
|
|
2013-09-08 19:06:32 -04:00
|
|
|
#executor.source.jvm.class=org.apache.spark.metrics.source.JvmSource
|