extras/vpp_if_stats/README.md

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