CommandLatencyCollectorOptions (Lettuce 5.2.0.RELEASE API)

All Known Implementing Classes:

DefaultCommandLatencyCollectorOptions
```
public interface CommandLatencyCollectorOptions
```
Configuration interface for command latency collection.

Author:

Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface CommandLatencyCollectorOptions.Builder
Builder for CommandLatencyCollectorOptions.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CommandLatencyCollectorOptions.Builder` Builder for `CommandLatencyCollectorOptions`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CommandLatencyCollectorOptions.Builder`	`builder()` Returns a new `CommandLatencyCollectorOptions.Builder` to construct `CommandLatencyCollectorOptions`.
`static CommandLatencyCollectorOptions`	`create()` Create a new `CommandLatencyCollectorOptions` instance using default settings.
`static CommandLatencyCollectorOptions`	`disabled()` Create a `CommandLatencyCollectorOptions` instance with disabled event emission.
`boolean`	`isEnabled()` Returns whether the latency collector is enabled.
`boolean`	`localDistinction()` Returns whether to distinct latencies on local level.
`CommandLatencyCollectorOptions.Builder`	`mutate()` Returns a builder to create new `CommandLatencyCollectorOptions` whose settings are replicated from the current `CommandLatencyCollectorOptions`.
`boolean`	`resetLatenciesAfterEvent()` Returns whether the latencies should be reset once an event is emitted.
`double[]`	`targetPercentiles()` Returns the percentiles which should be exposed in the metric.
`TimeUnit`	`targetUnit()` Returns the target `TimeUnit` for the emitted latencies.

- Method Detail
  - create
```
static CommandLatencyCollectorOptions create()
```
    Create a new CommandLatencyCollectorOptions instance using default settings.
    
    Returns:
    
    a new instance of CommandLatencyCollectorOptions instance using default settings
    
    Since:
    
    5.1
  - disabled
```
static CommandLatencyCollectorOptions disabled()
```
    Create a CommandLatencyCollectorOptions instance with disabled event emission.
    
    Returns:
    
    a new instance of CommandLatencyCollectorOptions with disabled event emission
    
    Since:
    
    5.1
  - builder
```
static CommandLatencyCollectorOptions.Builder builder()
```
    Returns a new CommandLatencyCollectorOptions.Builder to construct CommandLatencyCollectorOptions.
    
    Returns:
    
    a new CommandLatencyCollectorOptions.Builder to construct CommandLatencyCollectorOptions.
    
    Since:
    
    5.1
  - mutate
```
CommandLatencyCollectorOptions.Builder mutate()
```
    Returns a builder to create new CommandLatencyCollectorOptions whose settings are replicated from the current CommandLatencyCollectorOptions.
    
    Returns:
    
    a a CommandLatencyCollectorOptions.Builder to create new CommandLatencyCollectorOptions whose settings are replicated from the current CommandLatencyCollectorOptions
    
    Since:
    
    5.1
  - targetUnit
```
TimeUnit targetUnit()
```
    Returns the target TimeUnit for the emitted latencies.
    
    Returns:
    
    the target TimeUnit for the emitted latencies
  - targetPercentiles
```
double[] targetPercentiles()
```
    Returns the percentiles which should be exposed in the metric.
    
    Returns:
    
    the percentiles which should be exposed in the metric
  - resetLatenciesAfterEvent
```
boolean resetLatenciesAfterEvent()
```
    Returns whether the latencies should be reset once an event is emitted.
    
    Returns:
    
    true if the latencies should be reset once an event is emitted.
  - localDistinction
```
boolean localDistinction()
```
    Returns whether to distinct latencies on local level. If true, multiple connections to the same host/connection point will be recorded separately which allows to inspect every connection individually. If false, multiple connections to the same host/connection point will be recorded together. This allows a consolidated view on one particular service.
    
    Returns:
    
    true if latencies are recorded distinct on local level (per connection)
  - isEnabled
```
boolean isEnabled()
```
    Returns whether the latency collector is enabled.
    
    Returns:
    
    true if the latency collector is enabled

Interface CommandLatencyCollectorOptions

Nested Class Summary

Method Summary

Method Detail

create

disabled

builder

mutate

targetUnit

targetPercentiles

resetLatenciesAfterEvent

localDistinction

isEnabled