1 package com.atlassian.cache.memory.jmx;
2
3 /**
4 * JMX MBean interface for Guava Cache.
5 *
6 * @since v3.1
7 */
8 public interface MemoryCacheMXBean
9 {
10 /**
11 * Returns the number of times Cache lookup methods have returned either a cached or uncached value.
12 *
13 * @return request count
14 */
15 long getRequestCount();
16
17 /**
18 * Returns the number of times Cache lookup methods have returned a cached value.
19 *
20 * @return hit count
21 */
22 long getHitCount();
23
24 /**
25 * Returns the ratio of cache requests which were hits.
26 *
27 * @return hit ratio
28 */
29 double getHitRate();
30
31 /**
32 * Returns the number of times Cache lookup methods have returned an uncached (newly loaded) value, or null.
33 *
34 * @return miss count
35 */
36 long getMissCount();
37
38 /**
39 * Returns the ratio of cache requests which were misses.
40 *
41 * @return miss rate
42 */
43 double getMissRate();
44
45 /**
46 * Returns the total number of times that Cache lookup methods attempted to load new values.
47 *
48 * @return load count
49 */
50 long getLoadCount();
51
52 /**
53 * Returns the number of times Cache lookup methods have successfully loaded a new value.
54 *
55 * @return load success count
56 */
57 long getLoadSuccessCount();
58
59 /**
60 * Returns the number of times Cache lookup methods threw an exception while loading a new value.
61 *
62 * @return load exception count
63 */
64 long getLoadExceptionCount();
65
66 /**
67 * Returns the ratio of cache loading attempts which threw exceptions.
68 *
69 * @return load exception rate
70 */
71 double getLoadExceptionRate();
72
73 /**
74 * Returns the total number of nanoseconds the cache has spent loading new values.
75 *
76 * @return total load time
77 */
78 long getTotalLoadTime();
79
80 /**
81 * Returns the average time spent loading new values.
82 *
83 * @return average load penalty
84 */
85 double getAverageLoadPenalty();
86
87 /**
88 * Returns the number of times an entry has been evicted.
89 *
90 * @return eviction count
91 */
92 long getEvictionCount();
93
94 /**
95 * Returns the number of cached objects
96 *
97 * @return size
98 */
99 long getSize();
100
101 }