MetricsService (Lens 2.7.1 API)

All Superinterfaces:

HealthCheckable, LensService

All Known Implementing Classes:

MetricsServiceImpl
```
public interface MetricsService
extends LensService
```
The Interface MetricsService.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPTED_QUERIES` The Constant ACCEPTED_QUERIES.
`static String`	`ACTIVE_SESSIONS`
`static String`	`CANCELLED_QUERIES` Query engine counter names.
`static String`	`CLOSED_SESSIONS`
`static String`	`EXPIRED_SESSIONS`
`static String`	`FAILED_QUERIES` The Constant FAILED_QUERIES.
`static String`	`FINISHED_QUERIES` The Constant FINISHED_QUERIES.
`static String`	`LAUNCHING_QUERIES`
`static String`	`NAME` The Constant NAME.
`static String`	`OPENED_SESSIONS`
`static String`	`QUEUED_QUERIES` Query engine gauge names.
`static String`	`RUNNING_QUERIES` The Constant RUNNING_QUERIES.
`static String`	`WAITING_QUERIES` The Constant WAITING_QUERIES.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`decrCounter(Class<?> cls, String counter)` Decrement a counter with the name costructed using given class and counter name Actual name of the counter will be
`void`	`decrCounter(String counter)` Decrement a counter with the given name Actual name of the counter will be
`int`	`getActiveSessions()` Specifies the count of all opened sessions which are not closed after restarted and the restored sessions
`long`	`getCounter(Class<?> cls, String counter)` Get current value of the counter.
`long`	`getCounter(String counter)` Get current value of the counter.
`long`	`getFinishedQueries()`
`MethodMetricsContext`	`getMethodMetricsContext(org.glassfish.jersey.server.model.ResourceMethod method, org.glassfish.jersey.server.ContainerRequest containerRequest)` API method for getting metrics measuring context for given resource method and container request
`long`	`getQueuedQueries()`
`long`	`getRunningQueries()`
`long`	`getTotalAcceptedQueries()`
`long`	`getTotalCancelledQueries()`
`long`	`getTotalClosedSessions()` Specifies the number of sessions closed
`long`	`getTotalDatabaseResourceLoadErrors()`
`long`	`getTotalExpiredSessions()` Specifies the number of sessions were idle for more than session timeout
`long`	`getTotalFailedQueries()`
`long`	`getTotalFinishedQueries()`
`long`	`getTotalOpenedSessions()` Specifies the count of opened sessions
`long`	`getTotalServerStatePersistenceErrors()`
`long`	`getTotalSuccessfulQueries()`
`long`	`getWaitingQueries()`
`void`	`incrCounter(Class<?> cls, String counter)` Increment a counter with the name constructed using given class and counter name Actual name of the counter will be
`void`	`incrCounter(String counter)` Increment a counter with the given name Actual name of the counter will be
`void`	`publishReport()` Publish report.

Methods inherited from interface org.apache.lens.server.api.health.HealthCheckable
getHealthStatus

- Field Detail
  - NAME
```
static final String NAME
```
    The Constant NAME.
    
    See Also:
    
    Constant Field Values
  - CANCELLED_QUERIES
```
static final String CANCELLED_QUERIES
```
    Query engine counter names.
    
    See Also:
    
    Constant Field Values
  - FAILED_QUERIES
```
static final String FAILED_QUERIES
```
    The Constant FAILED_QUERIES.
    
    See Also:
    
    Constant Field Values
  - ACCEPTED_QUERIES
```
static final String ACCEPTED_QUERIES
```
    The Constant ACCEPTED_QUERIES.
    
    See Also:
    
    Constant Field Values
  - QUEUED_QUERIES
```
static final String QUEUED_QUERIES
```
    Query engine gauge names.
    
    See Also:
    
    Constant Field Values
  - RUNNING_QUERIES
```
static final String RUNNING_QUERIES
```
    The Constant RUNNING_QUERIES.
    
    See Also:
    
    Constant Field Values
  - WAITING_QUERIES
```
static final String WAITING_QUERIES
```
    The Constant WAITING_QUERIES.
    
    See Also:
    
    Constant Field Values
  - LAUNCHING_QUERIES
```
static final String LAUNCHING_QUERIES
```
    See Also:
    
    Constant Field Values
  - FINISHED_QUERIES
```
static final String FINISHED_QUERIES
```
    The Constant FINISHED_QUERIES.
    
    See Also:
    
    Constant Field Values
  - OPENED_SESSIONS
```
static final String OPENED_SESSIONS
```
    See Also:
    
    Constant Field Values
  - CLOSED_SESSIONS
```
static final String CLOSED_SESSIONS
```
    See Also:
    
    Constant Field Values
  - EXPIRED_SESSIONS
```
static final String EXPIRED_SESSIONS
```
    See Also:
    
    Constant Field Values
  - ACTIVE_SESSIONS
```
static final String ACTIVE_SESSIONS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - incrCounter
```
void incrCounter(String counter)
```
    Increment a counter with the given name Actual name of the counter will be
