Metrics

Manages recording of metrics in an application. Metrics collection is turned on for a particular thread by calling the initialize method. After initialize is called the Metrics.Recorder field is set, and the application can use that to record metrics. To print metrics, call the print method, and to stop recording metrics for a particular thread, call the stopRecording method.

If an application does not want to record metrics, it can simply avoid calling the initialize method (or can call the stopRecording method if there is a chance that initialize has been called on that thread previously). Attempting to record metrics when the initialize method has not been called will not produce an error, and incurs very little overhead. However, attempting to call the print method to print the metrics will produce an error.

Annotations: @deprecated
Deprecated: to be removed in version 0.3.0

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final val Recorder: DynamicVariable[Option[MetricsRecorder]]

Dynamic variable (thread-local) which allows metrics to be recorded for the current thread.
Dynamic variable (thread-local) which allows metrics to be recorded for the current thread. Note that this will be set to None if metrics have not been initialized for the current thread, so callers should deal with this appropriately (normally by avoiding recording any metrics or propagating the recorder to other threads).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def generateNewSequenceId(): Int

Generates a new sequence ID for operations that we wish to appear in sequence
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def initialize(sparkContext: SparkContext): Unit

Starts recording metrics for this thread.
Starts recording metrics for this thread. Any previously-recorded metrics for this thread will be cleared. This method must always be called before recording metrics.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isRecording: Boolean

Returns true if metrics are being recorded for the current thread, or false otherwise
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def print(out: PrintWriter, sparkStageTimings: Option[Seq[StageTiming]]): Unit

Prints the metrics recorded by this instance to the specified PrintWriter, using the specified SparkMetrics to print details of any Spark operations that have occurred.
def stopRecording(): Unit

Stops recording metrics for the current thread.
Stops recording metrics for the current thread. This avoids the (slight) overhead of recording metrics if they are not going to be used. Calling the print method after calling this one will result in an IllegalStateException.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Metrics → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class Metrics | package instrumentation

object Metrics extends Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final val Recorder: DynamicVariable[Option[MetricsRecorder]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def generateNewSequenceId(): Int

final def getClass(): Class[_]

def hashCode(): Int

def initialize(sparkContext: SparkContext): Unit

final def isInstanceOf[T0]: Boolean

def isRecording: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def print(out: PrintWriter, sparkStageTimings: Option[Seq[StageTiming]]): Unit

def stopRecording(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped