io.quarkus.micrometer.runtime.binder.vertx

Class VertxHttpServerMetrics

java.lang.Object

io.quarkus.micrometer.runtime.binder.vertx.VertxNetworkMetrics

io.quarkus.micrometer.runtime.binder.vertx.VertxTcpMetrics

io.quarkus.micrometer.runtime.binder.vertx.VertxHttpServerMetrics

All Implemented Interfaces:

io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>, io.vertx.core.spi.metrics.Metrics, io.vertx.core.spi.metrics.NetworkMetrics<Map<String,Object>>, io.vertx.core.spi.metrics.TCPMetrics<Map<String,Object>>

public class VertxHttpServerMetrics
extends VertxTcpMetrics
implements io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

HttpServerMetrics

• R for Request metric -- RequestMetricContext
• W for Websocket metric -- LongTaskTimer sample
• S for Socket metric -- Map

Field Summary

Fields

Modifier and Type	Field and Description
(package private) List<Pattern>	ignorePatterns
(package private) static org.jboss.logging.Logger	log
(package private) Map<Pattern,String>	matchPatterns
(package private) String	nameHttpServerPush
(package private) String	nameHttpServerRequests
(package private) String	nameWebsocketConnections

Fields inherited from class io.quarkus.micrometer.runtime.binder.vertx.VertxTcpMetrics

nameConnections

Fields inherited from class io.quarkus.micrometer.runtime.binder.vertx.VertxNetworkMetrics

nameBytesRead, nameBytesWritten, nameExceptionOccurred, registry

Fields inherited from interface io.vertx.core.spi.metrics.Metrics

DISABLE_METRICS_PROPERTY_NAME, METRICS_ENABLED

Constructor Summary

Constructors

Constructor and Description
VertxHttpServerMetrics(io.micrometer.core.instrument.MeterRegistry registry, VertxConfig config)

Method Summary

Modifier and Type	Method and Description
io.micrometer.core.instrument.LongTaskTimer.Sample	connected(Map<String,Object> socketMetric, RequestMetric requestMetric, io.vertx.core.http.ServerWebSocket serverWebSocket) Called when a server web socket connects.
void	disconnected(io.micrometer.core.instrument.LongTaskTimer.Sample websocketMetric) Called when the server web socket has disconnected.
RequestMetric	requestBegin(Map<String,Object> socketMetric, io.vertx.core.http.HttpServerRequest request) Called when an http server request begins.
void	requestReset(RequestMetric requestMetric) Called when the http server request couldn't complete successfully, for instance the connection was closed before the response was sent.
void	responseEnd(RequestMetric requestMetric, io.vertx.core.http.HttpServerResponse response) Called when an http server response has ended.
RequestMetric	responsePushed(Map<String,Object> socketMetric, io.vertx.core.http.HttpMethod method, String uri, io.vertx.core.http.HttpServerResponse response) Called when an http server response is pushed.

Methods inherited from class io.quarkus.micrometer.runtime.binder.vertx.VertxTcpMetrics

connected, disconnected

Methods inherited from class io.quarkus.micrometer.runtime.binder.vertx.VertxNetworkMetrics

bytesRead, bytesWritten, exceptionOccurred

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.core.spi.metrics.HttpServerMetrics

responseBegin

Methods inherited from interface io.vertx.core.spi.metrics.TCPMetrics

connected, disconnected

Methods inherited from interface io.vertx.core.spi.metrics.NetworkMetrics

bytesRead, bytesWritten, exceptionOccurred

Methods inherited from interface io.vertx.core.spi.metrics.Metrics

close, isEnabled

Field Detail

log

static final org.jboss.logging.Logger log

ignorePatterns

final List<Pattern> ignorePatterns

matchPatterns

final Map<Pattern,String> matchPatterns

nameWebsocketConnections

final String nameWebsocketConnections

nameHttpServerPush

final String nameHttpServerPush

nameHttpServerRequests

final String nameHttpServerRequests

Constructor Detail

VertxHttpServerMetrics

VertxHttpServerMetrics(io.micrometer.core.instrument.MeterRegistry registry,
                       VertxConfig config)

Method Detail

responsePushed

public RequestMetric responsePushed(Map<String,Object> socketMetric,
                                    io.vertx.core.http.HttpMethod method,
                                    String uri,
                                    io.vertx.core.http.HttpServerResponse response)

Called when an http server response is pushed.

Specified by:

responsePushed in interface io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

Parameters:

socketMetric - a Map for socket metric context or null

method - the pushed response method

uri - the pushed response uri

response - the http server response

Returns:

a RequestMetricContext

requestBegin

public RequestMetric requestBegin(Map<String,Object> socketMetric,
                                  io.vertx.core.http.HttpServerRequest request)

Called when an http server request begins. Vert.x will invoke responseEnd(io.quarkus.micrometer.runtime.binder.vertx.RequestMetric, io.vertx.core.http.HttpServerResponse) when the response has ended or requestReset(io.quarkus.micrometer.runtime.binder.vertx.RequestMetric) if the request/response has failed before.

Specified by:

requestBegin in interface io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

Parameters:

socketMetric - a Map for socket metric context or null

request - the http server request

Returns:

a RequestMetricContext

requestReset

public void requestReset(RequestMetric requestMetric)

Called when the http server request couldn't complete successfully, for instance the connection was closed before the response was sent.

Specified by:

requestReset in interface io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

Parameters:

requestMetric - a RequestMetricContext or null

responseEnd

public void responseEnd(RequestMetric requestMetric,
                        io.vertx.core.http.HttpServerResponse response)

Called when an http server response has ended.

Specified by:

responseEnd in interface io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

Parameters:

requestMetric - a RequestMetricContext or null

response - the http server response

connected

public io.micrometer.core.instrument.LongTaskTimer.Sample connected(Map<String,Object> socketMetric,
                                                                    RequestMetric requestMetric,
                                                                    io.vertx.core.http.ServerWebSocket serverWebSocket)

Called when a server web socket connects.

Specified by:

connected in interface io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

Parameters:

socketMetric - a Map for socket metric context or null

requestMetric - a RequestMetricContext or null

serverWebSocket - the server web socket

Returns:

a LongTaskTimer.Sample or null

disconnected

public void disconnected(io.micrometer.core.instrument.LongTaskTimer.Sample websocketMetric)

Called when the server web socket has disconnected.

Specified by:

disconnected in interface io.vertx.core.spi.metrics.HttpServerMetrics<RequestMetric,io.micrometer.core.instrument.LongTaskTimer.Sample,Map<String,Object>>

Parameters:

websocketMetric - a LongTaskTimer.Sample or null