Package io.sentry.metrics

Class NoopMetricsAggregator

java.lang.Object

io.sentry.metrics.NoopMetricsAggregator

All Implemented Interfaces:

IMetricsAggregator, MetricsApi.IMetricsInterface, Closeable, AutoCloseable

@Internal
public final class NoopMetricsAggregator
extends Object
implements IMetricsAggregator, MetricsApi.IMetricsInterface

Constructor Summary

Constructors

Constructor	Description
NoopMetricsAggregator()

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, int stackLevel, @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, int stackLevel, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Gauge metric
@NotNull Map<String,String>	getDefaultTagsForMetrics()
static NoopMetricsAggregator	getInstance()
@Nullable LocalMetricsAggregator	getLocalMetricsAggregator()
@NotNull IMetricsAggregator	getMetricsAggregator()
void	increment(@NotNull String key, double value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, int stackLevel, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Counter metric
void	set(@NotNull String key, int value, @Nullable MeasurementUnit unit, @Nullable Map<String,String> tags, long timestampMs, int stackLevel, @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, int stackLevel, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a Set metric
@Nullable ISpan	startSpanForMetric(@NotNull String op, @NotNull String description)
void	timing(@NotNull String key, @NotNull Runnable callback, MeasurementUnit.Duration unit, @Nullable Map<String,String> tags, int stackLevel, @Nullable LocalMetricsAggregator localMetricsAggregator)	Emits a distribution with the time it takes to run a given code block.

Methods inherited from class java.lang.Object

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

Constructor Details

NoopMetricsAggregator

public NoopMetricsAggregator()

Method Details

getInstance

public static NoopMetricsAggregator getInstance()

increment

public void increment(@NotNull
 @NotNull String key,
 double value,
 @Nullable
 @Nullable MeasurementUnit unit,
 @Nullable
 @Nullable Map<String,String> tags,
 long timestampMs,
 int stackLevel,
 @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.

stackLevel - Optional number of stacks levels to ignore when determining the code location

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,
 int stackLevel,
 @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.

stackLevel - Optional number of stacks levels to ignore when determining the code location

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,
 int stackLevel,
 @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.

stackLevel - Optional number of stacks levels to ignore when determining the code location

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,
 int stackLevel,
 @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.

stackLevel - Optional number of stacks levels to ignore when determining the code location

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,
 int stackLevel,
 @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.

stackLevel - Optional number of stacks levels to ignore when determining the code location

localMetricsAggregator - The local metrics aggregator for creating span summaries

timing

public void timing(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull Runnable callback,
 @NotNull
 MeasurementUnit.Duration unit,
 @Nullable
 @Nullable Map<String,String> tags,
 int stackLevel,
 @Nullable
 @Nullable LocalMetricsAggregator localMetricsAggregator)

Description copied from interface: IMetricsAggregator

Emits a distribution with the time it takes to run a given code block.

Specified by:

timing in interface IMetricsAggregator

Parameters:

key - A unique key identifying the metric

callback - The code block to measure

unit - An optional unit, see MeasurementUnit.Duration, defaults to seconds

tags - Optional Tags to associate with the metric

stackLevel - Optional number of stacks levels to ignore when determining the code location

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

getMetricsAggregator

@NotNull
public @NotNull IMetricsAggregator getMetricsAggregator()

Specified by:

getMetricsAggregator in interface MetricsApi.IMetricsInterface

getLocalMetricsAggregator

@Nullable
public @Nullable LocalMetricsAggregator getLocalMetricsAggregator()

Specified by:

getLocalMetricsAggregator in interface MetricsApi.IMetricsInterface

getDefaultTagsForMetrics

@NotNull
public @NotNull Map<String,String> getDefaultTagsForMetrics()

Specified by:

getDefaultTagsForMetrics in interface MetricsApi.IMetricsInterface

startSpanForMetric

@Nullable
public @Nullable ISpan startSpanForMetric(@NotNull
 @NotNull String op,
 @NotNull
 @NotNull String description)

Specified by:

startSpanForMetric in interface MetricsApi.IMetricsInterface