Class MetricsCollector.SnapshotTextOptions.MetricSample

java.lang.Object

com.soklet.MetricsCollector.SnapshotTextOptions.MetricSample

Enclosing class:

MetricsCollector.SnapshotTextOptions

public static final class MetricsCollector.SnapshotTextOptions.MetricSample
extends Object

A single text-format sample with its label set.

Filters receive these instances for each rendered sample. For histogram buckets, the sample name includes _bucket and the labels include le. Label maps are immutable and preserve insertion order.

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
MetricSample(@NonNull String name, @NonNull Map<@NonNull String, @NonNull String> labels)	Creates a metrics sample definition.

Method Summary

Modifier and Type	Method	Description
@NonNull Map<@NonNull String, @NonNull String>	getLabels()	The label set for this sample.
@NonNull String	getName()	The name for this sample.

Methods inherited from class Object

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

Constructor Details

MetricSample

public MetricSample(@NonNull String name,
 @NonNull Map<@NonNull String, @NonNull String> labels)

Creates a metrics sample definition.

Parameters:

name - the sample name (e.g. soklet_http_request_duration_nanos_bucket)

labels - the sample labels

Method Details

getName

public @NonNull String getName()

The name for this sample.

Returns:

the sample name

getLabels

public @NonNull Map<@NonNull String, @NonNull String> getLabels()

The label set for this sample.

Returns:

immutable labels