apps/cpman/api/src/main/java/org/onosproject/cpman/ControlPlaneMonitorService.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.cpman;

import com.google.common.collect.ImmutableSet;
import org.onlab.util.Tools;
import org.onosproject.cluster.NodeId;
import org.onosproject.net.DeviceId;

import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

import static org.onosproject.cpman.ControlResource.Type;

/**
 * Control Plane Statistics Service Interface.
 */
public interface ControlPlaneMonitorService {

    long TIMEOUT_MILLIS = 2000;

    /**
     * Adds a new control metric value with a certain update interval.
     *
     * @param controlMetric           control plane metric (e.g., control
     *                                message rate, cpu, memory, etc.)
     * @param updateIntervalInMinutes value update interval (in minute)
     * @param deviceId                device identifier
     */
    void updateMetric(ControlMetric controlMetric, int updateIntervalInMinutes,
                      Optional<DeviceId> deviceId);

    /**
     * Adds a new control metric value with a certain update interval.
     *
     * @param controlMetric           control plane metric (e.g., disk and
     *                                network metrics)
     * @param updateIntervalInMinutes value update interval (in minute)
     * @param resourceName            resource name
     */
    void updateMetric(ControlMetric controlMetric, int updateIntervalInMinutes,
                      String resourceName);

    /**
     * Obtains snapshot of control plane load of a specific device.
     * The metrics range from control messages and system metrics
     * (e.g., CPU and memory info).
     * If the device id is not specified, it returns system metrics, otherwise,
     * it returns control message stats of the given device.
     *
     * @param nodeId   node identifier
     * @param type     control metric type
     * @param deviceId device identifier
     * @return completable future object of control load snapshot
     */
    CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId,
                                                   ControlMetricType type,
                                                   Optional<DeviceId> deviceId);

    /**
     * Synchronous version of getLoad.
     * Obtains snapshot of control plane load of a specific device.
     * The metrics range from control messages and system metrics
     * (e.g., CPU and memory info).
     * If the device id is not specified, it returns system metrics, otherwise,
     * it returns control message stats of the given device.
     *
     * @param nodeId   node identifier
     * @param type     control metric type
     * @param deviceId device identifier
     * @return control load snapshot
     */
    default ControlLoadSnapshot getLoadSync(NodeId nodeId,
                                            ControlMetricType type,
                                            Optional<DeviceId> deviceId) {
        return Tools.futureGetOrElse(getLoad(nodeId, type, deviceId),
                TIMEOUT_MILLIS, TimeUnit.MILLISECONDS, null);
    }

    /**
     * Obtains snapshot of control plane load of a specific resource.
     * The metrics include I/O device metrics (e.g., disk and network metrics).
     *
     * @param nodeId       node identifier
     * @param type         control metric type
     * @param resourceName resource name
     * @return completable future object of control load snapshot
     */
    CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId,
                                                   ControlMetricType type,
                                                   String resourceName);

    /**
     * Synchronous version of getLoad.
     * Obtains snapshot of control plane load of a specific resource.
     * The metrics include I/O device metrics (e.g., disk and network metrics).
     *
     * @param nodeId       node identifier
     * @param type         control metric type
     * @param resourceName resource name
     * @return control load snapshot
     */
    default ControlLoadSnapshot getLoadSync(NodeId nodeId,
                                            ControlMetricType type,
                                            String resourceName) {
        return Tools.futureGetOrElse(getLoad(nodeId, type, resourceName),
                TIMEOUT_MILLIS, TimeUnit.MILLISECONDS, null);
    }

    /**
     * Obtains snapshot of control plane load of a specific device with the
     * projected range.
     *
     * @param nodeId   node identifier
     * @param type     control metric type
     * @param duration projected duration
     * @param unit     projected time unit
     * @param deviceId device identifier
     * @return completable future object of control load snapshot
     */
    CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId,
                                                   ControlMetricType type,
                                                   int duration, TimeUnit unit,
                                                   Optional<DeviceId> deviceId);

    /**
     * Synchronous version of getLoad.
     * Obtains snapshot of control plane load of a specific device with the
     * projected range.
     *
     * @param nodeId   node identifier
     * @param type     control metric type
     * @param duration projected duration
     * @param unit     projected time unit
     * @param deviceId device identifier
     * @return control load snapshot
     */
    default ControlLoadSnapshot getLoadSync(NodeId nodeId,
                                            ControlMetricType type,
                                            int duration, TimeUnit unit,
                                            Optional<DeviceId> deviceId) {
        return Tools.futureGetOrElse(getLoad(nodeId, type, duration, unit, deviceId),
                TIMEOUT_MILLIS, TimeUnit.MILLISECONDS, null);
    }

    /**
     * Obtains snapshot of control plane load of a specific resource with the
     * projected range.
     *
     * @param nodeId       node identifier
     * @param type         control metric type
     * @param duration     projected duration
     * @param unit         projected time unit
     * @param resourceName resource name
     * @return completable future object of control load snapshot
     */
    CompletableFuture<ControlLoadSnapshot> getLoad(NodeId nodeId,
                                                   ControlMetricType type,
                                                   int duration, TimeUnit unit,
                                                   String resourceName);

    /**
     * Synchronous version of getLoad.
     * Obtains snapshot of control plane load of a specific resource with the
     * projected range.
     *
     * @param nodeId       node identifier
     * @param type         control metric type
     * @param duration     projected duration
     * @param unit         projected time unit
     * @param resourceName resource name
     * @return control load snapshot
     */
    default ControlLoadSnapshot getLoadSync(NodeId nodeId,
                                            ControlMetricType type,
                                            int duration, TimeUnit unit,
                                            String resourceName) {
        return Tools.futureGetOrElse(getLoad(nodeId, type, duration, unit, resourceName),
                TIMEOUT_MILLIS, TimeUnit.MILLISECONDS, null);
    }

    /**
     * Obtains a list of names of available resources.
     *
     * @param nodeId       node identifier
     * @param resourceType resource type
     * @return completable future object of a collection of available resource names
     */
    CompletableFuture<Set<String>> availableResources(NodeId nodeId, Type resourceType);

    /**
     * Synchronous version of availableResource.
     * Obtains a list of names of available resources.
     *
     * @param nodeId       node identifier
     * @param resourceType resource type
     * @return a collection of available resource names
     */
    default Set<String> availableResourcesSync(NodeId nodeId, Type resourceType) {
        return Tools.futureGetOrElse(availableResources(nodeId, resourceType),
                TIMEOUT_MILLIS, TimeUnit.MILLISECONDS, ImmutableSet.of());
    }
}