3 VPP stats segment FUSE filesystem
4 =================================
6 The statfs binary allows to create a FUSE filesystem to expose and to
7 browse the stats segment. It relies on the Go-FUSE library and requires
8 Go-VPP stats bindings to work.
10 The binary mounts a filesystem on the local machine with the data from
11 the stats segments. The counters can be opened and read as files
12 (e.g. in a Unix shell). Note that the value of a counter is determined
13 when the corresponding file is opened (as for /proc/interrupts).
15 Directories update their contents on epoch changes so that new counters
16 get added to the filesystem.
18 The script ``install.sh`` is responsible for building and installing
24 The local Makefile contains targets for all the possible interactions
25 with the stats_f binary.
48 Starts the filesystem. Requires a running VPP instance using the default
49 socket /run/vpp/stats.sock.
51 May require a privileged user (sudo)
60 Stops and unmounts the filesystem if it is not busy.
62 May require a privileged user (sudo)
71 Forces the unmount of the filesystem even if it is busy.
73 May require a privileged user (sudo)
82 Cleaning stats_fs binary.
84 May require a privileged user (sudo).
90 Browsing the filesystem
91 -----------------------
93 The default mountpoint is /run/vpp/stats_fs_dir. You can browse the
94 filesystem as a regular user. Example:
98 cd /run/vpp/stats_fs_dir
103 Building and mounting the filesystem manually
104 ---------------------------------------------
106 For more modularity, you can build and mount the filesystem manually.
111 Inside the local directory, you can build the go binary:
120 Then, you can mount the filesystem with the local binary.
122 May require a privileged user (sudo).
128 ./stats_fs <MOUNT_POINT>
130 **Options:** - debug <true|false> (default is false) - socket
131 <statSocket> (default is /run/vpp/stats.sock) : VPP socket for stats
133 Unmounting the file system
134 ~~~~~~~~~~~~~~~~~~~~~~~~~~
136 You can unmount the filesystem with the fusermount command.
138 May require a privileged user (sudo)
142 fusermount -u /path/to/mountpoint
144 To force the unmount even if the resource is busy, add the -z option:
148 fusermount -uz /path/to/mountpoint