Module io.helidon.dbclient.metrics

Package io.helidon.dbclient.metrics

Class DbTimer

java.lang.Object

io.helidon.dbclient.metrics.DbTimer

All Implemented Interfaces:

DbInterceptor

public final class DbTimer
extends Object

Timer metric for Helidon DB. This class implements the DbInterceptor and can be configured either through a DbClient.Builder or through configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DbTimer.Builder	Fluent API builder for DbTimer.

Method Summary

Modifier and Type	Method	Description
static DbTimer.Builder	builder()	Create a new fluent API builder to create a new timer metric.
static DbTimer	create()	Create a new timer using default configuration.
static DbTimer	create(Config config)	Create a timer from configuration.
protected String	defaultNamePrefix()
protected void	executeMetric(org.eclipse.microprofile.metrics.Timer metric, CompletionStage<Void> aFuture)
protected boolean	measureErrors()
protected boolean	measureSuccess()
protected org.eclipse.microprofile.metrics.Timer	metric(org.eclipse.microprofile.metrics.MetricRegistry registry, org.eclipse.microprofile.metrics.Metadata meta)
protected org.eclipse.microprofile.metrics.MetricType	metricType()
CompletableFuture<DbInterceptorContext>	statement(DbInterceptorContext interceptorContext)	Statement execution to be intercepted.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DbTimer create(Config config)

Create a timer from configuration.

Parameters:

config - configuration to read

Returns:

a new timer

See Also:

DbMetricBuilder.config(io.helidon.config.Config)

create

public static DbTimer create()

Create a new timer using default configuration.

By default the name format is db.timer.statement-name, where statement-name is provided at runtime.

Returns:

a new timer

builder

public static DbTimer.Builder builder()

Create a new fluent API builder to create a new timer metric.

Returns:

a new builder instance

executeMetric

protected void executeMetric(org.eclipse.microprofile.metrics.Timer metric,
                             CompletionStage<Void> aFuture)

defaultNamePrefix

protected String defaultNamePrefix()

metricType

protected org.eclipse.microprofile.metrics.MetricType metricType()

metric

protected org.eclipse.microprofile.metrics.Timer metric(org.eclipse.microprofile.metrics.MetricRegistry registry,
                                                        org.eclipse.microprofile.metrics.Metadata meta)

statement

public CompletableFuture<DbInterceptorContext> statement(DbInterceptorContext interceptorContext)

Description copied from interface: DbInterceptor

Statement execution to be intercepted. This method is called before the statement execution starts.

Specified by:

statement in interface DbInterceptor

Parameters:

interceptorContext - Context to access data needed to process an interceptor

Returns:

completion stage that completes when this interceptor is finished

measureErrors

protected boolean measureErrors()

measureSuccess

protected boolean measureSuccess()