Package org.forgerock.opentelemetry.trace.chf

Record Class TracingInboundFilter.TracingInboundFilterConfig

java.lang.Object

java.lang.Record

org.forgerock.opentelemetry.trace.chf.TracingInboundFilter.TracingInboundFilterConfig

Record Components:

openTelemetrySupplier - the OpenTelemetry supplier, which allows to dynamically reconfigure the OpenTelemetry object in the application

getTracer - a function that accepts an OpenTelemetry and returns a Tracer, allows the application to dynamically obtain a Tracer appropriately configured for the application

getSpanName - a function that builds a span name from the given Request

Enclosing class:

TracingInboundFilter

public static record TracingInboundFilter.TracingInboundFilterConfig(Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier, Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer> getTracer, Function<Request,String> getSpanName)
extends Record

Creates a configuration object used to instantiate a TracingInboundFilter.

Constructor Summary

Constructors

Constructor	Description
TracingInboundFilterConfig(Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier, Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer> getTracer)	Creates a configuration object used to instantiate a TracingInboundFilter.
TracingInboundFilterConfig(Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier, Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer> getTracer, Function<Request,String> getSpanName)	Creates an instance of a TracingInboundFilterConfig record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Function<Request,String>	getSpanName()	Returns the value of the getSpanName record component.
Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer>	getTracer()	Returns the value of the getTracer record component.
final int	hashCode()	Returns a hash code value for this object.
Supplier<io.opentelemetry.api.OpenTelemetry>	openTelemetrySupplier()	Returns the value of the openTelemetrySupplier record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TracingInboundFilterConfig

public TracingInboundFilterConfig(Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier,
 Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer> getTracer)

Creates a configuration object used to instantiate a TracingInboundFilter. OpenTelemetryUtils.spanName(Request) is the default factory used to create the span name.

Parameters:

openTelemetrySupplier - the OpenTelemetry supplier, which allows to dynamically reconfigure the OpenTelemetry object in the application

getTracer - a function that accepts an OpenTelemetry and returns a Tracer, allows the application to dynamically obtain a Tracer appropriately configured for the application

See Also:

• for the default span name creation

TracingInboundFilterConfig

public TracingInboundFilterConfig(Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier,
 Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer> getTracer,
 Function<Request,String> getSpanName)

Creates an instance of a TracingInboundFilterConfig record class.

Parameters:

openTelemetrySupplier - the value for the openTelemetrySupplier record component

getTracer - the value for the getTracer record component

getSpanName - the value for the getSpanName record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

openTelemetrySupplier

public Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier()

Returns the value of the openTelemetrySupplier record component.

Returns:

the value of the openTelemetrySupplier record component

getTracer

public Function<io.opentelemetry.api.OpenTelemetry,io.opentelemetry.api.trace.Tracer> getTracer()

Returns the value of the getTracer record component.

Returns:

the value of the getTracer record component

getSpanName

public Function<Request,String> getSpanName()

Returns the value of the getSpanName record component.

Returns:

the value of the getSpanName record component