Metric (sentinel-core 1.8.3 API)

All Superinterfaces:

DebugSupport

All Known Implementing Classes:

ArrayMetric
```
public interface Metric
extends DebugSupport
```
Represents a basic structure recording invocation metrics of protected resources.

Author:

jialiang.linjl, Eric Zhao

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBlock(int n)` Add current block count.
`void`	`addException(int n)` Add current exception count.
`void`	`addOccupiedPass(int acquireCount)` Add occupied pass, which represents pass requests that borrow the latter windows' token.
`void`	`addPass(int n)` Add current pass count.
`void`	`addRT(long rt)` Add given RT to current total RT.
`void`	`addSuccess(int n)` Add current completed count.
`void`	`addWaiting(long futureTime, int acquireCount)` Add request that occupied.
`long`	`block()` Get total block count.
`List<MetricNode>`	`details()` Get aggregated metric nodes of all resources.
`List<MetricNode>`	`detailsOnCondition(Predicate<Long> timePredicate)` Generate aggregated metric items that satisfies the time predicate.
`long`	`exception()` Get total exception count.
`int`	`getSampleCount()` Get sample count of the sliding window.
`double`	`getWindowIntervalInSec()` Get the sliding window length in seconds.
`long`	`getWindowPass(long timeMillis)` Note: this operation will not perform refreshing, so will not generate new buckets.
`long`	`maxSuccess()` Get max success count.
`long`	`minRt()` Get the minimal RT.
`long`	`occupiedPass()` Get occupied pass count.
`long`	`pass()` Get total pass count.
`long`	`previousWindowBlock()`
`long`	`previousWindowPass()`
`long`	`rt()` Get total response time.
`long`	`success()` Get total success count.
`long`	`waiting()` Get waiting pass account
`MetricBucket[]`	`windows()` Get the raw window array.

Methods inherited from interface com.alibaba.csp.sentinel.slots.statistic.metric.DebugSupport
debug

- Method Detail
  - success
```
long success()
```
    Get total success count.
    
    Returns:
    
    success count
  - maxSuccess
```
long maxSuccess()
```
    Get max success count.
    
    Returns:
    
    max success count
  - exception
```
long exception()
```
    Get total exception count.
    
    Returns:
    
    exception count
  - block
```
long block()
```
    Get total block count.
    
    Returns:
    
    block count
  - pass
```
long pass()
```
    Get total pass count. not include occupiedPass()
    
    Returns:
    
    pass count
  - rt
```
long rt()
```
    Get total response time.
    
    Returns:
    
    total RT
  - minRt
```
long minRt()
```
    Get the minimal RT.
    
    Returns:
    
    minimal RT
  - details
```
List<MetricNode> details()
```
    Get aggregated metric nodes of all resources.
    
    Returns:
    
    metric node list of all resources
  - detailsOnCondition
```
List<MetricNode> detailsOnCondition(Predicate<Long> timePredicate)
```
    Generate aggregated metric items that satisfies the time predicate.
    
    Parameters:
    
    timePredicate - time predicate
    
    Returns:
    
    aggregated metric items
    
    Since:
    
    1.7.0
  - windows
```
MetricBucket[] windows()
```
    Get the raw window array.
    
    Returns:
    
    window metric array
  - addException
```
void addException(int n)
```
    Add current exception count.
    
    Parameters:
    
    n - count to add
  - addBlock
```
void addBlock(int n)
```
    Add current block count.
    
    Parameters:
    
    n - count to add
  - addSuccess
```
void addSuccess(int n)
```
    Add current completed count.
    
    Parameters:
    
    n - count to add
  - addPass
```
void addPass(int n)
```
    Add current pass count.
    
    Parameters:
    
    n - count to add
  - addRT
```
void addRT(long rt)
```
    Add given RT to current total RT.
    
    Parameters:
    
    rt - RT
  - getWindowIntervalInSec
```
double getWindowIntervalInSec()
```
    Get the sliding window length in seconds.
    
    Returns:
    
    the sliding window length
  - getSampleCount
```
int getSampleCount()
```
    Get sample count of the sliding window.
    
    Returns:
    
    sample count of the sliding window.
  - getWindowPass
```
long getWindowPass(long timeMillis)
```
    Note: this operation will not perform refreshing, so will not generate new buckets.
    
    Parameters:
    
    timeMillis - valid time in ms
    
    Returns:
    
    pass count of the bucket exactly associated to provided timestamp, or 0 if the timestamp is invalid
    
    Since:
    
    1.5.0
  - addOccupiedPass
```
void addOccupiedPass(int acquireCount)
```
    Add occupied pass, which represents pass requests that borrow the latter windows' token.
    
    Parameters:
    
    acquireCount - tokens count.
    
    Since:
    
    1.5.0
  - addWaiting
```
void addWaiting(long futureTime,
                int acquireCount)
```
    Add request that occupied.
    
    Parameters:
    
    futureTime - future timestamp that the acquireCount should be added on.
    
    acquireCount - tokens count.
    
    Since:
    
    1.5.0
  - waiting
```
long waiting()
```
    Get waiting pass account
    
    Returns:
    
    waiting pass count
    
    Since:
    
    1.5.0
  - occupiedPass
```
long occupiedPass()
```
    Get occupied pass count.
    
    Returns:
    
    occupied pass count
    
    Since:
    
    1.5.0
  - previousWindowBlock
```
long previousWindowBlock()
```
  - previousWindowPass
```
long previousWindowPass()
```

Interface Metric

Method Summary

Methods inherited from interface com.alibaba.csp.sentinel.slots.statistic.metric.DebugSupport

Method Detail

success

maxSuccess

exception

block

pass

rt

minRt

details

detailsOnCondition

windows

addException

addBlock

addSuccess

addPass

addRT

getWindowIntervalInSec

getSampleCount

getWindowPass

addOccupiedPass

addWaiting

waiting

occupiedPass

previousWindowBlock

previousWindowPass