io.grpc.xds

Class OrcaOobService

java.lang.Object

io.grpc.xds.OrcaOobService

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

Implements the service/APIs for Out-of-Band metrics reporting, only for utilization metrics. Register the returned service getService() to the server, then a client can request for periodic load reports. A user should use the public set-APIs to update the server machine's utilization metrics data.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_MIN_REPORT_INTERVAL_NANOS Empty or invalid (non-positive) minInterval config in will be treated to this default value.

Constructor Summary

Constructors

Constructor and Description
OrcaOobService(long minInterval, TimeUnit timeUnit, ScheduledExecutorService timeService) Construct an OOB metrics reporting service.
OrcaOobService(ScheduledExecutorService timeService)

Method Summary

Modifier and Type	Method and Description
void	deleteCpuUtilizationMetric() Clear the CPU utilization metrics data.
void	deleteMemoryUtilizationMetric() Clear the memory utilization metrics data.
void	deleteUtilizationMetric(String key) Remove the metrics data entry corresponding to the specified key.
BindableService	getService() Returns the service instance to be bound to the server for ORCA OOB functionality.
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.
void	setUtilizationMetric(String key, double value) Update the metrics value corresponding to the specified key.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIN_REPORT_INTERVAL_NANOS

public static final long DEFAULT_MIN_REPORT_INTERVAL_NANOS

Empty or invalid (non-positive) minInterval config in will be treated to this default value.

Constructor Detail

OrcaOobService

public OrcaOobService(long minInterval,
                      TimeUnit timeUnit,
                      ScheduledExecutorService timeService)

Construct an OOB metrics reporting service.

Parameters:

minInterval - configures the minimum metrics reporting interval for the service. Bad configuration (non-positive) will be overridden to service default (30s). Minimum metrics reporting interval means, if the setting in the client's request is invalid (non-positive) or below this value, they will be treated as this value.

OrcaOobService

public OrcaOobService(ScheduledExecutorService timeService)

Method Detail

getService

public BindableService getService()

Returns the service instance to be bound to the server for ORCA OOB functionality.

setUtilizationMetric

public void setUtilizationMetric(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.

deleteUtilizationMetric

public void deleteUtilizationMetric(String key)

Remove the metrics data entry corresponding to the specified key.

setCpuUtilizationMetric

public void setCpuUtilizationMetric(double value)

Update the CPU utilization metrics data.

deleteCpuUtilizationMetric

public void deleteCpuUtilizationMetric()

Clear the CPU utilization metrics data.

setMemoryUtilizationMetric

public void setMemoryUtilizationMetric(double value)

Update the memory utilization metrics data.

deleteMemoryUtilizationMetric

public void deleteMemoryUtilizationMetric()

Clear the memory utilization metrics data.