Class DbClientMetricBuilder<B extends DbClientMetricBuilder<B,T>, T extends DbClientServiceBase>

java.lang.Object

io.helidon.dbclient.DbClientServiceBase.BuilderBase<B,T>

io.helidon.dbclient.metrics.DbClientMetricBuilder<B,T>

Type Parameters:

B - type of the builder extending this class

T - Type of the built DbClientServiceBase instance

All Implemented Interfaces:

Builder<B,T>, Supplier<T>

public abstract class DbClientMetricBuilder<B extends DbClientMetricBuilder<B,T>, T extends DbClientServiceBase>
extends DbClientServiceBase.BuilderBase<B,T>

Database Client metric builder.

Constructor Summary

Constructors

Constructor	Description
DbClientMetricBuilder()	Deprecated, for removal: This API element is subject to removal in a future version. direct public use is not supported; use DbClientMetrics.counter() or DbClientMetrics.timer() for the built-in metric builders

Method Summary

Modifier and Type	Method	Description
B	config(Config config)	Configure a metric from configuration.
B	description(String description)	Description of the metric used in metric metadata.
B	errors(boolean measureErrors)	Whether to measure failed statements.
B	metadata(io.helidon.dbclient.metrics.MeterMetadata meta)	Configure metric metadata.
B	name(String metricName)	Configure a metric name.
B	nameFormat(String format)	Configure a name format.
B	nameFormat(BiFunction<String, DbStatementType, String> function)	Configure a name format function.
B	success(boolean measureSuccess)	Whether to measure successful statements.

Methods inherited from class DbClientServiceBase.BuilderBase

enabled, predicate, statementNames, statementNames, statementNames, statementPredicate, statementTypes, statementTypes, statementTypes

Modifier and Type	Method	Description
void	enabled(boolean enabled)	Configure whether this service is enabled or not.
protected Predicate<DbClientServiceContext>	predicate()	Predicate used to build a client service.
protected Set<String>	statementNames()	Set of statement name patterns.
B	statementNames(String... names)	Configure statement name patterns this service will be triggered for.
protected B	statementNames(List<String> names)	Configures statement name patterns from configuration.
B	statementPredicate(Predicate<DbClientServiceContext> predicate)	Configure a predicate whose result will be used to decide whether to trigger this service or not.
protected Set<DbStatementType>	statementTypes()	Set of statement types.
B	statementTypes(DbStatementType... types)	Configure statement types this service will be triggered for.
protected B	statementTypes(List<DbStatementType> types)	Configures statement types from configuration.

Methods inherited from class Object

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

Methods inherited from interface Builder

build, get, identity, update

Modifier and Type	Method	Description
T	build()	Build the instance from this builder.
default T	get()
default B	identity()	Instance of this builder as the correct type.
default B	update(Consumer<B> consumer)	Update the builder in a fluent API way.

Constructor Details

DbClientMetricBuilder

@Deprecated(forRemoval=true,
            since="27.0.0")
public DbClientMetricBuilder()

Deprecated, for removal: This API element is subject to removal in a future version.

direct public use is not supported; use DbClientMetrics.counter() or DbClientMetrics.timer() for the built-in metric builders

Creates a database client metric builder. Child classes may call this constructor; only direct public use is not supported.

Method Details

name

public B name(String metricName)

Configure a metric name.

Parameters:

metricName - name of the metric

Returns:

updated builder instance

metadata

public B metadata(io.helidon.dbclient.metrics.MeterMetadata meta)

Configure metric metadata.

Parameters:

meta - metric metadata

Returns:

updated builder instance

nameFormat

public B nameFormat(String format)

Configure a name format.

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

Parameters:

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

Returns:

updated builder instance

nameFormat

public B 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

errors

public B errors(boolean measureErrors)

Whether to measure failed statements.

Parameters:

measureErrors - set to false if errors should be ignored

Returns:

updated builder instance

success

public B success(boolean measureSuccess)

Whether to measure successful statements.

Parameters:

measureSuccess - set to false if successes should be ignored

Returns:

updated builder instance

description

public B description(String description)

Description of the metric used in metric metadata.

Parameters:

description - description

Returns:

updated builder instance

config

public B 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.

Overrides:

config in class DbClientServiceBase.BuilderBase<B extends io.helidon.dbclient.metrics.MetricBuilderBase<B,T>, T extends DbClientServiceBase>

Parameters:

config - configuration to configure this metric

Returns:

updated builder instance