Package com.linkedin.venice.stats.metrics

Class MetricEntity

java.lang.Object

com.linkedin.venice.stats.metrics.MetricEntity

public class MetricEntity
extends Object

Metric entity class to define a metric with all its properties

Constructor Summary

Constructors

Constructor	Description
MetricEntity(String metricName, MetricType metricType, MetricUnit unit, String description, Set<VeniceMetricsDimensions> dimensionsList)

Method Summary

Modifier and Type	Method	Description
static MetricEntity	createWithNoDimensions(String metricName, MetricType metricType, MetricUnit unit, String description)	Factory method for metrics without dimensions.
static MetricEntity	createWithNoDimensions(String metricName, MetricType metricType, MetricUnit unit, String description, String customMetricPrefix)	Factory method for metrics without dimensions that need a custom metric prefix, e.g.
String	getCustomMetricPrefix()
String	getDescription()
Set<VeniceMetricsDimensions>	getDimensionsList()
String	getMetricName()
MetricType	getMetricType()
MetricUnit	getUnit()

Methods inherited from class java.lang.Object

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

Constructor Details

MetricEntity

public MetricEntity(@Nonnull
 String metricName,
 @Nonnull
 MetricType metricType,
 @Nonnull
 MetricUnit unit,
 @Nonnull
 String description,
 @Nonnull
 Set<VeniceMetricsDimensions> dimensionsList)

Method Details

getMetricName

@Nonnull
public String getMetricName()

getMetricType

@Nonnull
public MetricType getMetricType()

getUnit

@Nonnull
public MetricUnit getUnit()

getDescription

@Nonnull
public String getDescription()

getDimensionsList

@Nonnull
public Set<VeniceMetricsDimensions> getDimensionsList()

getCustomMetricPrefix

public String getCustomMetricPrefix()

createWithNoDimensions

public static MetricEntity createWithNoDimensions(@Nonnull
 String metricName,
 @Nonnull
 MetricType metricType,
 @Nonnull
 MetricUnit unit,
 @Nonnull
 String description)

Factory method for metrics without dimensions. These metrics should only be used with MetricEntityStateBase.

createWithNoDimensions

public static MetricEntity createWithNoDimensions(@Nonnull
 String metricName,
 @Nonnull
 MetricType metricType,
 @Nonnull
 MetricUnit unit,
 @Nonnull
 String description,
 @Nonnull
 String customMetricPrefix)

Factory method for metrics without dimensions that need a custom metric prefix, e.g. VeniceOpenTelemetryMetricsRepository.CommonMetricsEntity. These metrics should only be used with MetricEntityStateBase.