Class OpenTelemetryMetricsCollector.Builder

java.lang.Object

com.soklet.otel.OpenTelemetryMetricsCollector.Builder

Enclosing class:

OpenTelemetryMetricsCollector

@NotThreadSafe
public static final class OpenTelemetryMetricsCollector.Builder
extends Object

Builder used to construct instances of OpenTelemetryMetricsCollector.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull OpenTelemetryMetricsCollector	build()	Builds the collector.
@NonNull OpenTelemetryMetricsCollector.Builder	instrumentationName(@NonNull String instrumentationName)	Sets the instrumentation scope name to use when constructing a meter.
@NonNull OpenTelemetryMetricsCollector.Builder	instrumentationVersion(@Nullable String instrumentationVersion)	Sets an optional instrumentation scope version to use when constructing a meter.
@NonNull OpenTelemetryMetricsCollector.Builder	meter(@NonNull Meter meter)	Sets a specific meter to use for metric instruments.
@NonNull OpenTelemetryMetricsCollector.Builder	metricNamingStrategy(@NonNull OpenTelemetryMetricsCollector.MetricNamingStrategy metricNamingStrategy)	Sets the naming strategy for HTTP metrics.
@NonNull OpenTelemetryMetricsCollector.Builder	openTelemetry(@NonNull OpenTelemetry openTelemetry)	Sets the OpenTelemetry API object used to construct a meter if meter(Meter) is not set.

Methods inherited from class Object

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

Method Details

meter

public @NonNull OpenTelemetryMetricsCollector.Builder meter(@NonNull Meter meter)

Sets a specific meter to use for metric instruments.

Parameters:

meter - the meter to use

Returns:

this builder

openTelemetry

public @NonNull OpenTelemetryMetricsCollector.Builder openTelemetry(@NonNull OpenTelemetry openTelemetry)

Sets the OpenTelemetry API object used to construct a meter if meter(Meter) is not set.

Parameters:

openTelemetry - the OpenTelemetry instance

Returns:

this builder

metricNamingStrategy

public @NonNull OpenTelemetryMetricsCollector.Builder metricNamingStrategy(@NonNull OpenTelemetryMetricsCollector.MetricNamingStrategy metricNamingStrategy)

Sets the naming strategy for HTTP metrics.

Parameters:

metricNamingStrategy - the naming strategy

Returns:

this builder

instrumentationName

public @NonNull OpenTelemetryMetricsCollector.Builder instrumentationName(@NonNull String instrumentationName)

Sets the instrumentation scope name to use when constructing a meter.

Parameters:

instrumentationName - the instrumentation scope name

Returns:

this builder

instrumentationVersion

public @NonNull OpenTelemetryMetricsCollector.Builder instrumentationVersion(@Nullable String instrumentationVersion)

Sets an optional instrumentation scope version to use when constructing a meter.

Parameters:

instrumentationVersion - the instrumentation scope version, or null

Returns:

this builder

build

public @NonNull OpenTelemetryMetricsCollector build()

Builds the collector.

Returns:

the collector instance