BigtableClientMetrics (Cloud Bigtable HBase Client for Java 1.12.0 API)

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 and Description

static class BigtableClientMetrics.MetricLevel

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and 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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-02-15 UTC.

BigtableClientMetrics (Cloud Bigtable HBase Client for Java 1.12.0 API)

Class BigtableClientMetrics

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setMetricRegistry

getMetricRegistry

counter

timer

meter

setLevelToLog

getLevelToLog

isEnabled