HystrixCommandMetrics (Hystrix Javadoc 1.5.3)

java.lang.Object
- com.netflix.hystrix.HystrixMetrics
- - com.netflix.hystrix.HystrixCommandMetrics

public class HystrixCommandMetrics
extends HystrixMetrics

Used by HystrixCommand to record metrics.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HystrixCommandMetrics.HealthCounts
Number of requests during rolling window.

Nested Classes
Modifier and Type	Class and Description
`static class`	`HystrixCommandMetrics.HealthCounts` Number of requests during rolling window.

Field Summary

Fields
Modifier and Type	Field and Description
`static rx.functions.Func2<long[],com.netflix.hystrix.metric.HystrixCommandCompletion,long[]>`	`appendEventToBucket`
`static rx.functions.Func2<long[],long[],long[]>`	`bucketAggregator`

Fields inherited from class com.netflix.hystrix.HystrixMetrics
counter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HystrixCommandGroupKey`	`getCommandGroup()` `HystrixCommandGroupKey` of the `HystrixCommand` these metrics represent.
`HystrixCommandKey`	`getCommandKey()` `HystrixCommandKey` these metrics represent.
`long`	`getCumulativeCount(HystrixEventType eventType)`
`long`	`getCumulativeCount(com.netflix.hystrix.util.HystrixRollingNumberEvent event)` Get the cumulative count since the start of the application for the given `HystrixRollingNumberEvent`.
`int`	`getCurrentConcurrentExecutionCount()` Current number of concurrent executions of `HystrixCommand.run()`;
`int`	`getExecutionTimeMean()` The mean (average) execution time (in milliseconds) for the `HystrixCommand.run()`.
`int`	`getExecutionTimePercentile(double percentile)` Retrieve the execution time (in milliseconds) for the `HystrixCommand.run()` method being invoked at a given percentile.
`HystrixCommandMetrics.HealthCounts`	`getHealthCounts()` Retrieve a snapshot of total requests, error count and error percentage.
`static HystrixCommandMetrics`	`getInstance(HystrixCommandKey key)` Get the `HystrixCommandMetrics` instance for a given `HystrixCommandKey` or null if one does not exist.
`static HystrixCommandMetrics`	`getInstance(HystrixCommandKey key, HystrixCommandGroupKey commandGroup, HystrixCommandProperties properties)` Get or create the `HystrixCommandMetrics` instance for a given `HystrixCommandKey`.
`static HystrixCommandMetrics`	`getInstance(HystrixCommandKey key, HystrixCommandGroupKey commandGroup, HystrixThreadPoolKey threadPoolKey, HystrixCommandProperties properties)` Get or create the `HystrixCommandMetrics` instance for a given `HystrixCommandKey`.
`static java.util.Collection<HystrixCommandMetrics>`	`getInstances()` All registered instances of `HystrixCommandMetrics`
`HystrixCommandProperties`	`getProperties()` `HystrixCommandProperties` of the `HystrixCommand` these metrics represent.
`long`	`getRollingCount(HystrixEventType eventType)`
`long`	`getRollingCount(com.netflix.hystrix.util.HystrixRollingNumberEvent event)` Get the rolling count for the given `HystrixRollingNumberEvent`.
`long`	`getRollingMaxConcurrentExecutions()`
`HystrixThreadPoolKey`	`getThreadPoolKey()` `HystrixThreadPoolKey` used by `HystrixCommand` these metrics represent.
`int`	`getTotalTimeMean()` The mean (average) execution time (in milliseconds) for `HystrixCommand.execute()` or `HystrixCommand.queue()`.
`int`	`getTotalTimePercentile(double percentile)` Retrieve the total end-to-end execution time (in milliseconds) for `HystrixCommand.execute()` or `HystrixCommand.queue()` at a given percentile.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - appendEventToBucket
```
public static final rx.functions.Func2<long[],com.netflix.hystrix.metric.HystrixCommandCompletion,long[]> appendEventToBucket
```
  - bucketAggregator
```
public static final rx.functions.Func2<long[],long[],long[]> bucketAggregator
```
- Method Detail
  - getInstance
```
public static HystrixCommandMetrics getInstance(HystrixCommandKey key,
                                                HystrixCommandGroupKey commandGroup,
                                                HystrixCommandProperties properties)
