Package io.sentry.metrics

Class MetricsHelper

java.lang.Object

io.sentry.metrics.MetricsHelper

@Internal
public final class MetricsHelper
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final long	FLUSHER_SLEEP_TIME_MS
static final int	MAX_TOTAL_WEIGHT

Constructor Summary

Constructors

Constructor	Description
MetricsHelper()

Method Summary

Modifier and Type	Method	Description
static double	convertNanosTo(MeasurementUnit.Duration unit, long durationNanos)
static void	encodeMetrics(long timestamp, @NotNull Collection<Metric> metrics, @NotNull StringBuilder writer)	Encodes the metrics
static long	getCutoffTimestampMs(long nowMs)
static @NotNull String	getExportKey(@NotNull MetricType type, @NotNull String key, @Nullable MeasurementUnit unit)	Provides an export key for identifying the metric without its tags.
static @NotNull String	getMetricBucketKey(@NotNull MetricType type, @NotNull String metricKey, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags)
static long	getTimeBucketKey(long timestampMs)
static @NotNull Map<String,String>	mergeTags(@Nullable Map<String,String> tags, @NotNull Map<String,String> defaultTags)
static @NotNull String	sanitizeName(@NotNull String input)
static @NotNull String	sanitizeTagKey(@NotNull String input)
static @NotNull String	sanitizeTagValue(@NotNull String input)
static @NotNull String	sanitizeUnit(@NotNull String unit)
static void	setFlushShiftMs(long flushShiftMs)

Methods inherited from class java.lang.Object

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

Field Details

FLUSHER_SLEEP_TIME_MS

public static final long FLUSHER_SLEEP_TIME_MS

See Also:

• Constant Field Values

MAX_TOTAL_WEIGHT

public static final int MAX_TOTAL_WEIGHT

See Also:

• Constant Field Values

Constructor Details

MetricsHelper

public MetricsHelper()

Method Details

getTimeBucketKey

public static long getTimeBucketKey(long timestampMs)

getCutoffTimestampMs

public static long getCutoffTimestampMs(long nowMs)

sanitizeUnit

@NotNull
public static @NotNull String sanitizeUnit(@NotNull
 @NotNull String unit)

sanitizeName

@NotNull
public static @NotNull String sanitizeName(@NotNull
 @NotNull String input)

sanitizeTagKey

@NotNull
public static @NotNull String sanitizeTagKey(@NotNull
 @NotNull String input)

sanitizeTagValue

@NotNull
public static @NotNull String sanitizeTagValue(@NotNull
 @NotNull String input)

getMetricBucketKey

@NotNull
public static @NotNull String getMetricBucketKey(@NotNull
 @NotNull MetricType type,
 @NotNull
 @NotNull String metricKey,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags)

getExportKey

@NotNull
public static @NotNull String getExportKey(@NotNull
 @NotNull MetricType type,
 @NotNull
 @NotNull String key,
 @Nullable
 @Nullable MeasurementUnit unit)

Provides an export key for identifying the metric without its tags. Suitable for span level metric summaries

Parameters:

type - the metric type

key - the metric key

unit - the metric unit

Returns:

the export key

convertNanosTo

public static double convertNanosTo(@NotNull
 MeasurementUnit.Duration unit,
 long durationNanos)

encodeMetrics

public static void encodeMetrics(long timestamp,
 @NotNull
 @NotNull Collection<Metric> metrics,
 @NotNull
 @NotNull StringBuilder writer)

Encodes the metrics

See github.com/statsd/statsd#usage and getsentry.github.io/relay/relay_metrics/index.html for more details about the format.

Parameters:

timestamp - The bucket time the metrics belong to, in second resolution

metrics - The metrics to encode

writer - The writer to encode the metrics into

mergeTags

@NotNull
public static @NotNull Map<String,String> mergeTags(@Nullable
 @Nullable Map<String,String> tags,
 @NotNull
 @NotNull Map<String,String> defaultTags)

setFlushShiftMs

@TestOnly
public static void setFlushShiftMs(long flushShiftMs)