extras/vpp_if_stats/README.rst

   1 .. _if_stats_client_doc:
   2
   3 VPP interface stats client
   4 ==========================
   5
   6 This is a source code and a binary of a ‘thin client’ to collect,
   7 aggregate and expose VPP interface stats through VPP stats socket API.
   8 It also provides some information about the installed VPP version.
   9
  10 This can be used by monitoring systems that needs to grab those details
  11 through a simple executable client with no dependencies.
  12
  13 example use case: where VPP runs in a container that can’t expose the
  14 socket API to the host level
  15
  16 Prerequisites (for building)
  17 ----------------------------
  18
  19 **GoVPP** library (compatible with VPP 18.10) vpp, vpp-api, vpp-lib
  20
  21 Building
  22 --------
  23
  24 .. code:: bash
  25
  26    go get git.fd.io/govpp.git
  27    go build
  28
  29 Using (post-build for example on linux 64bit)
  30 ---------------------------------------------
  31
  32 .. code:: bash
  33
  34    ./bin/vpp_if_stats_linux_amd64
  35
  36 Output examples
  37 ---------------
  38
  39 `JSON schema <./response_schema.json>`__
  40 `Example <./response_example.json>`__