ExecutorInstrumentation

Type Members

trait ForkJoinPoolTelemetryReader extends AnyRef

Abstracts the means of reading some telemetry information from concrete executor implementations.
Abstracts the means of reading some telemetry information from concrete executor implementations. This allows us to track the same metrics even when coming from slightly different implementations. The three cases we have seen so far where this is useful are when instrumenting: the ForkJoinPool included in the JDK (since Java 8), the one included in Scala 2.11 Library and the one shipped with Akka.
class InstrumentedExecutionContext extends ExecutionContext

Wraps an Execution Context and its underlying ExecutorService, if known.
Wraps an Execution Context and its underlying ExecutorService, if known. The only purpose of wrapping is to to provide a shutdown method that can be used to clear shutdown the underlying ExecutorService and remove all the metrics related to it.
class InstrumentedForkJoinPool extends ExecutorService

Executor service wrapper for ForkJoin Pool executors that keeps track of submitted and completed tasks and optionally tracks the time tasks spend waiting on the underlying executor service's queue.
Executor service wrapper for ForkJoin Pool executors that keeps track of submitted and completed tasks and optionally tracks the time tasks spend waiting on the underlying executor service's queue. This instrumented executor does some extra counting work (compared to the InstrumentedThreadPool class) because ForkJoin Pool executors do not provide submitted and completed task counters.
The instruments used to track the pool's behavior are removed once the pool is shut down.
class InstrumentedScheduledThreadPoolExecutor extends InstrumentedThreadPool with ScheduledExecutorService

Executor service wrapper for ScheduledThreadPool executors that keeps track of submitted and completed tasks.
Executor service wrapper for ScheduledThreadPool executors that keeps track of submitted and completed tasks. Since tasks submitted to this type of executor are expected to be delayed for some time we are not explicitly tracking the time-in-queue metric, nor allowing to perform context propagation (at least manually).
The instruments used to track the pool's behavior are removed once the pool is shut down.
class InstrumentedThreadPool extends ExecutorService

Executor service wrapper for ThreadPool executors that keeps track of submitted and completed tasks and optionally tracks the time tasks spend waiting on the underlying executor service's queue.
Executor service wrapper for ThreadPool executors that keeps track of submitted and completed tasks and optionally tracks the time tasks spend waiting on the underlying executor service's queue.
The instruments used to track the pool's behavior are removed once the pool is shut down.
class Settings extends AnyRef

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
val DefaultSettings: Settings

We do not perform context propagation on submit by default because the automatic instrumentation provided by this module should ensure that all interesting Runnable/Callable implementations capture a Context instance.
We do not perform context propagation on submit by default because the automatic instrumentation provided by this module should ensure that all interesting Runnable/Callable implementations capture a Context instance. Furthermore, in many situations the current Context when a Runnable/Callable is created is different from the current context when it is submitted for execution and in most situations it is safer to assume that all Runnable/Callable should capture the current Context at the instant when they are created, not when submitted.
object ForkJoinPoolTelemetryReader
val NoExtraSettings: Settings

Settings that do not enable any extra features on the instrumented executor service.
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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def instrument(executor: ExecutorService, telemetryReader: ForkJoinPoolTelemetryReader, name: String, extraTags: TagSet, settings: Settings): ExecutorService

Creates a new instrumented ExecutorService that wraps the provided one, assuming that the wrapped executor is a form of ForkJoinPool implementation.
Creates a new instrumented ExecutorService that wraps the provided one, assuming that the wrapped executor is a form of ForkJoinPool implementation. The instrumented executor will track all the common pool metrics and optionally, track the time spent by each task on the wrapped executor's queue.
All metrics related to the instrumented service will have the following tags: * all of the provided extraTags (take into account that any "name" or "type" tags will be overwritten. * name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrument(executor: ExecutorService, name: String, extraTags: TagSet, settings: Settings): ExecutorService

Creates a new instrumented ExecutorService that wraps the provided one.
Creates a new instrumented ExecutorService that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala) and optionally, track the time spent by each task on the wrapped executor's queue.
All metrics related to the instrumented service will have the following tags: * all of the provided extraTags (take into account that any "name" or "type" tags will be overwritten. * name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrument(executor: ExecutorService, name: String, extraTags: TagSet): ExecutorService

Creates a new instrumented ExecutorService that wraps the provided one.
Creates a new instrumented ExecutorService that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala). All metrics related to the instrumented service will have the following tags:
* all of the provided extraTags (take into account that any "name" or "type" tags will be overwritten. * name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrument(executor: ExecutorService, name: String, settings: Settings): ExecutorService

Creates a new instrumented ExecutorService that wraps the provided one.
Creates a new instrumented ExecutorService that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala) and optionally, track the time spent by each task on the wrapped executor's queue.
All metrics related to the instrumented service will have the following tags:
* name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrument(executor: ExecutorService, name: String): ExecutorService

