public interface ControlPlaneMonitorService
Modifier and Type | Field and Description |
---|---|
static long |
TIMEOUT_MILLIS |
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.CompletableFuture<java.util.Set<java.lang.String>> |
availableResources(NodeId nodeId,
ControlResource.Type resourceType)
Obtains a list of names of available resources.
|
default java.util.Set<java.lang.String> |
availableResourcesSync(NodeId nodeId,
ControlResource.Type resourceType)
Synchronous version of availableResource.
|
java.util.concurrent.CompletableFuture<ControlLoadSnapshot> |
getLoad(NodeId nodeId,
ControlMetricType type,
int duration,
java.util.concurrent.TimeUnit unit,
java.util.Optional<DeviceId> deviceId)
Obtains snapshot of control plane load of a specific device with the
projected range.
|
java.util.concurrent.CompletableFuture<ControlLoadSnapshot> |
getLoad(NodeId nodeId,
ControlMetricType type,
int duration,
java.util.concurrent.TimeUnit unit,
java.lang.String resourceName)
Obtains snapshot of control plane load of a specific resource with the
projected range.
|
java.util.concurrent.CompletableFuture<ControlLoadSnapshot> |
getLoad(NodeId nodeId,
ControlMetricType type,
java.util.Optional<DeviceId> deviceId)
Obtains snapshot of control plane load of a specific device.
|
java.util.concurrent.CompletableFuture<ControlLoadSnapshot> |
getLoad(NodeId nodeId,
ControlMetricType type,
java.lang.String resourceName)
Obtains snapshot of control plane load of a specific resource.
|
default ControlLoadSnapshot |
getLoadSync(NodeId nodeId,
ControlMetricType type,
int duration,
java.util.concurrent.TimeUnit unit,
java.util.Optional<DeviceId> deviceId)
Synchronous version of getLoad.
|
default ControlLoadSnapshot |
getLoadSync(NodeId nodeId,
ControlMetricType type,
int duration,
java.util.concurrent.TimeUnit unit,
java.lang.String resourceName)
Synchronous version of getLoad.
|
default ControlLoadSnapshot |
getLoadSync(NodeId nodeId,
ControlMetricType type,
java.util.Optional<DeviceId> deviceId)
Synchronous version of getLoad.
|
default ControlLoadSnapshot |
getLoadSync(NodeId nodeId,
ControlMetricType type,
java.lang.String resourceName)
Synchronous version of getLoad.
|
void |
updateMetric(ControlMetric controlMetric,
int updateIntervalInMinutes,
java.util.Optional<DeviceId> deviceId)
Adds a new control metric value with a certain update interval.
|
void |
updateMetric(ControlMetric controlMetric,
int updateIntervalInMinutes,
java.lang.String resourceName)
Adds a new control metric value with a certain update interval.
|
static final long TIMEOUT_MILLIS
void updateMetric(ControlMetric controlMetric, int updateIntervalInMinutes, java.util.Optional<DeviceId> deviceId)
controlMetric
- control plane metric (e.g., control
message rate, cpu, memory, etc.)updateIntervalInMinutes
- value update interval (in minute)deviceId
- device identifiervoid updateMetric(ControlMetric controlMetric, int updateIntervalInMinutes, java.lang.String resourceName)
controlMetric
- control plane metric (e.g., disk and
network metrics)updateIntervalInMinutes
- value update interval (in minute)resourceName
- resource namejava.util.concurrent.CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId, ControlMetricType type, java.util.Optional<DeviceId> deviceId)
nodeId
- node identifiertype
- control metric typedeviceId
- device identifierdefault ControlLoadSnapshot getLoadSync(NodeId nodeId, ControlMetricType type, java.util.Optional<DeviceId> deviceId)
nodeId
- node identifiertype
- control metric typedeviceId
- device identifierjava.util.concurrent.CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId, ControlMetricType type, java.lang.String resourceName)
nodeId
- node identifiertype
- control metric typeresourceName
- resource namedefault ControlLoadSnapshot getLoadSync(NodeId nodeId, ControlMetricType type, java.lang.String resourceName)
nodeId
- node identifiertype
- control metric typeresourceName
- resource namejava.util.concurrent.CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId, ControlMetricType type, int duration, java.util.concurrent.TimeUnit unit, java.util.Optional<DeviceId> deviceId)
nodeId
- node identifiertype
- control metric typeduration
- projected durationunit
- projected time unitdeviceId
- device identifierdefault ControlLoadSnapshot getLoadSync(NodeId nodeId, ControlMetricType type, int duration, java.util.concurrent.TimeUnit unit, java.util.Optional<DeviceId> deviceId)
nodeId
- node identifiertype
- control metric typeduration
- projected durationunit
- projected time unitdeviceId
- device identifierjava.util.concurrent.CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId, ControlMetricType type, int duration, java.util.concurrent.TimeUnit unit, java.lang.String resourceName)
nodeId
- node identifiertype
- control metric typeduration
- projected durationunit
- projected time unitresourceName
- resource namedefault ControlLoadSnapshot getLoadSync(NodeId nodeId, ControlMetricType type, int duration, java.util.concurrent.TimeUnit unit, java.lang.String resourceName)
nodeId
- node identifiertype
- control metric typeduration
- projected durationunit
- projected time unitresourceName
- resource namejava.util.concurrent.CompletableFuture<java.util.Set<java.lang.String>> availableResources(NodeId nodeId, ControlResource.Type resourceType)
nodeId
- node identifierresourceType
- resource typedefault java.util.Set<java.lang.String> availableResourcesSync(NodeId nodeId, ControlResource.Type resourceType)
nodeId
- node identifierresourceType
- resource type