Class MetricsCollector.SnapshotTextOptions

java.lang.Object

com.soklet.MetricsCollector.SnapshotTextOptions

Enclosing interface:

MetricsCollector

@ThreadSafe
public static final class MetricsCollector.SnapshotTextOptions
extends Object

Options for rendering a textual metrics snapshot.

Use withMetricsFormat(MetricsFormat) to obtain a builder and customize output.

Key options:

• metricFilter allows per-sample filtering by name and labels
• histogramFormat controls bucket vs count/sum output
• includeZeroBuckets drops empty bucket samples when false

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetricsCollector.SnapshotTextOptions.Builder	Builder for MetricsCollector.SnapshotTextOptions.
static enum	MetricsCollector.SnapshotTextOptions.HistogramFormat	Supported histogram rendering strategies.
static final class	MetricsCollector.SnapshotTextOptions.MetricSample	A single text-format sample with its label set.

Method Summary

Modifier and Type	Method	Description
static @NonNull MetricsCollector.SnapshotTextOptions	fromMetricsFormat(@NonNull MetricsCollector.MetricsFormat metricsFormat)	Creates options with the specified format and defaults for all other fields.
@NonNull MetricsCollector.SnapshotTextOptions.HistogramFormat	getHistogramFormat()	The histogram rendering strategy.
@NonNull Boolean	getIncludeZeroBuckets()	Whether zero-count buckets should be emitted.
@NonNull Optional<Predicate<MetricsCollector.SnapshotTextOptions.MetricSample>>	getMetricFilter()	Optional filter for rendered samples.
@NonNull MetricsCollector.MetricsFormat	getMetricsFormat()	The text exposition format to emit.
static @NonNull MetricsCollector.SnapshotTextOptions.Builder	withMetricsFormat(@NonNull MetricsCollector.MetricsFormat metricsFormat)	Begins building options with the specified format.

Methods inherited from class Object

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

Method Details

withMetricsFormat

public static @NonNull MetricsCollector.SnapshotTextOptions.Builder withMetricsFormat(@NonNull MetricsCollector.MetricsFormat metricsFormat)

Begins building options with the specified format.

Parameters:

metricsFormat - the text exposition format

Returns:

a builder seeded with the format

fromMetricsFormat

public static @NonNull MetricsCollector.SnapshotTextOptions fromMetricsFormat(@NonNull MetricsCollector.MetricsFormat metricsFormat)

Creates options with the specified format and defaults for all other fields.

Parameters:

metricsFormat - the text exposition format

Returns:

a MetricsCollector.SnapshotTextOptions instance

getMetricsFormat

public @NonNull MetricsCollector.MetricsFormat getMetricsFormat()

The text exposition format to emit.

Returns:

the metrics format

getMetricFilter

public @NonNull Optional<Predicate<MetricsCollector.SnapshotTextOptions.MetricSample>> getMetricFilter()

Optional filter for rendered samples.

Returns:

the filter, if present

getHistogramFormat

public @NonNull MetricsCollector.SnapshotTextOptions.HistogramFormat getHistogramFormat()

The histogram rendering strategy.

Returns:

the histogram format

getIncludeZeroBuckets

public @NonNull Boolean getIncludeZeroBuckets()

Whether zero-count buckets should be emitted.

Returns:

true if zero-count buckets are included