CacheStats (Buck)

java.lang.Object
- com.facebook.buck.util.cache.CacheStats

public abstract class CacheStats
extends Object

Class containing various cache statistics

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CacheStats.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`CacheStats.Builder`

Constructor Summary

Constructors
Constructor and Description

CacheStats()

Constructors
Constructor and Description
`CacheStats()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`CacheStats`	`add(CacheStats stats)`
`static CacheStats.Builder`	`builder()`
`abstract Optional<Long>`	`getEvictionCount()`
`abstract Optional<Long>`	`getHitCount()`
`abstract Optional<Long>`	`getInvalidationCount()`
`abstract Optional<Long>`	`getLoadExceptionCount()`
`abstract Optional<Long>`	`getLoadSuccessCount()`
`abstract Optional<Long>`	`getMissCount()`
`abstract Optional<Long>`	`getMissMatchCount()`
`abstract Optional<Long>`	`getNumberEntries()`
`Optional<Long>`	`getRequestCount()`
`abstract Optional<Long>`	`getRetrievalTime()`
`abstract Optional<Long>`	`getTotalLoadTime()`
`abstract Optional<Long>`	`getTotalMissTime()`
`Optional<Double>`	`hitRate()` Returns the ratio of cache requests which were hits.
`Optional<Double>`	`missMatchRate()` Returns the ratio of cache requests which were misses due to mismatch.
`Optional<Double>`	`missRate()` Returns the ratio of cache requests which were misses.
`CacheStats`	`subtract(CacheStats stats)` Adds or subtract two CacheStats if a field is specified by both CacheStats, with a minimum value of 0.

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

- Constructor Detail
  - CacheStats
```
public CacheStats()
```
- Method Detail
  - getHitCount
```
public abstract Optional<Long> getHitCount()
```
  - getMissCount
```
public abstract Optional<Long> getMissCount()
```
  - getMissMatchCount
```
public abstract Optional<Long> getMissMatchCount()
```
  - getEvictionCount
```
public abstract Optional<Long> getEvictionCount()
```
  - getInvalidationCount
```
public abstract Optional<Long> getInvalidationCount()
```
  - getLoadSuccessCount
```
public abstract Optional<Long> getLoadSuccessCount()
```
  - getLoadExceptionCount
```
public abstract Optional<Long> getLoadExceptionCount()
```
  - getRetrievalTime
```
public abstract Optional<Long> getRetrievalTime()
```
  - getTotalLoadTime
```
public abstract Optional<Long> getTotalLoadTime()
```
  - getTotalMissTime
```
public abstract Optional<Long> getTotalMissTime()
```
  - getNumberEntries
```
public abstract Optional<Long> getNumberEntries()
```
  - getRequestCount
```
public Optional<Long> getRequestCount()
```
    Returns:
    
    the total number of requests to the cash defined as getHitCount() + getMissCount() + getMissMatchCount() if both hitCount and one of missCount or missMissMatchCount is set
  - hitRate
```
public Optional<Double> hitRate()
```
    Returns the ratio of cache requests which were hits. This is defined as getHitCount() / requestCount, or 1.0 when requestCount == 0. Note that hitRate + missRate =~ 1.0.
  - missRate
```
public Optional<Double> missRate()
```
    Returns the ratio of cache requests which were misses. This is defined as getMissCount() / requestCount, or 0.0 when requestCount == 0. Note that hitRate + missRate + missMatchRate =~ 1.0. Cache misses include all requests which weren't cache hits, including requests which resulted in either successful or failed loading attempts, and requests which waited for other threads to finish loading. It is thus the case that getMissCount() + getMissMatchCount() >= getLoadSuccessCount() + getLoadExceptionCount(). Multiple concurrent misses for the same key will result in a single load operation.
  - missMatchRate
```
public Optional<Double> missMatchRate()
```
    Returns the ratio of cache requests which were misses due to mismatch. This is defined as getMissMatchCount() / requestCount, or 0.0 when requestCount == 0. Note that hitRate + missRate + missMatchRate =~ 1.0. Cache misses include all requests which weren't cache hits, including requests which resulted in either successful or failed loading attempts, and requests which waited for other threads to finish loading. It is thus the case that getMissCount() + getMissMatchCount() >= getLoadSuccessCount() + getLoadExceptionCount(). Multiple concurrent misses for the same key will result in a single load operation.
  - subtract
```
public CacheStats subtract(CacheStats stats)
```
    Adds or subtract two CacheStats if a field is specified by both CacheStats, with a minimum value of 0. If only one CacheStats specifies the field, the unspecified value is treated as 0. If non of the CacheStats specifies the field, the field will be empty.
    
    Parameters:
    
    stats - the stats after the arithmetic operator
    
    Returns:
    
    this +/- stats
  - add
```
public CacheStats add(CacheStats stats)
```
  - builder
```
public static CacheStats.Builder builder()
```

Class CacheStats

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheStats

Method Detail

getHitCount

getMissCount

getMissMatchCount

getEvictionCount

getInvalidationCount

getLoadSuccessCount

getLoadExceptionCount

getRetrievalTime

getTotalLoadTime

getTotalMissTime

getNumberEntries

getRequestCount

hitRate

missRate

missMatchRate

subtract

add

builder