Package com.netflix.hystrix

Class HystrixRequestLog

java.lang.Object

com.netflix.hystrix.HystrixRequestLog

public class HystrixRequestLog
extends java.lang.Object

Log of HystrixCommand executions and events during the current request.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<HystrixInvokableInfo<?>>	getAllExecutedCommands() Retrieve HystrixCommand instances that were executed during this HystrixRequestContext.
static HystrixRequestLog	getCurrentRequest() HystrixRequestLog for current request as defined by HystrixRequestContext.
static HystrixRequestLog	getCurrentRequest(HystrixConcurrencyStrategy concurrencyStrategy) HystrixRequestLog for current request as defined by HystrixRequestContext.
java.util.Collection<HystrixCommand<?>>	getExecutedCommands() Deprecated.
java.lang.String	getExecutedCommandsAsString() Formats the log of executed commands into a string usable for logging purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCurrentRequest

public static HystrixRequestLog getCurrentRequest(HystrixConcurrencyStrategy concurrencyStrategy)

HystrixRequestLog for current request as defined by HystrixRequestContext.

Returns:

HystrixRequestLog

getCurrentRequest

public static HystrixRequestLog getCurrentRequest()

HystrixRequestLog for current request as defined by HystrixRequestContext.

NOTE: This uses the default HystrixConcurrencyStrategy or global override. If an injected strategy is being used by commands you must instead use getCurrentRequest(HystrixConcurrencyStrategy).

Returns:

HystrixRequestLog

getExecutedCommands

@Deprecated
public java.util.Collection<HystrixCommand<?>> getExecutedCommands()

Deprecated.

Retrieve HystrixCommand instances that were executed during this HystrixRequestContext.

Returns:

Collection<HystrixCommand<?>>

getAllExecutedCommands

public java.util.Collection<HystrixInvokableInfo<?>> getAllExecutedCommands()

Retrieve HystrixCommand instances that were executed during this HystrixRequestContext.

Returns:

Collection<HystrixCommand<?>>

getExecutedCommandsAsString

public java.lang.String getExecutedCommandsAsString()

Formats the log of executed commands into a string usable for logging purposes.

Examples:

• TestCommand[SUCCESS][1ms]
• TestCommand[SUCCESS][1ms], TestCommand[SUCCESS, RESPONSE_FROM_CACHE][1ms]x4
• TestCommand[TIMEOUT][1ms]
• TestCommand[FAILURE][1ms]
• TestCommand[THREAD_POOL_REJECTED][1ms]
• TestCommand[THREAD_POOL_REJECTED, FALLBACK_SUCCESS][1ms]
• TestCommand[EMIT, SUCCESS][1ms]
• TestCommand[EMITx5, SUCCESS][1ms]
• TestCommand[EMITx5, FAILURE, FALLBACK_EMITx6, FALLBACK_FAILURE][100ms]
• TestCommand[FAILURE, FALLBACK_SUCCESS][1ms], TestCommand[FAILURE, FALLBACK_SUCCESS, RESPONSE_FROM_CACHE][1ms]x4
• GetData[SUCCESS][1ms], PutData[SUCCESS][1ms], GetValues[SUCCESS][1ms], GetValues[SUCCESS, RESPONSE_FROM_CACHE][1ms], TestCommand[FAILURE, FALLBACK_FAILURE][1ms], TestCommand[FAILURE, FALLBACK_FAILURE, RESPONSE_FROM_CACHE][1ms]

If a command has a multiplier such as x4, that means this command was executed 4 times with the same events. The time in milliseconds is the sum of the 4 executions.

For example, TestCommand[SUCCESS][15ms]x4 represents TestCommand being executed 4 times and the sum of those 4 executions was 15ms. These 4 each executed the run() method since RESPONSE_FROM_CACHE was not present as an event. If an EMIT or FALLBACK_EMIT has a multiplier such as x5, that means a HystrixObservableCommand was used and it emitted that number of OnNexts.

For example, TestCommand[EMITx5, FAILURE, FALLBACK_EMITx6, FALLBACK_FAILURE][100ms] represents TestCommand executing observably, emitted 5 OnNexts, then an OnError. This command also has an Observable fallback, and it emits 6 OnNexts, then an OnCompleted.

Returns:

String request log or "Unknown" if unable to instead of throwing an exception.