Module io.helidon.dbclient.metrics

Package io.helidon.dbclient.metrics

Class DbMetricBuilder<T extends DbMetricBuilder<T>>

java.lang.Object

io.helidon.dbclient.metrics.DbMetricBuilder<T>

Type Parameters:

T - type of the builder extending this class

Direct Known Subclasses:

DbCounter.Builder, DbMeter.Builder, DbTimer.Builder

public abstract class DbMetricBuilder<T extends DbMetricBuilder<T>>
extends Object

A metric builder used as a base for Helidon DB metrics.

Constructor Summary

Constructors

Constructor	Description
DbMetricBuilder()

Method Summary

Modifier and Type	Method	Description
T	config(Config config)	Configure a metric from configuration.
T	description(String description)	Description of the metric used in metric metadata.
T	measureErrors(boolean shouldWe)	Whether to measure failed statements.
T	measureSuccess(boolean shouldWe)	Whether to measure successful statements.
T	metadata(org.eclipse.microprofile.metrics.Metadata meta)	Configure metric metadata.
T	name(String metricName)	Configure a metric name.
T	nameFormat(String format)	Configure a name format.
T	nameFormat(BiFunction<String,DbStatementType,String> function)	Configure a name format function.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbMetricBuilder

public DbMetricBuilder()

Method Detail

name

public T name(String metricName)

Configure a metric name.

Parameters:

metricName - name of the metric

Returns:

updated builder instance

metadata

public T metadata(org.eclipse.microprofile.metrics.Metadata meta)

Configure metric metadata.

Parameters:

meta - metric metadata

Returns:

updated builder instance

nameFormat

public T nameFormat(String format)

Configure a name format.

The format can use up to two parameters - first is the statement name, second the DbStatementType as a string.

Parameters:

format - format string expecting zero to two parameters that can be processed by String.format(String, Object...)

Returns:

updated builder instance

nameFormat

public T nameFormat(BiFunction<String,DbStatementType,String> function)

Configure a name format function.

The first parameter is the statement name.

Parameters:

function - function to use to create metric name

Returns:

updated builder instance

measureErrors

public T measureErrors(boolean shouldWe)

Whether to measure failed statements.

Parameters:

shouldWe - set to false if errors should be ignored

Returns:

updated builder instance

measureSuccess

public T measureSuccess(boolean shouldWe)

Whether to measure successful statements.

Parameters:

shouldWe - set to false if successes should be ignored

Returns:

updated builder instance

description

public T description(String description)

Description of the metric used in metric metadata.

Parameters:

description - description

Returns:

updated builder instance

config

public T config(Config config)

Configure a metric from configuration. The following configuration key are used:

DB Metric configuration options

key	default	description
errors	true	Whether this metric triggers for error states
success	true	Whether this metric triggers for successful executions
name-format	db.metric-type.statement-name	A string format used to construct a metric name. The format gets two parameters: the statement name and the statement type
description		Description of this metric, used in metric Metadata

Parameters:

config - configuration to configure this metric

Returns:

updated builder instance