Metrics (Hive Standalone Metastore Common Code 4.0.0 API)

All Known Implementing Classes:

CodahaleMetrics, LegacyMetrics
```
public interface Metrics
```
Generic Metrics interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addGauge(String name, MetricsVariable<?> variable)` Adds a metrics-gauge to track variable.
`void`	`addRatio(String name, MetricsVariable<Integer> numerator, MetricsVariable<Integer> denominator)` Add a ratio metric to track the correlation between two variables
`void`	`close()` Deinitializes the Metrics system.
`MetricsScope`	`createScope(String name)` Create scope with given name and returns it.
`Long`	`decrementCounter(String name)` Decrements a counter of the given name by 1.
`Long`	`decrementCounter(String name, long decrement)` Decrements a counter of the given name by "decrement"
`void`	`endScope(MetricsScope scope)` Close the given scope.
`void`	`endStoredScope(String name)` Closes the stored scope of a given name.
`Long`	`incrementCounter(String name)` Increments a counter of the given name by 1.
`Long`	`incrementCounter(String name, long increment)` Increments a counter of the given name by "increment"
`void`	`markMeter(String name)` Mark an event occurrence for a meter.
`void`	`removeGauge(String name)` Removed the gauge added by addGauge.
`void`	`startStoredScope(String name)`

- Method Detail
  - close
```
void close()
    throws Exception
```
    Deinitializes the Metrics system.
    
    Throws:
    
    Exception
  - startStoredScope
```
void startStoredScope(String name)
```
    Parameters:
    
    name - starts a scope of a given name. Scopes is stored as thread-local variable.
  - endStoredScope
```
void endStoredScope(String name)
```
    Closes the stored scope of a given name. Note that this must be called on the same thread as where the scope was started.
    
    Parameters:
    
    name -
  - createScope
```
MetricsScope createScope(String name)
```
    Create scope with given name and returns it.
    
    Parameters:
    
    name -
    
    Returns:
  - endScope
```
void endScope(MetricsScope scope)
```
    Close the given scope.
    
    Parameters:
    
    scope -
  - incrementCounter
```
Long incrementCounter(String name)
```
    Increments a counter of the given name by 1.
    
    Parameters:
    
    name -
    
    Returns:
  - incrementCounter
```
Long incrementCounter(String name,
                      long increment)
```
    Increments a counter of the given name by "increment"
    
    Parameters:
    
    name -
    
    increment -
    
    Returns:
  - decrementCounter
```
Long decrementCounter(String name)
```
    Decrements a counter of the given name by 1.
    
    Parameters:
    
    name -
    
    Returns:
  - decrementCounter
```
Long decrementCounter(String name,
                      long decrement)
```
    Decrements a counter of the given name by "decrement"
    
    Parameters:
    
    name -
    
    decrement -
    
    Returns:
  - addGauge
```
void addGauge(String name,
              MetricsVariable<?> variable)
```
    Adds a metrics-gauge to track variable. For example, number of open database connections.
    
    Parameters:
    
    name - name of gauge
    
    variable - variable to track.
  - removeGauge
```
void removeGauge(String name)
```
    Removed the gauge added by addGauge.
    
    Parameters:
    
    name - name of gauge
  - addRatio
```
void addRatio(String name,
              MetricsVariable<Integer> numerator,
              MetricsVariable<Integer> denominator)
```
    Add a ratio metric to track the correlation between two variables
    
    Parameters:
    
    name - name of the ratio gauge
    
    numerator - numerator of the ratio
    
    denominator - denominator of the ratio
  - markMeter
```
void markMeter(String name)
```
    Mark an event occurrence for a meter. Meters measure the rate of an event and track 1/5/15 minute moving averages
    
    Parameters:
    
    name - name of the meter

Interface Metrics

Method Summary

Method Detail

close

startStoredScope

endStoredScope

createScope

endScope

incrementCounter

incrementCounter

decrementCounter

decrementCounter

addGauge

removeGauge

addRatio

markMeter