51cbbd2282
- Add subpages definitions in appropriate section (User or Dev docs) for doc files (*.rst, *.md) that being listed at the top level of the generated doc page. - Generate and add API list to RELEASE doc. - Fix list_api_changes script to use HEAD as the endtag so it doesn't need to be changed every release. Change-Id: Iace7b6433359c6b96869cb1db01facbbcb0ac1e6 Signed-off-by: Dave Wallace <dwallacelf@gmail.com> (cherry picked from commit 11ee93f6abfaddf5bbd56cf0858c0c6ea0384b65)
36 lines
845 B
Markdown
Executable File
36 lines
845 B
Markdown
Executable File
# VPP interface stats client {#if_stats_client_doc}
|
|
|
|
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)
|
|
|