[ONOS-6879] Adding Controller Metrics Application, To retrive memory, Disk and CPU usage for all controller
Change-Id: I5976f0194555c1c3c42d6b6d09c468d6dfc983ff
diff --git a/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeCpuUsageCommand.java b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeCpuUsageCommand.java
new file mode 100644
index 0000000..a122791
--- /dev/null
+++ b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeCpuUsageCommand.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2017-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.nodemetrics.cli;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.cluster.NodeId;
+import org.onosproject.nodemetrics.NodeCpu;
+import org.onosproject.nodemetrics.NodeMetricsService;
+
+import java.util.Collection;
+import java.util.Objects;
+
+/**
+ * Lists cpu usage across nodes.
+ */
+@Command(scope = "onos", name = "node-cpu",
+ description = "Lists all node cpu utilization")
+public class ShowNodeCpuUsageCommand extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "nodeId", description = "Node identity",
+ required = false, multiValued = false)
+ String nodeId = null;
+ private NodeMetricsService nodeService = AbstractShellCommand
+ .get(NodeMetricsService.class);
+
+ @Override
+ protected void execute() {
+ if (nodeId != null) {
+ NodeCpu cpu = nodeService.cpu(NodeId.nodeId(nodeId));
+ if (Objects.nonNull(cpu)) {
+ print("CPU usage : %s ", cpu);
+ } else {
+ print("Node %s doesn't exists", nodeId);
+ }
+ } else {
+ Collection<NodeCpu> cpu = nodeService.cpu().values();
+ printCpuUsage(cpu);
+ }
+ }
+
+ private void printCpuUsage(Collection<NodeCpu> cpuList) {
+ cpuList.forEach(cpu -> print("%s", cpu));
+ }
+}
+
diff --git a/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeDiskUsageCommand.java b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeDiskUsageCommand.java
new file mode 100644
index 0000000..8dc0f09
--- /dev/null
+++ b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeDiskUsageCommand.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2017-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.nodemetrics.cli;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.cluster.NodeId;
+import org.onosproject.nodemetrics.NodeDiskUsage;
+import org.onosproject.nodemetrics.NodeMetricsService;
+
+import java.util.Collection;
+import java.util.Objects;
+
+/**
+ * Lists disk usage across nodes.
+ */
+@Command(scope = "onos", name = "node-disk",
+ description = "Lists all node disk utilization")
+public class ShowNodeDiskUsageCommand extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "nodeId", description = "Node identity",
+ required = false, multiValued = false)
+ String nodeId = null;
+ private NodeMetricsService nodeService = AbstractShellCommand
+ .get(NodeMetricsService.class);
+
+ @Override
+ protected void execute() {
+ if (nodeId != null) {
+ NodeDiskUsage disk = nodeService.disk(NodeId.nodeId(nodeId));
+ if (Objects.nonNull(disk)) {
+ print("Disk usage : %s", disk);
+ } else {
+ print("Node %s doesn't exists", nodeId);
+ }
+
+ } else {
+ Collection<NodeDiskUsage> disk = nodeService.disk().values();
+ printDiskUsage(disk);
+ }
+ }
+
+ private void printDiskUsage(Collection<NodeDiskUsage> diskList) {
+ diskList.forEach(disk -> print("%s", disk));
+ }
+}
diff --git a/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeMemoryCommand.java b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeMemoryCommand.java
new file mode 100644
index 0000000..3c6ec5b
--- /dev/null
+++ b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/ShowNodeMemoryCommand.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2017-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.nodemetrics.cli;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.cluster.NodeId;
+import org.onosproject.nodemetrics.NodeMemory;
+import org.onosproject.nodemetrics.NodeMetricsService;
+
+import java.util.Collection;
+import java.util.Objects;
+
+/**
+ * Lists memory usage across nodes.
+ */
+@Command(scope = "onos", name = "node-memory",
+ description = "Lists all node memory utilization")
+public class ShowNodeMemoryCommand extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "nodeId", description = "Node identity",
+ required = false, multiValued = false)
+ String nodeId = null;
+ private NodeMetricsService nodeService = AbstractShellCommand
+ .get(NodeMetricsService.class);
+
+ @Override
+ protected void execute() {
+ if (nodeId != null) {
+ NodeMemory memory = nodeService.memory(NodeId.nodeId(nodeId));
+ if (Objects.nonNull(memory)) {
+ print("Memory usage : %s", memory.toString());
+ } else {
+ print("Node %s doesn't exists");
+ }
+ } else {
+ Collection<NodeMemory> memory = nodeService.memory().values();
+ printMemory(memory);
+ }
+ }
+
+ private void printMemory(Collection<NodeMemory> memoryList) {
+ memoryList.forEach(memory -> print("%s", memory));
+ }
+}
diff --git a/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/package-info.java b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/package-info.java
new file mode 100644
index 0000000..d459482
--- /dev/null
+++ b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/cli/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2017-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.
+ */
+
+/**
+ * Module to fetch Node Metrics using CLI.
+ */
+package org.onosproject.nodemetrics.cli;
\ No newline at end of file
diff --git a/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/impl/NodeMetricsManager.java b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/impl/NodeMetricsManager.java
new file mode 100644
index 0000000..c91f9d8
--- /dev/null
+++ b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/impl/NodeMetricsManager.java
@@ -0,0 +1,196 @@
+/*
+ * Copyright 2017-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.nodemetrics.impl;
+
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.apache.felix.scr.annotations.Service;
+import org.hyperic.sigar.CpuPerc;
+import org.hyperic.sigar.FileSystemUsage;
+import org.hyperic.sigar.Mem;
+import org.hyperic.sigar.Sigar;
+import org.hyperic.sigar.SigarException;
+import org.onlab.util.KryoNamespace;
+import org.onlab.util.Tools;
+import org.onosproject.cluster.ClusterService;
+import org.onosproject.cluster.NodeId;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.nodemetrics.NodeCpu;
+import org.onosproject.nodemetrics.NodeDiskUsage;
+import org.onosproject.nodemetrics.NodeMemory;
+import org.onosproject.nodemetrics.NodeMetricsService;
+import org.onosproject.nodemetrics.Units;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.EventuallyConsistentMap;
+import org.onosproject.store.service.LogicalClockService;
+import org.onosproject.store.service.StorageService;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Map;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
+
+@Service
+@Component(immediate = true)
+public class NodeMetricsManager implements NodeMetricsService {
+ private static final int DEFAULT_POLL_FREQUENCY_SECONDS = 15;
+ private static final String SLASH = "/";
+ private static final Double PERCENTAGE_MULTIPLIER = 100.0;
+ private final Logger log = LoggerFactory
+ .getLogger(this.getClass());
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected CoreService coreService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected StorageService storageService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected ClusterService clusterService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected LogicalClockService clockService;
+
+ private ScheduledExecutorService metricsExecutor;
+ private ScheduledFuture<?> scheduledTask;
+
+ private ApplicationId appId;
+ private NodeId localNodeId;
+
+ private EventuallyConsistentMap<NodeId, NodeMemory> memoryStore;
+ private EventuallyConsistentMap<NodeId, NodeDiskUsage> diskStore;
+ private EventuallyConsistentMap<NodeId, NodeCpu> cpuStore;
+
+ private Sigar sigar;
+
+ @Activate
+ public void activate() {
+ appId = coreService
+ .registerApplication("org.onosproject.nodemetrics");
+ metricsExecutor = Executors.newSingleThreadScheduledExecutor(
+ Tools.groupedThreads("nodemetrics/pollingStatics",
+ "statistics-executor-%d", log));
+
+ localNodeId = clusterService.getLocalNode().id();
+ KryoNamespace.Builder serializer = KryoNamespace.newBuilder()
+ .register(KryoNamespaces.API)
+ .register(NodeMemory.class)
+ .register(NodeDiskUsage.class)
+ .register(NodeCpu.class)
+ .register(Units.class);
+ memoryStore = storageService.<NodeId, NodeMemory>eventuallyConsistentMapBuilder()
+ .withSerializer(serializer)
+ .withTimestampProvider((nodeId, memory) -> clockService.getTimestamp())
+ .withName("nodemetrics-memory")
+ .build();
+
+ diskStore = storageService.<NodeId, NodeDiskUsage>eventuallyConsistentMapBuilder()
+ .withSerializer(serializer)
+ .withTimestampProvider((nodeId, disk) -> clockService.getTimestamp())
+ .withName("nodemetrics-disk")
+ .build();
+
+ cpuStore = storageService.<NodeId, NodeCpu>eventuallyConsistentMapBuilder()
+ .withSerializer(serializer)
+ .withTimestampProvider((nodeId, cpu) -> clockService.getTimestamp())
+ .withName("nodemetrics-cpu")
+ .build();
+
+ scheduledTask = schedulePolling();
+ sigar = new Sigar();
+ pollMetrics();
+ }
+
+ @Deactivate
+ public void deactivate() {
+ scheduledTask.cancel(true);
+ metricsExecutor.shutdown();
+ sigar.close();
+ }
+
+ @Override
+ public Map<NodeId, NodeMemory> memory() {
+ return this.ecToMap(memoryStore);
+ }
+
+ @Override
+ public Map<NodeId, NodeDiskUsage> disk() {
+ return this.ecToMap(diskStore);
+ }
+
+ @Override
+ public Map<NodeId, NodeCpu> cpu() {
+ return this.ecToMap(cpuStore);
+ }
+
+ @Override
+ public NodeMemory memory(NodeId nodeid) {
+ return memoryStore.get(nodeid);
+ }
+
+ @Override
+ public NodeDiskUsage disk(NodeId nodeid) {
+ return diskStore.get(nodeid);
+ }
+
+ @Override
+ public NodeCpu cpu(NodeId nodeid) {
+ return cpuStore.get(nodeid);
+ }
+
+ private ScheduledFuture schedulePolling() {
+ return metricsExecutor.scheduleAtFixedRate(this::pollMetrics,
+ DEFAULT_POLL_FREQUENCY_SECONDS / 4,
+ DEFAULT_POLL_FREQUENCY_SECONDS, TimeUnit.SECONDS);
+ }
+
+ private <K, V> Map<K, V> ecToMap(EventuallyConsistentMap<K, V> ecMap) {
+ return ecMap.entrySet()
+ .stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+ }
+ private void pollMetrics() {
+ try {
+ CpuPerc cpu = sigar.getCpuPerc();
+ Mem mem = sigar.getMem();
+ FileSystemUsage disk = sigar.getFileSystemUsage(SLASH);
+
+ NodeMemory memoryNode = new NodeMemory.Builder().free(mem.getFree())
+ .used(mem.getUsed()).total(mem.getTotal()).withUnit(Units.BYTES)
+ .withNode(localNodeId).build();
+ NodeCpu cpuNode = new NodeCpu.Builder().withNode(localNodeId)
+ .usage(cpu.getCombined() * PERCENTAGE_MULTIPLIER).build();
+ NodeDiskUsage diskNode = new NodeDiskUsage.Builder().withNode(localNodeId)
+ .free(disk.getFree()).used(disk.getUsed()).withUnit(Units.KBYTES)
+ .total(disk.getTotal()).build();
+ diskStore.put(localNodeId, diskNode);
+ memoryStore.put(localNodeId, memoryNode);
+ cpuStore.put(localNodeId, cpuNode);
+
+ } catch (SigarException e) {
+ log.error("Exception occurred ", e);
+ }
+
+ }
+}
diff --git a/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/impl/package-info.java b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/impl/package-info.java
new file mode 100644
index 0000000..46ba85b
--- /dev/null
+++ b/apps/nodemetrics/mgr/src/main/java/org/onosproject/nodemetrics/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2017-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.
+ */
+
+/**
+ * Module to fetch Node Metrics and its Implementation.
+ */
+package org.onosproject.nodemetrics.impl;
\ No newline at end of file