benchmark/api/src/main/yang/rpcbenchmark.yang

   1 module rpcbenchmark {
   2     yang-version 1;
   3     namespace "urn:opendaylight:params:xml:ns:yang:rpcbenchmark";
   4     prefix "rpcbenchmark";
   5
   6     description
   7         "Copyright © 2015, 2018 Cisco Systems, Inc. and others.
   8
   9         This program and the accompanying materials are made available under the
  10         terms of the Eclipse Public License v1.0 which accompanies this distribution,
  11         and is available at http://www.eclipse.org/legal/epl-v10.html";
  12
  13     revision "2015-07-02" {
  14         description "Initial revision of rpcbenchmark model";
  15     }
  16
  17     rpc test-status {
  18         description
  19           "Get test status";
  20         output {
  21             leaf execStatus {
  22                 type enumeration {
  23                     enum "idle" {
  24                         value 1;
  25                     }
  26                     enum "executing" {
  27                         value 2;
  28                     }
  29                 }
  30             }
  31             leaf global-server-cnt {
  32                 type uint32;
  33                 default 0;
  34                 description
  35                   "The number of times the Global RPC server was invoked";
  36
  37             }
  38         }
  39     }
  40
  41     rpc start-test {
  42         description
  43             "Start a new RPC Benchmark test run";
  44
  45         input {
  46             leaf operation {
  47                 mandatory true;
  48                 type enumeration {
  49                     enum "GLOBAL-RTC" {
  50                         value 1;
  51                         description
  52                           "Use Global RPC service and run-to-completion client";
  53                     }
  54                     enum "ROUTED-RTC" {
  55                         value 2;
  56                         description
  57                           "Use routed RPC service and run-to-completion client. RPC server instances are
  58                             dynamically created when the test starts and deleted when the test finishes";
  59                     }
  60                 }
  61                 description
  62                     "RPC type and client type to use in the test";
  63             }
  64             leaf num-clients {
  65                 type uint32;
  66                 default 1;
  67                 description
  68                   "Number of clients (test client threads) to start";
  69             }
  70             leaf num-servers {
  71                 type uint32;
  72                 default 1;
  73                 description
  74                   "Number of RPC server instances. Only valid for routed RPCs.";
  75             }
  76
  77             leaf payload-size {
  78                 type uint32;
  79                 default 1;
  80                 description
  81                   "Input/Output payload size: number of elements in the list of integers that is the input and output RPC payload";
  82             }
  83             leaf iterations {
  84                 type uint32;
  85                 default 1;
  86                 description
  87                   "Number of calls to the specified RPC server that is to be made by each client";
  88             }
  89
  90         }
  91
  92         output {
  93             leaf global-rtc-client-ok {
  94                 type uint32;
  95                 default 0;
  96                 description
  97                   "Number of successful calls to the Global RPC Server for all test threads";
  98             }
  99             leaf global-rtc-client-error {
 100                 type uint32;
 101                 default 0;
 102                 description
 103                   "Number of failed calls to the Global RPC server from all test threads";
 104             }
 105             leaf exec-time {
 106                 type uint32;
 107                 default 0;
 108                 description
 109                   "Test execution time, in milliseconds";
 110             }
 111             leaf rate {
 112                 type uint32;
 113                 default 0;
 114                 description
 115                   "RPC rate (Number of RPCs/sec)";
 116             }
 117         }
 118     }
 119 }