Creates a new instrumented ExecutorService that wraps the provided one.
Creates a new instrumented ExecutorService that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala). All metrics related to the instrumented service will have the following tags:
* name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrumentExecutionContext(executionContext: ExecutionContext, name: String, extraTags: TagSet, settings: Settings): InstrumentedExecutionContext

Creates a new instrumented ExecutionContext that wraps the provided one.
Creates a new instrumented ExecutionContext that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala) and optionally, track the time spent by each task on the wrapped executor's queue.
All metrics related to the instrumented service will have the following tags: * all of the provided extraTags (take into account that any "name" or "type" tags will be overwritten. * name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrumentExecutionContext(executionContext: ExecutionContext, name: String, extraTags: TagSet): InstrumentedExecutionContext

Creates a new instrumented ExecutorService that wraps the provided one.
Creates a new instrumented ExecutorService that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala). All metrics related to the instrumented service will have the following tags:
* all of the provided extraTags (take into account that any "name" or "type" tags will be overwritten. * name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrumentExecutionContext(executionContext: ExecutionContext, name: String, settings: Settings): InstrumentedExecutionContext

Creates a new instrumented ExecutionContext that wraps the provided one.
Creates a new instrumented ExecutionContext that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala) and optionally, track the time spent by each task on the wrapped executor's queue.
All metrics related to the instrumented service will have the following tags:
* name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrumentExecutionContext(executionContext: ExecutionContext, name: String): InstrumentedExecutionContext

Creates a new instrumented ExecutionContext that wraps the provided one.
Creates a new instrumented ExecutionContext that wraps the provided one. The instrumented executor will track metrics for ThreadPoolExecutor and ForkJoinPool instances (both from Java and Scala). All metrics related to the instrumented service will have the following tags:
* name: set to the provided name parameter. * type: set to "ThreadPoolExecutor" executors or "ForkJoinPool".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrumentScheduledExecutor(executor: ScheduledExecutorService, name: String, extraTags: TagSet): ScheduledExecutorService

Creates a new instrumented ScheduledExecutorService that wraps the provided one.
Creates a new instrumented ScheduledExecutorService that wraps the provided one. The instrumented executor will track metrics for a ScheduledThreadPoolExecutor, but will not perform any context propagation nor track the time in queue metric for submitted tasks.
All metrics related to the instrumented service will have the following tags: * all of the provided extraTags (take into account that any "name" or "type" tags will be overwritten. * name: set to the provided name parameter. * type: set to "ScheduledThreadPoolExecutor".
Once the returned executor is shutdown, all related metric instruments will be removed.
def instrumentScheduledExecutor(executor: ScheduledExecutorService, name: String): ScheduledExecutorService

Creates a new instrumented ScheduledExecutorService that wraps the provided one.
Creates a new instrumented ScheduledExecutorService that wraps the provided one. The instrumented executor will track metrics for a ScheduledThreadPoolExecutor, but will not perform any context propagation nor track the time in queue metric for submitted tasks.
All metrics related to the instrumented service will have the following tags: * name: set to the provided name parameter. * type: set to "ScheduledThreadPoolExecutor".
Once the returned executor is shutdown, all related metric instruments will be removed.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
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 Doc: package executor

object ExecutorInstrumentation

Type Members

trait ForkJoinPoolTelemetryReader extends AnyRef

class InstrumentedExecutionContext extends ExecutionContext

class InstrumentedForkJoinPool extends ExecutorService

class InstrumentedScheduledThreadPoolExecutor extends InstrumentedThreadPool with ScheduledExecutorService

class InstrumentedThreadPool extends ExecutorService

class Settings extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val DefaultSettings: Settings

object ForkJoinPoolTelemetryReader

val NoExtraSettings: Settings

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def instrument(executor: ExecutorService, telemetryReader: ForkJoinPoolTelemetryReader, name: String, extraTags: TagSet, settings: Settings): ExecutorService

def instrument(executor: ExecutorService, name: String, extraTags: TagSet, settings: Settings): ExecutorService

def instrument(executor: ExecutorService, name: String, extraTags: TagSet): ExecutorService

def instrument(executor: ExecutorService, name: String, settings: Settings): ExecutorService

def instrument(executor: ExecutorService, name: String): ExecutorService

def instrumentExecutionContext(executionContext: ExecutionContext, name: String, extraTags: TagSet, settings: Settings): InstrumentedExecutionContext

def instrumentExecutionContext(executionContext: ExecutionContext, name: String, extraTags: TagSet): InstrumentedExecutionContext

def instrumentExecutionContext(executionContext: ExecutionContext, name: String, settings: Settings): InstrumentedExecutionContext

def instrumentExecutionContext(executionContext: ExecutionContext, name: String): InstrumentedExecutionContext

def instrumentScheduledExecutor(executor: ScheduledExecutorService, name: String, extraTags: TagSet): ScheduledExecutorService

def instrumentScheduledExecutor(executor: ScheduledExecutorService, name: String): ScheduledExecutorService

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): 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 AnyRef

Inherited from Any

Ungrouped