CodahaleMetricsContext (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.metrics.codahale.CodahaleMetricsContext

All Implemented Interfaces:: Closeable, AutoCloseable, MetricsContext

public class CodahaleMetricsContext
extends Object
implements MetricsContext, Closeable

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`baseName`
`protected Timer`	`checkedApplicationFaults`
`protected Meter`	`incomingData`
`protected Counter`	`inFlight`
`protected Timer`	`logicalRuntimeFaults`
`protected Meter`	`outgoingData`
`protected MetricRegistry`	`registry`
`protected Timer`	`runtimeFaults`
`protected Timer`	`totals`
`protected Timer`	`uncheckedApplicationFaults`

Constructor Summary

Constructors
Constructor and Description

CodahaleMetricsContext(String prefix, MetricRegistry registry)

Constructors
Constructor and Description
`CodahaleMetricsContext(String prefix, MetricRegistry registry)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`String`	`getBaseName()`
`Timer`	`getCheckedApplicationFaults()`
`Meter`	`getIncomingData()`
`Counter`	`getInFlight()`
`Timer`	`getLogicalRuntimeFaults()`
`Meter`	`getOutgoingData()`
`MetricRegistry`	`getRegistry()`
`Timer`	`getRuntimeFaults()`
`Timer`	`getTotals()`
`Timer`	`getUncheckedApplicationFaults()`
`void`	`start(Exchange ex)` Will be called at the start of invoke (or when added to a started MessageMetrics).
`void`	`stop(long timeInNS, long inSize, long outSize, Exchange ex)` Called when the invocation is complete.

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

Field Detail

inFlight
```
protected Counter inFlight
```

totals
```
protected Timer totals
```

uncheckedApplicationFaults

protected Timer uncheckedApplicationFaults

checkedApplicationFaults

protected Timer checkedApplicationFaults

runtimeFaults
```
protected Timer runtimeFaults
```

logicalRuntimeFaults
```
protected Timer logicalRuntimeFaults
```

incomingData
```
protected Meter incomingData
```

outgoingData
```
protected Meter outgoingData
```

baseName
```
protected final String baseName
```

registry

protected final MetricRegistry registry

Constructor Detail

CodahaleMetricsContext

public CodahaleMetricsContext(String prefix,
                      MetricRegistry registry)

Method Detail
- close
```
public void close()
           throws IOException
```
  Specified by:
  
  close in interface Closeable
  
  Specified by:
  
  close in interface AutoCloseable
  
  Throws:
  
  IOException
- start
```
public void start(Exchange ex)
```
  Description copied from interface: MetricsContext
  
  Will be called at the start of invoke (or when added to a started MessageMetrics). This is when the metrics should increment "inFlight" counts and other stats. There is no need to record a "start time" as the invoke time will be passed into the stop method.
  
  Specified by:
  
  start in interface MetricsContext
- stop
```
public void stop(long timeInNS,
        long inSize,
        long outSize,
        Exchange ex)
```
  Description copied from interface: MetricsContext
  
  Called when the invocation is complete.
  
  Specified by:
  
  stop in interface MetricsContext
- getInFlight
```
public Counter getInFlight()
```
- getTotals
```
public Timer getTotals()
```
- getUncheckedApplicationFaults
```
public Timer getUncheckedApplicationFaults()
```
- getCheckedApplicationFaults
```
public Timer getCheckedApplicationFaults()
```
- getRuntimeFaults
```
public Timer getRuntimeFaults()
```
- getLogicalRuntimeFaults
```
public Timer getLogicalRuntimeFaults()
```
- getIncomingData
```
public Meter getIncomingData()
```
- getOutgoingData
```
public Meter getOutgoingData()
```
- getBaseName
```
public String getBaseName()
```
- getRegistry
```
public MetricRegistry getRegistry()
```

Class CodahaleMetricsContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inFlight

totals

uncheckedApplicationFaults

checkedApplicationFaults

runtimeFaults

logicalRuntimeFaults

incomingData

outgoingData

baseName

registry

Constructor Detail

CodahaleMetricsContext

Method Detail

close

start

stop

getInFlight

getTotals

getUncheckedApplicationFaults

getCheckedApplicationFaults

getRuntimeFaults

getLogicalRuntimeFaults

getIncomingData

getOutgoingData

getBaseName

getRegistry