Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.rest.resources; |
| 17 | |
| 18 | import java.util.Spliterator; |
| 19 | import java.util.Spliterators; |
| 20 | import java.util.stream.StreamSupport; |
| 21 | |
| 22 | import javax.ws.rs.GET; |
| 23 | import javax.ws.rs.Path; |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 24 | import javax.ws.rs.PathParam; |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 25 | import javax.ws.rs.Produces; |
| 26 | import javax.ws.rs.QueryParam; |
| 27 | import javax.ws.rs.core.Context; |
| 28 | import javax.ws.rs.core.MediaType; |
| 29 | import javax.ws.rs.core.Response; |
| 30 | import javax.ws.rs.core.UriBuilder; |
| 31 | import javax.ws.rs.core.UriInfo; |
| 32 | |
| 33 | import org.onosproject.codec.JsonCodec; |
| 34 | import org.onosproject.net.ConnectPoint; |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 35 | import org.onosproject.net.Device; |
| 36 | import org.onosproject.net.DeviceId; |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 37 | import org.onosproject.net.Link; |
Viswanath KSP | 8ffb775 | 2016-08-23 22:19:06 +0530 | [diff] [blame] | 38 | import org.onosproject.net.PortNumber; |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 39 | import org.onosproject.net.device.DeviceService; |
Srikanth Vavilapalli | d120f5c | 2015-11-24 14:15:01 -0800 | [diff] [blame] | 40 | import org.onosproject.net.device.PortStatistics; |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 41 | import org.onosproject.net.flow.FlowRuleService; |
| 42 | import org.onosproject.net.flow.TableStatisticsEntry; |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 43 | import org.onosproject.net.link.LinkService; |
| 44 | import org.onosproject.net.statistic.Load; |
| 45 | import org.onosproject.net.statistic.StatisticService; |
| 46 | import org.onosproject.rest.AbstractWebResource; |
| 47 | |
| 48 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 49 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 50 | |
| 51 | import static org.onosproject.net.DeviceId.deviceId; |
| 52 | import static org.onosproject.net.PortNumber.portNumber; |
| 53 | |
| 54 | /** |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 55 | * Query flow statistics. |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 56 | */ |
| 57 | @Path("statistics") |
| 58 | public class StatisticsWebResource extends AbstractWebResource { |
| 59 | @Context |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 60 | private UriInfo uriInfo; |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 61 | |
| 62 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 63 | * Gets load statistics for all links or for a specific link. |
| 64 | * |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 65 | * @onos.rsModel StatisticsFlowsLink |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 66 | * @param deviceId (optional) device ID for a specific link |
| 67 | * @param port (optional) port number for a specified link |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 68 | * @return 200 OK with JSON encoded array of Load objects |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 69 | */ |
| 70 | @GET |
| 71 | @Path("flows/link") |
| 72 | @Produces(MediaType.APPLICATION_JSON) |
| 73 | public Response getLoads(@QueryParam("device") String deviceId, |
| 74 | @QueryParam("port") String port) { |
| 75 | Iterable<Link> links; |
| 76 | |
| 77 | if (deviceId == null || port == null) { |
| 78 | links = get(LinkService.class).getLinks(); |
| 79 | } else { |
| 80 | ConnectPoint connectPoint = new ConnectPoint(deviceId(deviceId), |
| 81 | portNumber(port)); |
| 82 | links = get(LinkService.class).getLinks(connectPoint); |
| 83 | } |
| 84 | ObjectNode result = mapper().createObjectNode(); |
| 85 | ArrayNode loads = mapper().createArrayNode(); |
| 86 | JsonCodec<Load> loadCodec = codec(Load.class); |
| 87 | StatisticService statsService = getService(StatisticService.class); |
| 88 | |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 89 | StreamSupport.stream(Spliterators.spliteratorUnknownSize( |
| 90 | links.iterator(), Spliterator.ORDERED), false) |
| 91 | .forEach(link -> { |
| 92 | ObjectNode loadNode = loadCodec.encode(statsService.load(link), this); |
| 93 | |
| 94 | UriBuilder locationBuilder = uriInfo.getBaseUriBuilder() |
| 95 | .path("links") |
| 96 | .queryParam("device", link.src().deviceId().toString()) |
| 97 | .queryParam("port", link.src().port().toString()); |
| 98 | loadNode.put("link", locationBuilder.build().toString()); |
| 99 | loads.add(loadNode); |
| 100 | }); |
| 101 | result.set("loads", loads); |
| 102 | return ok(result).build(); |
| 103 | } |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 104 | |
| 105 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 106 | * Gets table statistics for all tables of all devices. |
| 107 | * |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 108 | * @onos.rsModel StatisticsFlowsTables |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 109 | * @return 200 OK with JSON encoded array of table statistics |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 110 | */ |
| 111 | @GET |
| 112 | @Path("flows/tables") |
| 113 | @Produces(MediaType.APPLICATION_JSON) |
| 114 | public Response getTableStatistics() { |
| 115 | final FlowRuleService service = get(FlowRuleService.class); |
| 116 | final Iterable<Device> devices = get(DeviceService.class).getDevices(); |
| 117 | final ObjectNode root = mapper().createObjectNode(); |
andrea | 1ce2bc8 | 2015-11-18 16:58:10 -0800 | [diff] [blame] | 118 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 119 | for (final Device device : devices) { |
| 120 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 121 | deviceStatsNode.put("device", device.id().toString()); |
andrea | 1ce2bc8 | 2015-11-18 16:58:10 -0800 | [diff] [blame] | 122 | final ArrayNode statisticsNode = deviceStatsNode.putArray("table"); |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 123 | final Iterable<TableStatisticsEntry> tableStatsEntries = service.getFlowTableStatistics(device.id()); |
| 124 | if (tableStatsEntries != null) { |
| 125 | for (final TableStatisticsEntry entry : tableStatsEntries) { |
| 126 | statisticsNode.add(codec(TableStatisticsEntry.class).encode(entry, this)); |
| 127 | } |
| 128 | } |
| 129 | rootArrayNode.add(deviceStatsNode); |
| 130 | } |
| 131 | |
| 132 | return ok(root).build(); |
| 133 | } |
| 134 | |
| 135 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 136 | * Gets table statistics for all tables of a specified device. |
| 137 | * |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 138 | * @onos.rsModel StatisticsFlowsTables |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 139 | * @param deviceId device ID |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 140 | * @return 200 OK with JSON encoded array of table statistics |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 141 | */ |
| 142 | @GET |
| 143 | @Path("flows/tables/{deviceId}") |
| 144 | @Produces(MediaType.APPLICATION_JSON) |
| 145 | public Response getTableStatisticsByDeviceId(@PathParam("deviceId") String deviceId) { |
| 146 | final FlowRuleService service = get(FlowRuleService.class); |
| 147 | final Iterable<TableStatisticsEntry> tableStatisticsEntries = |
| 148 | service.getFlowTableStatistics(DeviceId.deviceId(deviceId)); |
| 149 | final ObjectNode root = mapper().createObjectNode(); |
andrea | 1ce2bc8 | 2015-11-18 16:58:10 -0800 | [diff] [blame] | 150 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 151 | |
| 152 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 153 | deviceStatsNode.put("device", deviceId); |
andrea | 1ce2bc8 | 2015-11-18 16:58:10 -0800 | [diff] [blame] | 154 | final ArrayNode statisticsNode = deviceStatsNode.putArray("table"); |
Srikanth Vavilapalli | 95810f5 | 2015-09-14 15:49:56 -0700 | [diff] [blame] | 155 | for (final TableStatisticsEntry entry : tableStatisticsEntries) { |
| 156 | statisticsNode.add(codec(TableStatisticsEntry.class).encode(entry, this)); |
| 157 | } |
| 158 | rootArrayNode.add(deviceStatsNode); |
| 159 | return ok(root).build(); |
| 160 | } |
Srikanth Vavilapalli | d120f5c | 2015-11-24 14:15:01 -0800 | [diff] [blame] | 161 | |
| 162 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 163 | * Gets port statistics of all devices. |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 164 | * @onos.rsModel StatisticsPorts |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 165 | * @return 200 OK with JSON encoded array of port statistics |
Srikanth Vavilapalli | d120f5c | 2015-11-24 14:15:01 -0800 | [diff] [blame] | 166 | */ |
| 167 | @GET |
| 168 | @Path("ports") |
| 169 | @Produces(MediaType.APPLICATION_JSON) |
| 170 | public Response getPortStatistics() { |
| 171 | final DeviceService service = get(DeviceService.class); |
| 172 | final Iterable<Device> devices = service.getDevices(); |
| 173 | final ObjectNode root = mapper().createObjectNode(); |
| 174 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
| 175 | for (final Device device : devices) { |
| 176 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 177 | deviceStatsNode.put("device", device.id().toString()); |
| 178 | final ArrayNode statisticsNode = deviceStatsNode.putArray("ports"); |
| 179 | final Iterable<PortStatistics> portStatsEntries = service.getPortStatistics(device.id()); |
| 180 | if (portStatsEntries != null) { |
| 181 | for (final PortStatistics entry : portStatsEntries) { |
| 182 | statisticsNode.add(codec(PortStatistics.class).encode(entry, this)); |
| 183 | } |
| 184 | } |
| 185 | rootArrayNode.add(deviceStatsNode); |
| 186 | } |
| 187 | |
| 188 | return ok(root).build(); |
| 189 | } |
| 190 | |
| 191 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 192 | * Gets port statistics of a specified devices. |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 193 | * @onos.rsModel StatisticsPorts |
Srikanth Vavilapalli | d120f5c | 2015-11-24 14:15:01 -0800 | [diff] [blame] | 194 | * @param deviceId device ID |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 195 | * @return 200 OK with JSON encoded array of port statistics |
Srikanth Vavilapalli | d120f5c | 2015-11-24 14:15:01 -0800 | [diff] [blame] | 196 | */ |
| 197 | @GET |
| 198 | @Path("ports/{deviceId}") |
| 199 | @Produces(MediaType.APPLICATION_JSON) |
| 200 | public Response getPortStatisticsByDeviceId(@PathParam("deviceId") String deviceId) { |
| 201 | final DeviceService service = get(DeviceService.class); |
| 202 | final Iterable<PortStatistics> portStatsEntries = |
| 203 | service.getPortStatistics(DeviceId.deviceId(deviceId)); |
| 204 | final ObjectNode root = mapper().createObjectNode(); |
| 205 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
| 206 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 207 | deviceStatsNode.put("device", deviceId); |
| 208 | final ArrayNode statisticsNode = deviceStatsNode.putArray("ports"); |
| 209 | if (portStatsEntries != null) { |
| 210 | for (final PortStatistics entry : portStatsEntries) { |
| 211 | statisticsNode.add(codec(PortStatistics.class).encode(entry, this)); |
| 212 | } |
| 213 | } |
| 214 | rootArrayNode.add(deviceStatsNode); |
| 215 | |
| 216 | return ok(root).build(); |
| 217 | } |
| 218 | |
Viswanath KSP | 8ffb775 | 2016-08-23 22:19:06 +0530 | [diff] [blame] | 219 | /** |
| 220 | * Gets port statistics of a specified device and port. |
| 221 | * @onos.rsModel StatisticsPorts |
| 222 | * @param deviceId device ID |
| 223 | * @param port port |
| 224 | * @return 200 OK with JSON encoded array of port statistics for the specified port |
| 225 | */ |
| 226 | @GET |
| 227 | @Path("ports/{deviceId}/{port}") |
| 228 | @Produces(MediaType.APPLICATION_JSON) |
| 229 | public Response getPortStatisticsByDeviceIdAndPort(@PathParam("deviceId") String deviceId, |
| 230 | @PathParam("port") String port) { |
| 231 | final DeviceService service = get(DeviceService.class); |
| 232 | final PortNumber portNumber = portNumber(port); |
| 233 | final PortStatistics portStatsEntry = |
| 234 | service.getStatisticsForPort(DeviceId.deviceId(deviceId), portNumber); |
| 235 | final ObjectNode root = mapper().createObjectNode(); |
| 236 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
| 237 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 238 | deviceStatsNode.put("device", deviceId); |
| 239 | final ArrayNode statisticsNode = deviceStatsNode.putArray("ports"); |
| 240 | if (portStatsEntry != null) { |
| 241 | statisticsNode.add(codec(PortStatistics.class).encode(portStatsEntry, this)); |
| 242 | } |
| 243 | rootArrayNode.add(deviceStatsNode); |
| 244 | |
| 245 | return ok(root).build(); |
| 246 | } |
| 247 | |
Viswanath KSP | 13e5b51 | 2016-08-25 12:33:16 +0530 | [diff] [blame] | 248 | /** |
| 249 | * Gets port delta statistics of all devices. |
| 250 | * @onos.rsModel StatisticsPorts |
| 251 | * @return 200 OK with JSON encoded array of port delta statistics |
| 252 | */ |
| 253 | @GET |
| 254 | @Path("delta/ports") |
| 255 | @Produces(MediaType.APPLICATION_JSON) |
| 256 | public Response getPortDeltaStatistics() { |
| 257 | final DeviceService service = get(DeviceService.class); |
| 258 | final Iterable<Device> devices = service.getDevices(); |
| 259 | final ObjectNode root = mapper().createObjectNode(); |
| 260 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
| 261 | for (final Device device : devices) { |
| 262 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 263 | deviceStatsNode.put("device", device.id().toString()); |
| 264 | final ArrayNode statisticsNode = deviceStatsNode.putArray("ports"); |
| 265 | final Iterable<PortStatistics> portStatsEntries = service.getPortDeltaStatistics(device.id()); |
| 266 | if (portStatsEntries != null) { |
| 267 | for (final PortStatistics entry : portStatsEntries) { |
| 268 | statisticsNode.add(codec(PortStatistics.class).encode(entry, this)); |
| 269 | } |
| 270 | } |
| 271 | rootArrayNode.add(deviceStatsNode); |
| 272 | } |
| 273 | |
| 274 | return ok(root).build(); |
| 275 | } |
| 276 | |
| 277 | /** |
| 278 | * Gets port delta statistics of a specified devices. |
| 279 | * @onos.rsModel StatisticsPorts |
| 280 | * @param deviceId device ID |
| 281 | * @return 200 OK with JSON encoded array of port delta statistics |
| 282 | */ |
| 283 | @GET |
| 284 | @Path("delta/ports/{deviceId}") |
| 285 | @Produces(MediaType.APPLICATION_JSON) |
| 286 | public Response getPortDeltaStatisticsByDeviceId(@PathParam("deviceId") String deviceId) { |
| 287 | final DeviceService service = get(DeviceService.class); |
| 288 | final Iterable<PortStatistics> portStatsEntries = |
| 289 | service.getPortDeltaStatistics(DeviceId.deviceId(deviceId)); |
| 290 | final ObjectNode root = mapper().createObjectNode(); |
| 291 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
| 292 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 293 | deviceStatsNode.put("device", deviceId); |
| 294 | final ArrayNode statisticsNode = deviceStatsNode.putArray("ports"); |
| 295 | if (portStatsEntries != null) { |
| 296 | for (final PortStatistics entry : portStatsEntries) { |
| 297 | statisticsNode.add(codec(PortStatistics.class).encode(entry, this)); |
| 298 | } |
| 299 | } |
| 300 | rootArrayNode.add(deviceStatsNode); |
| 301 | |
| 302 | return ok(root).build(); |
| 303 | } |
| 304 | |
| 305 | /** |
| 306 | * Gets port delta statistics of a specified device and port. |
| 307 | * @onos.rsModel StatisticsPorts |
| 308 | * @param deviceId device ID |
| 309 | * @param port port |
| 310 | * @return 200 OK with JSON encoded array of port delta statistics for the specified port |
| 311 | */ |
| 312 | @GET |
| 313 | @Path("delta/ports/{deviceId}/{port}") |
| 314 | @Produces(MediaType.APPLICATION_JSON) |
| 315 | public Response getPortDeltaStatisticsByDeviceIdAndPort(@PathParam("deviceId") String deviceId, |
| 316 | @PathParam("port") String port) { |
| 317 | final DeviceService service = get(DeviceService.class); |
| 318 | final PortNumber portNumber = portNumber(port); |
| 319 | final PortStatistics portStatsEntry = |
| 320 | service.getDeltaStatisticsForPort(DeviceId.deviceId(deviceId), portNumber); |
| 321 | final ObjectNode root = mapper().createObjectNode(); |
| 322 | final ArrayNode rootArrayNode = root.putArray("statistics"); |
| 323 | final ObjectNode deviceStatsNode = mapper().createObjectNode(); |
| 324 | deviceStatsNode.put("device", deviceId); |
| 325 | final ArrayNode statisticsNode = deviceStatsNode.putArray("ports"); |
| 326 | if (portStatsEntry != null) { |
| 327 | statisticsNode.add(codec(PortStatistics.class).encode(portStatsEntry, this)); |
| 328 | } |
| 329 | rootArrayNode.add(deviceStatsNode); |
| 330 | |
| 331 | return ok(root).build(); |
| 332 | } |
| 333 | |
Ray Milkey | b9af946 | 2015-07-17 11:12:09 -0700 | [diff] [blame] | 334 | } |