io.r2dbc.proxy.observation

Class ObservationProxyExecutionListener

java.lang.Object

io.r2dbc.proxy.observation.ObservationProxyExecutionListener

All Implemented Interfaces:

ProxyExecutionListener

public class ObservationProxyExecutionListener
extends Object
implements ProxyExecutionListener

Create Micrometer Observations.

Since:

1.1.0

Author:

Marcin Grzejszczak, Tadaya Tsuyukubo

Constructor Summary

Constructors

Constructor and Description
ObservationProxyExecutionListener(io.micrometer.observation.ObservationRegistry observationRegistry, io.r2dbc.spi.ConnectionFactory connectionFactory, String connectionUrl) Constructor that takes a connection url.
ObservationProxyExecutionListener(io.micrometer.observation.ObservationRegistry observationRegistry, io.r2dbc.spi.ConnectionFactory connectionFactory, String host, Integer port) Constructor that takes host and port.

Method Summary

Modifier and Type	Method and Description
void	afterQuery(QueryExecutionInfo executionInfo) Called after executing a query (Batch.execute() or Statement.execute()).
void	beforeQuery(QueryExecutionInfo executionInfo) Called before executing a query (Batch.execute() or Statement.execute()).
void	eachQueryResult(QueryExecutionInfo executionInfo) Called on processing each query Result.
void	setIncludeParameterValues(boolean includeParameterValues)
void	setQueryObservationConvention(QueryObservationConvention queryObservationConvention)
void	setQueryParametersTagProvider(QueryParametersTagProvider queryParametersTagProvider)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.r2dbc.proxy.listener.ProxyExecutionListener

afterMethod, beforeMethod

Constructor Detail

ObservationProxyExecutionListener

public ObservationProxyExecutionListener(io.micrometer.observation.ObservationRegistry observationRegistry,
                                         io.r2dbc.spi.ConnectionFactory connectionFactory,
                                         @Nullable
                                         String connectionUrl)

Constructor that takes a connection url.

Parameters:

observationRegistry - observation registry

connectionFactory - connection factory

connectionUrl - connection url string (optional)

ObservationProxyExecutionListener

public ObservationProxyExecutionListener(io.micrometer.observation.ObservationRegistry observationRegistry,
                                         io.r2dbc.spi.ConnectionFactory connectionFactory,
                                         @Nullable
                                         String host,
                                         @Nullable
                                         Integer port)

Constructor that takes host and port.

Parameters:

observationRegistry - observation registry

connectionFactory - connection factory

host - host

port - port number (optional)

Since:

1.1.2

Method Detail

beforeQuery

public void beforeQuery(QueryExecutionInfo executionInfo)

Description copied from interface: ProxyExecutionListener

Called before executing a query (Batch.execute() or Statement.execute()).

Note: this callback is called when the publisher, result of the execute(), is being subscribed. Not at the time of execute() is called,

Exception Handling: Exceptions thrown by this method are dropped and do not affect the original subscription's publisher flow. Such exceptions are reported to Hooks.onErrorDropped(java.util.function.Consumer).

Specified by:

beforeQuery in interface ProxyExecutionListener

Parameters:

executionInfo - query execution context

afterQuery

public void afterQuery(QueryExecutionInfo executionInfo)

Description copied from interface: ProxyExecutionListener

Called after executing a query (Batch.execute() or Statement.execute()).

The callback order is:

• ProxyExecutionListener.beforeQuery(QueryExecutionInfo)
• ProxyExecutionListener.eachQueryResult(QueryExecutionInfo) for 1st result
• ProxyExecutionListener.eachQueryResult(QueryExecutionInfo) for 2nd result
• ...
• ProxyExecutionListener.eachQueryResult(QueryExecutionInfo) for Nth result
• ProxyExecutionListener.afterQuery(QueryExecutionInfo)

QueryExecutionInfo.getExecuteDuration() is available in this callback and it holds the duration since ProxyExecutionListener.beforeQuery(QueryExecutionInfo).

Note: this callback is called when the publisher, result of the execute(), is being subscribed. Not at the time of execute() is called,

Exception Handling: Exceptions thrown by this method are dropped and do not affect the original subscription's publisher flow. Such exceptions are reported to Hooks.onErrorDropped(java.util.function.Consumer).

Specified by:

afterQuery in interface ProxyExecutionListener

Parameters:

executionInfo - query execution context

eachQueryResult

public void eachQueryResult(QueryExecutionInfo executionInfo)

Description copied from interface: ProxyExecutionListener

Called on processing each query Result.

While processing query results Result, this callback is called per result.

QueryExecutionInfo.getCurrentMappedResult() contains the mapped result.

Exception Handling: Exceptions thrown by this method are dropped and do not affect the original subscription's publisher flow. Such exceptions are reported to Hooks.onErrorDropped(java.util.function.Consumer).

Specified by:

eachQueryResult in interface ProxyExecutionListener

Parameters:

executionInfo - query execution context

setIncludeParameterValues

public void setIncludeParameterValues(boolean includeParameterValues)

setQueryParametersTagProvider

public void setQueryParametersTagProvider(QueryParametersTagProvider queryParametersTagProvider)

setQueryObservationConvention

public void setQueryObservationConvention(QueryObservationConvention queryObservationConvention)