```
MetricRegistry.name(MetricsService.class, counter)
```
    Parameters:
    
    counter - the counter
  - incrCounter
```
void incrCounter(Class<?> cls,
                 String counter)
```
    Increment a counter with the name constructed using given class and counter name Actual name of the counter will be
```
MetricRegistry.name(cls, counter)
```
    Parameters:
    
    cls - Class of the counter for namespacing the counter
    
    counter - the counter
  - decrCounter
```
void decrCounter(Class<?> cls,
                 String counter)
```
    Decrement a counter with the name costructed using given class and counter name Actual name of the counter will be
```
MetricRegistry.name(cls, counter)
```
    Parameters:
    
    cls - Class of the counter for namespacing of counters
    
    counter - the counter
  - decrCounter
```
void decrCounter(String counter)
```
    Decrement a counter with the given name Actual name of the counter will be
```
MetricRegistry.name(MetricsService.class, counter)
```
    Parameters:
    
    counter - the counter
  - getCounter
```
long getCounter(String counter)
```
    Get current value of the counter.
    
    Parameters:
    
    counter - the counter
    
    Returns:
    
    the counter
  - getCounter
```
long getCounter(Class<?> cls,
                String counter)
```
    Get current value of the counter.
    
    Parameters:
    
    cls - the cls
    
    counter - the counter
    
    Returns:
    
    the counter
  - getTotalDatabaseResourceLoadErrors
```
long getTotalDatabaseResourceLoadErrors()
```
  - getQueuedQueries
```
long getQueuedQueries()
```
  - getRunningQueries
```
long getRunningQueries()
```
  - getWaitingQueries
```
long getWaitingQueries()
```
  - getFinishedQueries
```
long getFinishedQueries()
```
  - getTotalAcceptedQueries
```
long getTotalAcceptedQueries()
```
  - getTotalSuccessfulQueries
```
long getTotalSuccessfulQueries()
```
  - getTotalFinishedQueries
```
long getTotalFinishedQueries()
```
  - getTotalCancelledQueries
```
long getTotalCancelledQueries()
```
  - getTotalFailedQueries
```
long getTotalFailedQueries()
```
  - getTotalServerStatePersistenceErrors
```
long getTotalServerStatePersistenceErrors()
```
  - publishReport
```
void publishReport()
```
    Publish report.
  - getMethodMetricsContext
```
MethodMetricsContext getMethodMetricsContext(org.glassfish.jersey.server.model.ResourceMethod method,
                                             org.glassfish.jersey.server.ContainerRequest containerRequest)
```
    API method for getting metrics measuring context for given resource method and container request
    
    Parameters:
    
    method - the resource method
    
    containerRequest - container request
    
    Returns:
    
    method metrics context.
    
    See Also:
    
    ContainerRequest, ResourceMethod, MethodMetricsContext
  - getTotalOpenedSessions
```
long getTotalOpenedSessions()
```
    Specifies the count of opened sessions
  - getTotalClosedSessions
```
long getTotalClosedSessions()
```
    Specifies the number of sessions closed
  - getTotalExpiredSessions
```
long getTotalExpiredSessions()
```
    Specifies the number of sessions were idle for more than session timeout
  - getActiveSessions
```
int getActiveSessions()
```
    Specifies the count of all opened sessions which are not closed after restarted and the restored sessions

Interface MetricsService

Field Summary

Method Summary

Methods inherited from interface org.apache.lens.server.api.health.HealthCheckable

Field Detail

NAME

CANCELLED_QUERIES

FAILED_QUERIES

ACCEPTED_QUERIES

QUEUED_QUERIES

RUNNING_QUERIES

WAITING_QUERIES

LAUNCHING_QUERIES

FINISHED_QUERIES

OPENED_SESSIONS

CLOSED_SESSIONS

EXPIRED_SESSIONS

ACTIVE_SESSIONS

Method Detail

incrCounter

incrCounter

decrCounter

decrCounter

getCounter

getCounter

getTotalDatabaseResourceLoadErrors

getQueuedQueries

getRunningQueries

getWaitingQueries

getFinishedQueries

getTotalAcceptedQueries

getTotalSuccessfulQueries

getTotalFinishedQueries

getTotalCancelledQueries

getTotalFailedQueries

getTotalServerStatePersistenceErrors

publishReport

getMethodMetricsContext

getTotalOpenedSessions

getTotalClosedSessions

getTotalExpiredSessions

getActiveSessions