Package io.sentry

Class MetricsAggregator

java.lang.Object

io.sentry.MetricsAggregator

All Implemented Interfaces:

IMetricsAggregator, Closeable, AutoCloseable, Runnable

@Internal
public final class MetricsAggregator
extends Object
implements IMetricsAggregator, Runnable, Closeable

Constructor Summary

Constructors

Constructor	Description
MetricsAggregator(@NotNull IMetricsClient client, @NotNull ILogger logger, @NotNull SentryDateProvider dateProvider, int maxWeight, SentryOptions.BeforeEmitMetricCallback beforeEmitCallback, @NotNull ISentryExecutorService executorService)
MetricsAggregator(@NotNull SentryOptions options, @NotNull IMetricsClient client)

Method Summary

Modifier and Type	Method	Description
void	close()
void	distribution(@NotNull String key, double value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Distribution metric
void	flush(boolean force)
void	gauge(@NotNull String key, double value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Gauge metric
void	increment(@NotNull String key, double value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Counter metric
void	run()
void	set(@NotNull String key, int value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Set metric
void	set(@NotNull String key, @NotNull String value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Set metric

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsAggregator

public MetricsAggregator(@NotNull
 @NotNull SentryOptions options,
 @NotNull
 @NotNull IMetricsClient client)

MetricsAggregator

@TestOnly
public MetricsAggregator(@NotNull
 @NotNull IMetricsClient client,
 @NotNull
 @NotNull ILogger logger,
 @NotNull
 @NotNull SentryDateProvider dateProvider,
 int maxWeight,
 @Nullable
 SentryOptions.BeforeEmitMetricCallback beforeEmitCallback,
 @NotNull
 @NotNull ISentryExecutorService executorService)

Method Details

increment

public void increment(@NotNull
 @NotNull String key,
 double value,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags,
 long timestampMs,
 @Nullable
 @Nullable LocalMetricsAggregator localMetricsAggregator)

Description copied from interface: IMetricsAggregator

Emits a Counter metric

Specified by:

increment in interface IMetricsAggregator

Parameters:

key - A unique key identifying the metric

value - The value to be added

unit - An optional unit, see MeasurementUnit

tags - Optional Tags to associate with the metric

timestampMs - The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.

localMetricsAggregator - The local metrics aggregator for creating span summaries

gauge

public void gauge(@NotNull
 @NotNull String key,
 double value,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags,
 long timestampMs,
 @Nullable
 @Nullable LocalMetricsAggregator localMetricsAggregator)

Description copied from interface: IMetricsAggregator

Emits a Gauge metric

Specified by:

gauge in interface IMetricsAggregator

Parameters:

key - A unique key identifying the metric

value - The value to be added

unit - An optional unit, see MeasurementUnit

tags - Optional Tags to associate with the metric

timestampMs - The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.

localMetricsAggregator - The local metrics aggregator for creating span summaries

distribution

public void distribution(@NotNull
 @NotNull String key,
 double value,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags,
 long timestampMs,
 @Nullable
 @Nullable LocalMetricsAggregator localMetricsAggregator)

Description copied from interface: IMetricsAggregator

Emits a Distribution metric

Specified by:

distribution in interface IMetricsAggregator

Parameters:

key - A unique key identifying the metric

value - The value to be added

unit - An optional unit, see MeasurementUnit

tags - Optional Tags to associate with the metric

timestampMs - The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.

localMetricsAggregator - The local metrics aggregator for creating span summaries

set

public void set(@NotNull
 @NotNull String key,
 int value,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags,
 long timestampMs,
 @Nullable
 @Nullable LocalMetricsAggregator localMetricsAggregator)

Description copied from interface: IMetricsAggregator

Emits a Set metric

Specified by:

set in interface IMetricsAggregator

Parameters:

key - A unique key identifying the metric

value - The value to be added

unit - An optional unit, see MeasurementUnit

tags - Optional Tags to associate with the metric

timestampMs - The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.

localMetricsAggregator - The local metrics aggregator for creating span summaries

set

public void set(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags,
 long timestampMs,
 @Nullable
 @Nullable LocalMetricsAggregator localMetricsAggregator)

Description copied from interface: IMetricsAggregator

Emits a Set metric

Specified by:

set in interface IMetricsAggregator

Parameters:

key - A unique key identifying the metric

value - The value to be added

unit - An optional unit, see MeasurementUnit

tags - Optional Tags to associate with the metric

timestampMs - The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.

localMetricsAggregator - The local metrics aggregator for creating span summaries

flush

public void flush(boolean force)

Specified by:

flush in interface IMetricsAggregator

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

run

public void run()

Specified by:

run in interface Runnable