From 19ca78fbd7567c676beefc2b511dfdcd9f20201a Mon Sep 17 00:00:00 2001 From: Koren Lev Date: Wed, 21 Nov 2018 18:46:54 +0200 Subject: stats: golang vpp_if_stats_client see README for details Change-Id: Ida603ccaee21dabc903512699b5b355cebb70320 Signed-off-by: Koren Lev --- extras/vpp_if_stats/README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100755 extras/vpp_if_stats/README.md (limited to 'extras/vpp_if_stats/README.md') diff --git a/extras/vpp_if_stats/README.md b/extras/vpp_if_stats/README.md new file mode 100755 index 00000000000..7185d6cb5b1 --- /dev/null +++ b/extras/vpp_if_stats/README.md @@ -0,0 +1,35 @@ +# VPP interface stats client + +This is a source code and a binary of a 'thin client' to collect, +aggregate and expose VPP interface stats through VPP stats socket API. +It also provides some information about the installed VPP version. + +This can be used by monitoring systems that needs to grab those details +through a simple executable client with no dependencies. + +example use case: where VPP runs in a container that can't expose the socket API to the host level + + +## Prerequisites (for building) + +**GoVPP** library (compatible with VPP 18.10) +vpp, vpp-api, vpp-lib + +## Building + +```bash +go get git.fd.io/govpp.git +go build +``` + +## Using (post-build for example on linux 64bit) + +```bash +./bin/vpp_if_stats_linux_amd64 +``` + +## Output examples + +[JSON schema](./response_schema.json) +[Example](./response_example.json) + -- cgit 1.2.3-korg