CompassImpl (metrics-core-impl 2.0.1 API)

java.lang.Object
- com.alibaba.metrics.CompassImpl

所有已实现的接口:

Compass, Counting, Metered, Metric, Sampling
```
public class CompassImpl
extends Object
implements Compass
```

嵌套类概要

嵌套类
限定符和类型类和说明

class CompassImpl.ContextImpl
- 从接口继承的嵌套类/接口 com.alibaba.metrics.Compass
  Compass.Context

嵌套类
限定符和类型	类和说明
`class`	`CompassImpl.ContextImpl`

构造器概要

构造器
构造器和说明
`CompassImpl()` Creates a new `CompassImpl` using an `ExponentiallyDecayingReservoir` and the default `Clock`.
`CompassImpl(int bucketInterval)`
`CompassImpl(int bucketInterval, ReservoirType type)`
`CompassImpl(ReservoirType type, Clock clock, int numberOfBucket, int bucketInterval, int maxErrorCodeCount, int maxAddonCount)` Creates a new `CompassImpl` that uses the given `Reservoir` and `Clock`.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Map<String,BucketCounter>`	`getAddonCounts()`
`BucketCounter`	`getBucketSuccessCount()`
`long`	`getCount()`
`Map<String,BucketCounter>`	`getErrorCodeCounts()`
`double`	`getFifteenMinuteRate()`
`double`	`getFiveMinuteRate()`
`Map<Long,Long>`	`getInstantCount()`
`Map<Long,Long>`	`getInstantCount(long startTime)`
`int`	`getInstantCountInterval()`
`double`	`getMeanRate()`
`double`	`getOneMinuteRate()`
`Snapshot`	`getSnapshot()`
`long`	`getSuccessCount()`
`double`	`getSuccessRate()`
`long`	`lastUpdateTime()`
`void`	`setReservoir(Reservoir reservoir)` This is only for unit test
`Compass.Context`	`time()` Returns a new `Context`.
`<T> T`	`time(Callable<T> event)` Times and records the duration of event.
`void`	`update(long duration, TimeUnit unit)` Adds a recorded duration.
`void`	`update(long duration, TimeUnit unit, boolean isSuccess, String errorCode, String addon)` Adds a recorded duration

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CompassImpl
```
public CompassImpl()
```
    Creates a new CompassImpl using an ExponentiallyDecayingReservoir and the default Clock.
  - CompassImpl
```
public CompassImpl(int bucketInterval)
```
  - CompassImpl
```
public CompassImpl(int bucketInterval,
                   ReservoirType type)
```
  - CompassImpl
```
public CompassImpl(ReservoirType type,
                   Clock clock,
                   int numberOfBucket,
                   int bucketInterval,
                   int maxErrorCodeCount,
                   int maxAddonCount)
```
    Creates a new CompassImpl that uses the given Reservoir and Clock.
    
    参数:
    
    type - the Reservoir implementation the timer should use
    
    clock - the Clock implementation the timer should use
    
    maxErrorCodeCount - the max number of error code allowed
    
    bucketInterval - the bucket interval
    
    maxAddonCount - the max number of add on allowed
- 方法详细资料
  - update
```
public void update(long duration,
                   TimeUnit unit)
```
    Adds a recorded duration.
    
    指定者:
    
    update 在接口中 Compass
    
    参数:
    
    duration - the length of the duration
    
    unit - the scale unit of duration
  - update
```
public void update(long duration,
                   TimeUnit unit,
                   boolean isSuccess,
                   String errorCode,
                   String addon)
```
    Adds a recorded duration
    
    指定者:
    
    update 在接口中 Compass
    
    参数:
    
    duration - the length of the duration
    
    unit - the scale unit of duration
    
    isSuccess - whether it is success
    
    errorCode - the error code with this record, if not, null be passed
    
    addon - the addon with this record, if not, null be passed
  - time
```
public <T> T time(Callable<T> event)
           throws Exception
```
    Times and records the duration of event.
    
    指定者:
    
    time 在接口中 Compass
    
    类型参数:
    
    T - the type of the value returned by event
    
    参数:
    
    event - a Callable whose Callable.call() method implements a process whose duration should be timed
    
    返回:
    
    the value returned by event
    
    抛出:
    
    Exception - if event throws an Exception
  - time
```
public Compass.Context time()
```
    Returns a new Context.
    
    指定者:
    
    time 在接口中 Compass
    
    返回:
    
    a new Context
    
    另请参阅:
    
    Context
  - getCount
```
public long getCount()
```
    指定者:
    
    getCount 在接口中 Counting
    
    指定者:
    
    getCount 在接口中 Metered
  - getFifteenMinuteRate
```
public double getFifteenMinuteRate()
```
    指定者:
    
    getFifteenMinuteRate 在接口中 Metered
  - getFiveMinuteRate
```
public double getFiveMinuteRate()
```
    指定者:
    
    getFiveMinuteRate 在接口中 Metered
  - getMeanRate
```
public double getMeanRate()
```
    指定者:
    
    getMeanRate 在接口中 Metered
  - getOneMinuteRate
```
public double getOneMinuteRate()
```
    指定者:
    
    getOneMinuteRate 在接口中 Metered
  - getInstantCount
```
public Map<Long,Long> getInstantCount()
```
    指定者:
    
    getInstantCount 在接口中 Metered
  - getSnapshot
```
public Snapshot getSnapshot()
```
    指定者:
    
    getSnapshot 在接口中 Sampling
  - getErrorCodeCounts
```
public Map<String,BucketCounter> getErrorCodeCounts()
```
    指定者:
    
    getErrorCodeCounts 在接口中 Compass
  - getSuccessRate
```
public double getSuccessRate()
```
    指定者:
    
    getSuccessRate 在接口中 Compass
  - getSuccessCount
```
public long getSuccessCount()
```
    指定者:
    
    getSuccessCount 在接口中 Compass
  - getBucketSuccessCount
```
public BucketCounter getBucketSuccessCount()
```
    指定者:
    
    getBucketSuccessCount 在接口中 Compass
  - getInstantCountInterval
```
public int getInstantCountInterval()
```
    指定者:
    
    getInstantCountInterval 在接口中 Metered
  - getAddonCounts
```
public Map<String,BucketCounter> getAddonCounts()
```
    指定者:
    
    getAddonCounts 在接口中 Compass
  - getInstantCount
```
public Map<Long,Long> getInstantCount(long startTime)
```
    指定者:
    
    getInstantCount 在接口中 Metered
  - setReservoir
```
public void setReservoir(Reservoir reservoir)
```
    This is only for unit test
    
    参数:
    
    reservoir -
  - lastUpdateTime
```
public long lastUpdateTime()
```
    指定者:
    
    lastUpdateTime 在接口中 Metric

类 CompassImpl

嵌套类概要

从接口继承的嵌套类/接口 com.alibaba.metrics.Compass

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CompassImpl

CompassImpl

CompassImpl

CompassImpl

方法详细资料

update

update

time

time

getCount

getFifteenMinuteRate

getFiveMinuteRate

getMeanRate

getOneMinuteRate

getInstantCount

getSnapshot

getErrorCodeCounts

getSuccessRate

getSuccessCount

getBucketSuccessCount

getInstantCountInterval

getAddonCounts

getInstantCount

setReservoir

lastUpdateTime