Top Description Fields Methods
io.vertx.core.spi

public Interface VertxTracerFactory

extends VertxServiceProvider
Imports
io.vertx.core.impl.VertxBuilder, io.vertx.core.json.JsonObject, io.vertx.core.spi.tracing.VertxTracer, io.vertx.core.tracing.TracingOptions
A factory for the plug-able tracing SPI.
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
public static final VertxTracerFactory
NOOP

Noop tracer factory, it can be useful for disabling metrics, e.g new VertxOptions().setTracingOptions(new TracingOptions().setFactory(VertxTracerFactory.NOOP))

Method Summary

Modifier and TypeMethod and Description
public default void
init(VertxBuilder
the builder
builder)

Implements io.vertx.core.spi.VertxServiceProvider.init.

Let the provider initialize the Vert.x builder.

public default TracingOptions

Returns:

new tracing options
newOptions()

Create an empty tracing options.

public default TracingOptions

Returns:

new tracing options
newOptions(JsonObject
json provided by the user
jsonObject)
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Create tracing options from the provided jsonObject.

public VertxTracer<I, O>

Returns:

the tracing implementation
tracer(TracingOptions
the metrics configuration option
options)

Create a new VertxTracer object.

Field Detail

NOOPback to summary
public static final VertxTracerFactory NOOP

Noop tracer factory, it can be useful for disabling metrics, e.g new VertxOptions().setTracingOptions(new TracingOptions().setFactory(VertxTracerFactory.NOOP))

Method Detail

initback to summary
public default void init(VertxBuilder builder)

Implements io.vertx.core.spi.VertxServiceProvider.init.

Doc from io.vertx.core.spi.VertxServiceProvider.init.

Let the provider initialize the Vert.x builder.

Parameters
builder:VertxBuilder

the builder

Annotations
@Override
newOptionsback to summary
public default TracingOptions newOptions()

Create an empty tracing options. Providers can override this method to provide a custom tracing options subclass that exposes custom configuration. It is used by the io.vertx.core.Launcher class when creating new options when building a CLI Vert.x.

Returns:TracingOptions

new tracing options

newOptionsback to summary
public default TracingOptions newOptions(JsonObject jsonObject)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Create tracing options from the provided jsonObject. Providers can override this method to provide a custom tracing options subclass that exposes custom configuration. It is used by the io.vertx.core.Launcher class when creating new options when building a CLI Vert.x.

Parameters
jsonObject:JsonObject

json provided by the user

Returns:TracingOptions

new tracing options

tracerback to summary
public VertxTracer<I, O> tracer(TracingOptions options)

Create a new VertxTracer object.

No specific thread and context can be expected when this method is called.

Parameters
options:TracingOptions

the metrics configuration option

Returns:VertxTracer<I, O>

the tracing implementation