Package io.engineblock.activityapi.core

Interface ActivityInstrumentation

  • All Known Implementing Classes:
    CoreActivityInstrumentation
    public interface ActivityInstrumentation
    All the accessors of the metrics that will be used for each activity instance. Implementors of this interface should ensure that the methods are synchronized to avoid race conditions during lazy init from callers.

    • Method Summary

      Modifier and Type Method Description
      com.codahale.metrics.Timer getCyclesResponseTimerOrNull()
      The cycles response timer measures the total response time from the scheduled time an operation should start to when it is completed.
      com.codahale.metrics.Timer getOrCreateCyclesServiceTimer()
      The cycles service timer measures how long it takes to complete a cycle of work.
      com.codahale.metrics.Timer getOrCreateInputTimer()
      The input timer measures how long it takes to get the cycle value to be used for an operation.
      com.codahale.metrics.Counter getOrCreatePendingOpCounter()
      The pending ops counter keeps track of how many ops are submitted or in-flight, but which haven't been completed yet.
      com.codahale.metrics.Timer getOrCreatePhasesServiceTimer()
      The phases service timer measures how long it takes to complete a phase of work.
      com.codahale.metrics.Timer getOrCreateStridesServiceTimer()
      The strides service timer measures how long it takes to complete a stride of work.
      com.codahale.metrics.Timer getPhasesResponseTimerOrNull()
      The phases response timer measures the total response time from the scheduled time a phase should start to when it is completed.
      com.codahale.metrics.Timer getStridesResponseTimerOrNull()
      The strides response timer measures the total response time from the scheduled time a stride should start to when it completed.

    • Method Detail

      • getOrCreateInputTimer

        com.codahale.metrics.Timer getOrCreateInputTimer()
        The input timer measures how long it takes to get the cycle value to be used for an operation.
        Returns:
        A new or existing Timer

      • getOrCreateStridesServiceTimer

        com.codahale.metrics.Timer getOrCreateStridesServiceTimer()
        The strides service timer measures how long it takes to complete a stride of work.
        Returns:
        A new or existing Timer

      • getStridesResponseTimerOrNull

        com.codahale.metrics.Timer getStridesResponseTimerOrNull()
        The strides response timer measures the total response time from the scheduled time a stride should start to when it completed. Stride scheduling is only defined when it is implied by a stride rate limiter, so this method should return null if there is no strides rate limiter.
        Returns:
        A new or existing Timer if appropriate, else null

      • getOrCreateCyclesServiceTimer

        com.codahale.metrics.Timer getOrCreateCyclesServiceTimer()
        The cycles service timer measures how long it takes to complete a cycle of work.
        Returns:
        A new or existing Timer

      • getCyclesResponseTimerOrNull

        com.codahale.metrics.Timer getCyclesResponseTimerOrNull()
        The cycles response timer measures the total response time from the scheduled time an operation should start to when it is completed. Cycle scheduling is only defined when it is implied by a cycle rate limiter, so this method should return null if there is no cycles rate limiter.
        Returns:
        A new or existing Timer if appropriate, else null

      • getOrCreatePhasesServiceTimer

        com.codahale.metrics.Timer getOrCreatePhasesServiceTimer()
        The phases service timer measures how long it takes to complete a phase of work.
        Returns:
        A new or existing Timer

      • getPhasesResponseTimerOrNull

        com.codahale.metrics.Timer getPhasesResponseTimerOrNull()
        The phases response timer measures the total response time from the scheduled time a phase should start to when it is completed. Phase scheduling is only defined when it is implied by a phase rate limiter, so this method should return null if there is no phases rate limiter.
        Returns:
        A new or existing Timer if appropriate, else null

      • getOrCreatePendingOpCounter

        com.codahale.metrics.Counter getOrCreatePendingOpCounter()
        The pending ops counter keeps track of how many ops are submitted or in-flight, but which haven't been completed yet.
        Returns:
        A new or existing Counter