io.grpc.services

Class MetricRecorder

java.lang.Object

io.grpc.services.MetricRecorder

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/9006")
public final class MetricRecorder
extends Object

Implements the service/APIs for Out-of-Band metrics reporting, only for utilization metrics. A user should use the public set-APIs to update the server machine's utilization metrics data.

Method Summary

Modifier and Type	Method and Description
void	clearCpuUtilizationMetric() Clear the CPU utilization metrics data.
void	clearMemoryUtilizationMetric() Clear the memory utilization metrics data.
static MetricRecorder	newInstance()
void	putUtilizationMetric(String key, double value) Update the metrics value corresponding to the specified key.
void	removeUtilizationMetric(String key) Remove the metrics data entry corresponding to the specified key.
void	setAllUtilizationMetrics(Map<String,Double> metrics) Replace the whole metrics data using the specified map.
void	setCpuUtilizationMetric(double value) Update the CPU utilization metrics data.
void	setMemoryUtilizationMetric(double value) Update the memory utilization metrics data.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static MetricRecorder newInstance()

putUtilizationMetric

public void putUtilizationMetric(String key,
                                 double value)

Update the metrics value corresponding to the specified key.

setAllUtilizationMetrics

public void setAllUtilizationMetrics(Map<String,Double> metrics)

Replace the whole metrics data using the specified map.

removeUtilizationMetric

public void removeUtilizationMetric(String key)

Remove the metrics data entry corresponding to the specified key.

setCpuUtilizationMetric

public void setCpuUtilizationMetric(double value)

Update the CPU utilization metrics data.

clearCpuUtilizationMetric

public void clearCpuUtilizationMetric()

Clear the CPU utilization metrics data.

setMemoryUtilizationMetric

public void setMemoryUtilizationMetric(double value)

Update the memory utilization metrics data.

clearMemoryUtilizationMetric

public void clearMemoryUtilizationMetric()

Clear the memory utilization metrics data.