PerfLogger (Hive 4.0.0-beta-1 API)

java.lang.Object
- org.apache.hadoop.hive.metastore.metrics.PerfLogger

```
public class PerfLogger
extends Object
```
PerfLogger. Can be used to measure and log the time spent by a piece of code.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Long>`	`endTimes`
`static String`	`GET_AGGR_COL_STATS`
`static String`	`GET_AGGR_COL_STATS_2`
`static String`	`GET_CONFIG_VAL`
`static String`	`GET_DATABASE`
`static String`	`GET_FK`
`static String`	`GET_NOT_NULL_CONSTRAINTS`
`static String`	`GET_PK`
`static String`	`GET_TABLE`
`static String`	`GET_TABLE_2`
`static String`	`GET_TABLE_COL_STATS`
`static String`	`GET_TABLE_COL_STATS_2`
`static String`	`GET_UNIQ_CONSTRAINTS`
`static String`	`LIST_PARTS_BY_EXPR`
`static String`	`LIST_PARTS_SPECS_BY_EXPR`
`static String`	`LIST_PARTS_WITH_AUTH_INFO`
`static String`	`LIST_PARTS_WITH_AUTH_INFO_2`
`protected static ThreadLocal<PerfLogger>`	`perfLogger`
`protected Map<String,Long>`	`startTimes`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanupPerfLogMetrics()` Cleans up any dangling perfLog metric call scopes.
`boolean`	`endTimeHasMethod(String method)`
`Long`	`getDuration(String method)`
`Long`	`getEndTime(String method)`
`com.google.common.collect.ImmutableMap<String,Long>`	`getEndTimes()`
`static PerfLogger`	`getPerfLogger(boolean resetPerfLogger)` Get the singleton PerfLogger instance.
`Long`	`getStartTime(String method)`
`com.google.common.collect.ImmutableMap<String,Long>`	`getStartTimes()`
`void`	`perfLogBegin(String callerName, String method)` Call this function when you start to measure time spent by a piece of code.
`long`	`perfLogEnd(String callerName, String method)` Call this function in correspondence of PerfLogBegin to mark the end of the measurement.
`long`	`perfLogEnd(String callerName, String method, String additionalInfo)` Call this function in correspondence of PerfLogBegin to mark the end of the measurement.
`static void`	`setPerfLogger(PerfLogger resetPerfLogger)`
`boolean`	`startTimeHasMethod(String method)`

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

- Field Detail
  - startTimes
```
protected final Map<String,Long> startTimes
```
  - endTimes
```
protected final Map<String,Long> endTimes
```
  - perfLogger
```
protected static final ThreadLocal<PerfLogger> perfLogger
```
  - GET_AGGR_COL_STATS
```
public static final String GET_AGGR_COL_STATS
```
    See Also:
    
    Constant Field Values
  - GET_AGGR_COL_STATS_2
```
public static final String GET_AGGR_COL_STATS_2
```
    See Also:
    
    Constant Field Values
  - LIST_PARTS_WITH_AUTH_INFO
```
public static final String LIST_PARTS_WITH_AUTH_INFO
```
    See Also:
    
    Constant Field Values
  - LIST_PARTS_WITH_AUTH_INFO_2
```
public static final String LIST_PARTS_WITH_AUTH_INFO_2
```
    See Also:
    
    Constant Field Values
  - LIST_PARTS_BY_EXPR
```
public static final String LIST_PARTS_BY_EXPR
```
    See Also:
    
    Constant Field Values
  - LIST_PARTS_SPECS_BY_EXPR
```
public static final String LIST_PARTS_SPECS_BY_EXPR
```
    See Also:
    
    Constant Field Values
  - GET_DATABASE
```
public static final String GET_DATABASE
```
    See Also:
    
    Constant Field Values
  - GET_TABLE
```
public static final String GET_TABLE
```
    See Also:
    
    Constant Field Values
  - GET_TABLE_2
```
public static final String GET_TABLE_2
```
    See Also:
    
    Constant Field Values
  - GET_PK
```
public static final String GET_PK
```
    See Also:
    
    Constant Field Values
  - GET_FK
