Package com.google.cloud.bigtable.metrics

Class BigtableClientMetrics

java.lang.Object

com.google.cloud.bigtable.metrics.BigtableClientMetrics

public final class BigtableClientMetrics
extends Object

Singleton Container for a MetricRegistry. The default behavior is to return implementations that do nothing. Exporting of metrics can be turned on by either adding TRACE level logging for this class, which will write out all metrics to a log file. Alternatively, call setMetricRegistry(MetricRegistry).

We provide a DropwizardMetricRegistry which can be configured with a variety of Reporters as per the instructions on the Dropwizards Metrics Getting Started docs.

setMetricRegistry(MetricRegistry) must be called before any Cloud Bigtable connections are created.

Version:

$Id: $Id

Author:

sduskis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BigtableClientMetrics.MetricLevel

Method Summary

Modifier and Type	Method	Description
static Counter	counter(BigtableClientMetrics.MetricLevel level, String name)	Creates a named Counter.
static BigtableClientMetrics.MetricLevel	getLevelToLog()
static MetricRegistry	getMetricRegistry(BigtableClientMetrics.MetricLevel level)
static boolean	isEnabled(BigtableClientMetrics.MetricLevel level)	Checks if a BigtableClientMetrics.MetricLevel is enabled;
static Meter	meter(BigtableClientMetrics.MetricLevel level, String name)	Creates a named Meter.
static void	setLevelToLog(BigtableClientMetrics.MetricLevel levelToLog)	Set a level at which to log.
static void	setMetricRegistry(MetricRegistry registry)	Sets a MetricRegistry to be used in all Bigtable connection created after the call.
static Timer	timer(BigtableClientMetrics.MetricLevel level, String name)	Creates a named Timer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setMetricRegistry

public static void setMetricRegistry(MetricRegistry registry)

Sets a MetricRegistry to be used in all Bigtable connection created after the call. NOTE: this will not update any existing connections.

Parameters:

registry -

getMetricRegistry

public static MetricRegistry getMetricRegistry(BigtableClientMetrics.MetricLevel level)

counter

public static Counter counter(BigtableClientMetrics.MetricLevel level,
                              String name)

Creates a named Counter. This is a shortcut for getMetricRegistry(MetricLevel). MetricRegistry.counter(String).

Returns:

a Counter

timer

public static Timer timer(BigtableClientMetrics.MetricLevel level,
                          String name)

Creates a named Timer. This is a shortcut for getMetricRegistry(MetricLevel). MetricRegistry.timer(String).

Returns:

a Timer

meter

public static Meter meter(BigtableClientMetrics.MetricLevel level,
                          String name)

Creates a named Meter. This is a shortcut for getMetricRegistry(MetricLevel). MetricRegistry.meter(String).

Returns:

a Meter

setLevelToLog

public static void setLevelToLog(BigtableClientMetrics.MetricLevel levelToLog)

Set a level at which to log. By default, the value is BigtableClientMetrics.MetricLevel.Info.

Parameters:

levelToLog -

getLevelToLog

public static BigtableClientMetrics.MetricLevel getLevelToLog()

Returns:

the levelToLog

isEnabled

public static boolean isEnabled(BigtableClientMetrics.MetricLevel level)

Checks if a BigtableClientMetrics.MetricLevel is enabled;

Parameters:

level - the BigtableClientMetrics.MetricLevel to check

Returns:

true if the level is enabled.