Package ai.vespa.metricsproxy.metric

Class Metric

java.lang.Object

ai.vespa.metricsproxy.metric.Metric

public class Metric
extends Object

Author:

Jo Kristian Bergum

Constructor Summary

Constructors

Constructor	Description
Metric(MetricId name, Number value)
Metric(MetricId name, Number value, long timestamp)
Metric(MetricId name, Number value, Instant timestamp)
Metric(MetricId name, Number value, Instant time, Map<DimensionId,String> dimensions, String description)	Creates a new metric instance

Method Summary

Modifier and Type	Method	Description
static long	adjustTime(long timestamp, long now)	Return an adjusted (rounded up) time if necessary
Metric	clone()
boolean	equals(Object obj)
Set<ConsumerId>	getConsumers()
String	getDescription()
Map<DimensionId,String>	getDimensions()
MetricId	getName()
Instant	getTimeStamp()
Number	getValue()
int	hashCode()
void	setConsumers(Set<ConsumerId> consumers)
void	setDimensions(Map<DimensionId,String> dimensions)
void	setName(MetricId name)	Set the name of this metric
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Metric

public Metric(MetricId name,
 Number value,
 Instant time,
 Map<DimensionId,String> dimensions,
 String description)

Creates a new metric instance

Parameters:

name - The metric name. E.g 'documents'

value - The numeric value

time - The timestamp of this metric in seconds

Metric

public Metric(MetricId name,
 Number value,
 long timestamp)

Metric

public Metric(MetricId name,
 Number value,
 Instant timestamp)

Metric

public Metric(MetricId name,
 Number value)

Method Details

setDimensions

public void setDimensions(Map<DimensionId,String> dimensions)

getDimensions

public Map<DimensionId,String> getDimensions()

Returns:

A map of the dimensions registered for this metric

setConsumers

public void setConsumers(Set<ConsumerId> consumers)

getConsumers

public Set<ConsumerId> getConsumers()

Returns:

The consumers this metric should be routed to.

getValue

public Number getValue()

Returns:

The number that this metric name represent

setName

public void setName(MetricId name)

Set the name of this metric

Parameters:

name - The name to use for this metric

getName

public MetricId getName()

Returns:

The name of the metric

getTimeStamp

public Instant getTimeStamp()

Returns:

The UTC timestamp for when this metric was collected

toString

public String toString()

Overrides:

toString in class Object

clone

public Metric clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescription

public String getDescription()

Returns:

the description of this metric

adjustTime

public static long adjustTime(long timestamp,
 long now)

Return an adjusted (rounded up) time if necessary