```
public static final String GET_FK
```
    See Also:
    
    Constant Field Values
  - GET_UNIQ_CONSTRAINTS
```
public static final String GET_UNIQ_CONSTRAINTS
```
    See Also:
    
    Constant Field Values
  - GET_NOT_NULL_CONSTRAINTS
```
public static final String GET_NOT_NULL_CONSTRAINTS
```
    See Also:
    
    Constant Field Values
  - GET_TABLE_COL_STATS
```
public static final String GET_TABLE_COL_STATS
```
    See Also:
    
    Constant Field Values
  - GET_TABLE_COL_STATS_2
```
public static final String GET_TABLE_COL_STATS_2
```
    See Also:
    
    Constant Field Values
  - GET_CONFIG_VAL
```
public static final String GET_CONFIG_VAL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getPerfLogger
```
public static PerfLogger getPerfLogger(boolean resetPerfLogger)
```
    Get the singleton PerfLogger instance.
    
    Parameters:
    
    resetPerfLogger - if false, get the current PerfLogger, or create a new one if a current one does not exist. If true, a new instance of PerfLogger will be returned rather than the existing one. Note that the existing PerfLogger is not shutdown and any object which already has a reference to it may continue to use it. But all future calls to this method with this set to false will get the new PerfLogger instance.
    
    Returns:
    
    a PerfLogger
  - setPerfLogger
```
public static void setPerfLogger(PerfLogger resetPerfLogger)
```
  - perfLogBegin
```
public void perfLogBegin(String callerName,
                         String method)
```
    Call this function when you start to measure time spent by a piece of code.
    
    Parameters:
    
    callerName - the logging object to be used.
    
    method - method or ID that identifies this perf log element.
  - perfLogEnd
```
public long perfLogEnd(String callerName,
                       String method)
```
    Call this function in correspondence of PerfLogBegin to mark the end of the measurement.
    
    Parameters:
    
    callerName -
    
    method -
    
    Returns:
    
    long duration the difference between now and startTime, or -1 if startTime is null
  - perfLogEnd
```
public long perfLogEnd(String callerName,
                       String method,
                       String additionalInfo)
```
    Call this function in correspondence of PerfLogBegin to mark the end of the measurement.
    
    Parameters:
    
    callerName -
    
    method -
    
    Returns:
    
    long duration the difference between now and startTime, or -1 if startTime is null
  - getStartTime
```
public Long getStartTime(String method)
```
  - getEndTime
```
public Long getEndTime(String method)
```
  - startTimeHasMethod
```
public boolean startTimeHasMethod(String method)
```
  - endTimeHasMethod
```
public boolean endTimeHasMethod(String method)
```
  - getDuration
```
public Long getDuration(String method)
```
  - getStartTimes
```
public com.google.common.collect.ImmutableMap<String,Long> getStartTimes()
```
  - getEndTimes
```
public com.google.common.collect.ImmutableMap<String,Long> getEndTimes()
```
  - cleanupPerfLogMetrics
```
public void cleanupPerfLogMetrics()
```
    Cleans up any dangling perfLog metric call scopes.

Class PerfLogger

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startTimes

endTimes

perfLogger

GET_AGGR_COL_STATS

GET_AGGR_COL_STATS_2

LIST_PARTS_WITH_AUTH_INFO

LIST_PARTS_WITH_AUTH_INFO_2

LIST_PARTS_BY_EXPR

LIST_PARTS_SPECS_BY_EXPR

GET_DATABASE

GET_TABLE

GET_TABLE_2

GET_PK

GET_FK

GET_UNIQ_CONSTRAINTS

GET_NOT_NULL_CONSTRAINTS

GET_TABLE_COL_STATS

GET_TABLE_COL_STATS_2

GET_CONFIG_VAL

Method Detail

getPerfLogger

setPerfLogger

perfLogBegin

perfLogEnd

perfLogEnd

getStartTime

getEndTime

startTimeHasMethod

endTimeHasMethod

getDuration

getStartTimes

getEndTimes

cleanupPerfLogMetrics