LegacyMetrics (Hive 3.1.1 API)

java.lang.Object
- org.apache.hadoop.hive.common.metrics.LegacyMetrics

All Implemented Interfaces:

Metrics
```
public class LegacyMetrics
extends Object
implements Metrics
```
This class may eventually get superseded by org.apache.hadoop.hive.common.metrics2.Metrics. Metrics Subsystem - allows exposure of a number of named parameters/counters via jmx, intended to be used as a static subsystem Has a couple of primary ways it can be used: (i) Using the set and get methods to set and get named parameters (ii) Using the incrementCounter method to increment and set named parameters in one go, rather than having to make a get and then a set. (iii) Using the startScope and endScope methods to start and end named "scopes" that record the number of times they've been instantiated and amount of time(in milliseconds) spent inside the scopes.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LegacyMetrics.LegacyMetricsScope
MetricsScope : A class that encapsulates an idea of a metered scope.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LegacyMetrics.LegacyMetricsScope` MetricsScope : A class that encapsulates an idea of a metered scope.

Constructor Summary

Constructors
Constructor and Description

LegacyMetrics(HiveConf conf)

Constructors
Constructor and Description
`LegacyMetrics(HiveConf conf)`

Method Summary

All Methods Instance Methods Concrete 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()` Resets the static context state to initial.
`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.
`Object`	`get(String name)`
`MetricsScope`	`getStoredScope(String 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 occurance for a meter.
`void`	`removeGauge(String name)` Removed the gauge added by addGauge.
`void`	`set(String name, Object value)`
`void`	`startStoredScope(String name)`

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

- Constructor Detail
  - LegacyMetrics
```
public LegacyMetrics(HiveConf conf)
              throws Exception
```
    Throws:
    
    Exception
- Method Detail
  - incrementCounter
```
public Long incrementCounter(String name)
```
    Description copied from interface: Metrics
    
    Increments a counter of the given name by 1.
    
    Specified by:
    
    incrementCounter in interface Metrics
    
    Returns:
  - incrementCounter
```
public Long incrementCounter(String name,
                             long increment)
```
    Description copied from interface: Metrics
    
    Increments a counter of the given name by "increment"
    
    Specified by:
    
    incrementCounter in interface Metrics
    
    Returns:
  - decrementCounter
```
public Long decrementCounter(String name)
```
    Description copied from interface: Metrics
    
    Decrements a counter of the given name by 1.
    
    Specified by:
    
    decrementCounter in interface Metrics
    
    Returns:
  - decrementCounter
```
public Long decrementCounter(String name,
                             long decrement)
```
    Description copied from interface: Metrics
    
    Decrements a counter of the given name by "decrement"
    
    Specified by:
    
    decrementCounter in interface Metrics
    
    Returns:
  - addGauge
```
public void addGauge(String name,
                     MetricsVariable variable)
```
    Description copied from interface: Metrics
    
    Adds a metrics-gauge to track variable. For example, number of open database connections.
    
    Specified by:
    
    addGauge in interface Metrics
    
    Parameters:
    
    name - name of gauge
    
    variable - variable to track.
  - removeGauge
```
public void removeGauge(String name)
```
    Description copied from interface: Metrics
    
    Removed the gauge added by addGauge.
    
    Specified by:
    
    removeGauge in interface Metrics
    
    Parameters:
    
    name - name of gauge
  - addRatio
```
public void addRatio(String name,
                     MetricsVariable<Integer> numerator,
                     MetricsVariable<Integer> denominator)
```
    Description copied from interface: Metrics
    
    Add a ratio metric to track the correlation between two variables
    
    Specified by:
    
    addRatio in interface Metrics
    
    Parameters:
    
    name - name of the ratio gauge
    
    numerator - numerator of the ratio
    
    denominator - denominator of the ratio
  - markMeter
```
public void markMeter(String name)
```
    Description copied from interface: Metrics
    
    Mark an event occurance for a meter. Meters measure the rate of an event and track 1/5/15 minute moving averages
    
    Specified by:
    
    markMeter in interface Metrics
    
    Parameters:
    
    name - name of the meter
  - set
```
public void set(String name,
                Object value)
```
  - get
```
public Object get(String name)
           throws JMException
```
    Throws:
    
    JMException
  - startStoredScope
```
public void startStoredScope(String name)
```
    Specified by:
    
    startStoredScope in interface Metrics
    
    Parameters:
    
    name - starts a scope of a given name. Scopes is stored as thread-local variable.
  - getStoredScope
```
public MetricsScope getStoredScope(String name)
                            throws IllegalStateException
```
    Throws:
    
    IllegalStateException
  - endStoredScope
```
public void endStoredScope(String name)
```
    Description copied from interface: Metrics
    
    Closes the stored scope of a given name. Note that this must be called on the same thread as where the scope was started.
    
    Specified by:
    
    endStoredScope in interface Metrics
  - createScope
```
public MetricsScope createScope(String name)
```
    Description copied from interface: Metrics
    
    Create scope with given name and returns it.
    
    Specified by:
    
    createScope in interface Metrics
    
    Returns:
  - endScope
```
public void endScope(MetricsScope scope)
```
    Description copied from interface: Metrics
    
    Close the given scope.
    
    Specified by:
    
    endScope in interface Metrics
  - close
```
public void close()
           throws Exception
```
    Resets the static context state to initial. Used primarily for testing purposes. Note that threadLocalScopes ThreadLocal is *not* cleared in this call.
    
    Specified by:
    
    close in interface Metrics
    
    Throws:
    
    Exception

Class LegacyMetrics

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LegacyMetrics

Method Detail

incrementCounter

incrementCounter

decrementCounter

decrementCounter

addGauge

removeGauge

addRatio

markMeter

set

get

startStoredScope

getStoredScope

endStoredScope

createScope

endScope

close