```
    Get or create the HystrixCommandMetrics instance for a given HystrixCommandKey.
    This is thread-safe and ensures only 1 HystrixCommandMetrics per HystrixCommandKey.
    
    Parameters:
    
    key - HystrixCommandKey of HystrixCommand instance requesting the HystrixCommandMetrics
    
    commandGroup - Pass-thru to HystrixCommandMetrics instance on first time when constructed
    
    properties - Pass-thru to HystrixCommandMetrics instance on first time when constructed
    
    Returns:
    
    HystrixCommandMetrics
  - getInstance
```
public static HystrixCommandMetrics getInstance(HystrixCommandKey key,
                                                HystrixCommandGroupKey commandGroup,
                                                HystrixThreadPoolKey threadPoolKey,
                                                HystrixCommandProperties properties)
```
    Get or create the HystrixCommandMetrics instance for a given HystrixCommandKey.
    This is thread-safe and ensures only 1 HystrixCommandMetrics per HystrixCommandKey.
    
    Parameters:
    
    key - HystrixCommandKey of HystrixCommand instance requesting the HystrixCommandMetrics
    
    commandGroup - Pass-thru to HystrixCommandMetrics instance on first time when constructed
    
    properties - Pass-thru to HystrixCommandMetrics instance on first time when constructed
    
    Returns:
    
    HystrixCommandMetrics
  - getInstance
```
public static HystrixCommandMetrics getInstance(HystrixCommandKey key)
```
    Get the HystrixCommandMetrics instance for a given HystrixCommandKey or null if one does not exist.
    
    Parameters:
    
    key - HystrixCommandKey of HystrixCommand instance requesting the HystrixCommandMetrics
    
    Returns:
    
    HystrixCommandMetrics
  - getInstances
```
public static java.util.Collection<HystrixCommandMetrics> getInstances()
```
    All registered instances of HystrixCommandMetrics
    
    Returns:
    
    Collection<HystrixCommandMetrics>
  - getCommandKey
```
public HystrixCommandKey getCommandKey()
```
    HystrixCommandKey these metrics represent.
    
    Returns:
    
    HystrixCommandKey
  - getCommandGroup
```
public HystrixCommandGroupKey getCommandGroup()
```
    HystrixCommandGroupKey of the HystrixCommand these metrics represent.
    
    Returns:
    
    HystrixCommandGroupKey
  - getThreadPoolKey
```
public HystrixThreadPoolKey getThreadPoolKey()
```
    HystrixThreadPoolKey used by HystrixCommand these metrics represent.
    
    Returns:
    
    HystrixThreadPoolKey
  - getProperties
```
public HystrixCommandProperties getProperties()
```
    HystrixCommandProperties of the HystrixCommand these metrics represent.
    
    Returns:
    
    HystrixCommandProperties
  - getRollingCount
```
public long getRollingCount(HystrixEventType eventType)
```
  - getCumulativeCount
```
public long getCumulativeCount(HystrixEventType eventType)
```
  - getCumulativeCount
```
public long getCumulativeCount(com.netflix.hystrix.util.HystrixRollingNumberEvent event)
```
    Description copied from class: HystrixMetrics
    
    Get the cumulative count since the start of the application for the given HystrixRollingNumberEvent.
    
    Overrides:
    
    getCumulativeCount in class HystrixMetrics
    
    Parameters:
    
    event - HystrixRollingNumberEvent of the event to retrieve a sum for
    
    Returns:
    
    long cumulative count
  - getRollingCount
```
public long getRollingCount(com.netflix.hystrix.util.HystrixRollingNumberEvent event)
```
    Description copied from class: HystrixMetrics
    
    Get the rolling count for the given HystrixRollingNumberEvent.
    The rolling window is defined by HystrixCommandProperties.metricsRollingStatisticalWindowInMilliseconds().
    
    Overrides:
    
    getRollingCount in class HystrixMetrics
    
    Parameters:
    
    event - HystrixRollingNumberEvent of the event to retrieve a sum for
    
    Returns:
    
    long rolling count
  - getExecutionTimePercentile
```
public int getExecutionTimePercentile(double percentile)
```
    Retrieve the execution time (in milliseconds) for the HystrixCommand.run() method being invoked at a given percentile.
    Percentile capture and calculation is configured via HystrixCommandProperties.metricsRollingStatisticalWindowInMilliseconds() and other related properties.
    
    Parameters:
    
    percentile - Percentile such as 50, 99, or 99.5.
    
    Returns:
    
    int time in milliseconds
  - getExecutionTimeMean
```
public int getExecutionTimeMean()
```
    The mean (average) execution time (in milliseconds) for the HystrixCommand.run().
    This uses the same backing data as getExecutionTimePercentile(double);
    
    Returns:
    
    int time in milliseconds
  - getTotalTimePercentile
```
public int getTotalTimePercentile(double percentile)
```
    Retrieve the total end-to-end execution time (in milliseconds) for HystrixCommand.execute() or HystrixCommand.queue() at a given percentile.
    When execution is successful this would include time from getExecutionTimePercentile(double) but when execution is being rejected, short-circuited, or timed-out then the time will differ.
    This time can be lower than getExecutionTimePercentile(double) when a timeout occurs and the backing thread that calls HystrixCommand.run() is still running.
    When rejections or short-circuits occur then HystrixCommand.run() will not be executed and thus not contribute time to getExecutionTimePercentile(double) but time will still show up in this metric for the end-to-end time.
    This metric gives visibility into the total cost of HystrixCommand execution including the overhead of queuing, executing and waiting for a thread to invoke HystrixCommand.run() .
    Percentile capture and calculation is configured via HystrixCommandProperties.metricsRollingStatisticalWindowInMilliseconds() and other related properties.
    
    Parameters:
    
    percentile - Percentile such as 50, 99, or 99.5.
    
    Returns:
    
    int time in milliseconds
  - getTotalTimeMean
```
public int getTotalTimeMean()
```
    The mean (average) execution time (in milliseconds) for HystrixCommand.execute() or HystrixCommand.queue().
    This uses the same backing data as getTotalTimePercentile(double);
    
    Returns:
    
    int time in milliseconds
  - getRollingMaxConcurrentExecutions
```
public long getRollingMaxConcurrentExecutions()
```
  - getCurrentConcurrentExecutionCount
```
public int getCurrentConcurrentExecutionCount()
```
    Current number of concurrent executions of HystrixCommand.run();
    
    Returns:
    
    int
  - getHealthCounts
```
public HystrixCommandMetrics.HealthCounts getHealthCounts()
```
    Retrieve a snapshot of total requests, error count and error percentage. This metrics should measure the actual health of a HystrixCommand. For that reason, the following are included:
    The following are not included in either attempts/failures:
    - HystrixEventType.BAD_REQUEST - this event denotes bad arguments to the command and not a problem with the command
    - HystrixEventType.SHORT_CIRCUITED - this event measures a health problem in the past, not a problem with the current state
    - HystrixEventType.CANCELLED - this event denotes a user-cancelled command. It's not known if it would have been a success or failure, so it shouldn't count for either
    - All Fallback metrics
    - HystrixEventType.EMIT - this event is not a terminal state for the command
    - HystrixEventType.COLLAPSED - this event is about the batching process, not the command execution
    Returns:
    
    HystrixCommandMetrics.HealthCounts

Hystrix: Latency and Fault Tolerance for Distributed Systems

Class HystrixCommandMetrics

Nested Class Summary

Field Summary

Fields inherited from class com.netflix.hystrix.HystrixMetrics

Method Summary

Methods inherited from class java.lang.Object

Field Detail

appendEventToBucket

bucketAggregator

Method Detail

getInstance

getInstance

getInstance

getInstances

getCommandKey

getCommandGroup

getThreadPoolKey

getProperties

getRollingCount

getCumulativeCount

getCumulativeCount

getRollingCount

getExecutionTimePercentile

getExecutionTimeMean

getTotalTimePercentile

getTotalTimeMean

getRollingMaxConcurrentExecutions

getCurrentConcurrentExecutionCount

getHealthCounts