src/collectors/proc.plugin/proc_net_rpc_nfs.c
// SPDX-License-Identifier: GPL-3.0-or-later
#include "plugin_proc.h"
#define PLUGIN_PROC_MODULE_NFS_NAME "/proc/net/rpc/nfs"
#define CONFIG_SECTION_PLUGIN_PROC_NFS "plugin:" PLUGIN_PROC_CONFIG_NAME ":" PLUGIN_PROC_MODULE_NFS_NAME
struct nfs_procs {
char name[30];
unsigned long long value;
int present;
RRDDIM *rd;
};
struct nfs_procs nfs_proc2_values[] = {
{ "null" , 0ULL, 0, NULL}
, {"getattr" , 0ULL, 0, NULL}
, {"setattr" , 0ULL, 0, NULL}
, {"root" , 0ULL, 0, NULL}
, {"lookup" , 0ULL, 0, NULL}
, {"readlink", 0ULL, 0, NULL}
, {"read" , 0ULL, 0, NULL}
, {"wrcache" , 0ULL, 0, NULL}
, {"write" , 0ULL, 0, NULL}
, {"create" , 0ULL, 0, NULL}
, {"remove" , 0ULL, 0, NULL}
, {"rename" , 0ULL, 0, NULL}
, {"link" , 0ULL, 0, NULL}
, {"symlink" , 0ULL, 0, NULL}
, {"mkdir" , 0ULL, 0, NULL}
, {"rmdir" , 0ULL, 0, NULL}
, {"readdir" , 0ULL, 0, NULL}
, {"fsstat" , 0ULL, 0, NULL}
,
/* termination */
{ "" , 0ULL, 0, NULL}
};
struct nfs_procs nfs_proc3_values[] = {
{ "null" , 0ULL, 0, NULL}
, {"getattr" , 0ULL, 0, NULL}
, {"setattr" , 0ULL, 0, NULL}
, {"lookup" , 0ULL, 0, NULL}
, {"access" , 0ULL, 0, NULL}
, {"readlink" , 0ULL, 0, NULL}
, {"read" , 0ULL, 0, NULL}
, {"write" , 0ULL, 0, NULL}
, {"create" , 0ULL, 0, NULL}
, {"mkdir" , 0ULL, 0, NULL}
, {"symlink" , 0ULL, 0, NULL}
, {"mknod" , 0ULL, 0, NULL}
, {"remove" , 0ULL, 0, NULL}
, {"rmdir" , 0ULL, 0, NULL}
, {"rename" , 0ULL, 0, NULL}
, {"link" , 0ULL, 0, NULL}
, {"readdir" , 0ULL, 0, NULL}
, {"readdirplus", 0ULL, 0, NULL}
, {"fsstat" , 0ULL, 0, NULL}
, {"fsinfo" , 0ULL, 0, NULL}
, {"pathconf" , 0ULL, 0, NULL}
, {"commit" , 0ULL, 0, NULL}
,
/* termination */
{ "" , 0ULL, 0, NULL}
};
struct nfs_procs nfs_proc4_values[] = {
{ "null" , 0ULL, 0, NULL}
, {"read" , 0ULL, 0, NULL}
, {"write" , 0ULL, 0, NULL}
, {"commit" , 0ULL, 0, NULL}
, {"open" , 0ULL, 0, NULL}
, {"open_conf" , 0ULL, 0, NULL}
, {"open_noat" , 0ULL, 0, NULL}
, {"open_dgrd" , 0ULL, 0, NULL}
, {"close" , 0ULL, 0, NULL}
, {"setattr" , 0ULL, 0, NULL}
, {"fsinfo" , 0ULL, 0, NULL}
, {"renew" , 0ULL, 0, NULL}
, {"setclntid" , 0ULL, 0, NULL}
, {"confirm" , 0ULL, 0, NULL}
, {"lock" , 0ULL, 0, NULL}
, {"lockt" , 0ULL, 0, NULL}
, {"locku" , 0ULL, 0, NULL}
, {"access" , 0ULL, 0, NULL}
, {"getattr" , 0ULL, 0, NULL}
, {"lookup" , 0ULL, 0, NULL}
, {"lookup_root" , 0ULL, 0, NULL}
, {"remove" , 0ULL, 0, NULL}
, {"rename" , 0ULL, 0, NULL}
, {"link" , 0ULL, 0, NULL}
, {"symlink" , 0ULL, 0, NULL}
, {"create" , 0ULL, 0, NULL}
, {"pathconf" , 0ULL, 0, NULL}
, {"statfs" , 0ULL, 0, NULL}
, {"readlink" , 0ULL, 0, NULL}
, {"readdir" , 0ULL, 0, NULL}
, {"server_caps" , 0ULL, 0, NULL}
, {"delegreturn" , 0ULL, 0, NULL}
, {"getacl" , 0ULL, 0, NULL}
, {"setacl" , 0ULL, 0, NULL}
, {"fs_locations" , 0ULL, 0, NULL}
, {"rel_lkowner" , 0ULL, 0, NULL}
, {"secinfo" , 0ULL, 0, NULL}
, {"fsid_present" , 0ULL, 0, NULL}
,
/* nfsv4.1 client ops */
{ "exchange_id" , 0ULL, 0, NULL}
, {"create_session" , 0ULL, 0, NULL}
, {"destroy_session" , 0ULL, 0, NULL}
, {"sequence" , 0ULL, 0, NULL}
, {"get_lease_time" , 0ULL, 0, NULL}
, {"reclaim_comp" , 0ULL, 0, NULL}
, {"layoutget" , 0ULL, 0, NULL}
, {"getdevinfo" , 0ULL, 0, NULL}
, {"layoutcommit" , 0ULL, 0, NULL}
, {"layoutreturn" , 0ULL, 0, NULL}
, {"secinfo_no" , 0ULL, 0, NULL}
, {"test_stateid" , 0ULL, 0, NULL}
, {"free_stateid" , 0ULL, 0, NULL}
, {"getdevicelist" , 0ULL, 0, NULL}
, {"bind_conn_to_ses", 0ULL, 0, NULL}
, {"destroy_clientid", 0ULL, 0, NULL}
,
/* nfsv4.2 client ops */
{ "seek" , 0ULL, 0, NULL}
, {"allocate" , 0ULL, 0, NULL}
, {"deallocate" , 0ULL, 0, NULL}
, {"layoutstats" , 0ULL, 0, NULL}
, {"clone" , 0ULL, 0, NULL}
,
/* termination */
{ "" , 0ULL, 0, NULL}
};
int do_proc_net_rpc_nfs(int update_every, usec_t dt) {
(void)dt;
static procfile *ff = NULL;
static int do_net = -1, do_rpc = -1, do_proc2 = -1, do_proc3 = -1, do_proc4 = -1;
static int proc2_warning = 0, proc3_warning = 0, proc4_warning = 0;
if(!ff) {
char filename[FILENAME_MAX + 1];
snprintfz(filename, FILENAME_MAX, "%s%s", netdata_configured_host_prefix, "/proc/net/rpc/nfs");
ff = procfile_open(config_get(CONFIG_SECTION_PLUGIN_PROC_NFS, "filename to monitor", filename), " \t", PROCFILE_FLAG_DEFAULT);
}
if(!ff) return 1;
ff = procfile_readall(ff);
if(!ff) return 0; // we return 0, so that we will retry to open it next time
if(do_net == -1) do_net = config_get_boolean(CONFIG_SECTION_PLUGIN_PROC_NFS, "network", 1);
if(do_rpc == -1) do_rpc = config_get_boolean(CONFIG_SECTION_PLUGIN_PROC_NFS, "rpc", 1);
if(do_proc2 == -1) do_proc2 = config_get_boolean(CONFIG_SECTION_PLUGIN_PROC_NFS, "NFS v2 procedures", 1);
if(do_proc3 == -1) do_proc3 = config_get_boolean(CONFIG_SECTION_PLUGIN_PROC_NFS, "NFS v3 procedures", 1);
if(do_proc4 == -1) do_proc4 = config_get_boolean(CONFIG_SECTION_PLUGIN_PROC_NFS, "NFS v4 procedures", 1);
// if they are enabled, reset them to 1
// later we do them =2 to avoid doing strcmp() for all lines
if(do_net) do_net = 1;
if(do_rpc) do_rpc = 1;
if(do_proc2) do_proc2 = 1;
if(do_proc3) do_proc3 = 1;
if(do_proc4) do_proc4 = 1;
size_t lines = procfile_lines(ff), l;
char *type;
unsigned long long net_count = 0, net_udp_count = 0, net_tcp_count = 0, net_tcp_connections = 0;
unsigned long long rpc_calls = 0, rpc_retransmits = 0, rpc_auth_refresh = 0;
for(l = 0; l < lines ;l++) {
size_t words = procfile_linewords(ff, l);
if(!words) continue;
type = procfile_lineword(ff, l, 0);
if(do_net == 1 && strcmp(type, "net") == 0) {
if(words < 5) {
collector_error("%s line of /proc/net/rpc/nfs has %zu words, expected %d", type, words, 5);
continue;
}
net_count = str2ull(procfile_lineword(ff, l, 1), NULL);
net_udp_count = str2ull(procfile_lineword(ff, l, 2), NULL);
net_tcp_count = str2ull(procfile_lineword(ff, l, 3), NULL);
net_tcp_connections = str2ull(procfile_lineword(ff, l, 4), NULL);
unsigned long long sum = net_count + net_udp_count + net_tcp_count + net_tcp_connections;
if(sum == 0ULL) do_net = -1;
else do_net = 2;
}
else if(do_rpc == 1 && strcmp(type, "rpc") == 0) {
if(words < 4) {
collector_error("%s line of /proc/net/rpc/nfs has %zu words, expected %d", type, words, 6);
continue;
}
rpc_calls = str2ull(procfile_lineword(ff, l, 1), NULL);
rpc_retransmits = str2ull(procfile_lineword(ff, l, 2), NULL);
rpc_auth_refresh = str2ull(procfile_lineword(ff, l, 3), NULL);
unsigned long long sum = rpc_calls + rpc_retransmits + rpc_auth_refresh;
if(sum == 0ULL) do_rpc = -1;
else do_rpc = 2;
}
else if(do_proc2 == 1 && strcmp(type, "proc2") == 0) {
// the first number is the count of numbers present
// so we start for word 2
unsigned long long sum = 0;
unsigned int i, j;
for(i = 0, j = 2; j < words && nfs_proc2_values[i].name[0] ; i++, j++) {
nfs_proc2_values[i].value = str2ull(procfile_lineword(ff, l, j), NULL);
nfs_proc2_values[i].present = 1;
sum += nfs_proc2_values[i].value;
}
if(sum == 0ULL) {
if(!proc2_warning) {
collector_error("Disabling /proc/net/rpc/nfs v2 procedure calls chart. It seems unused on this machine. It will be enabled automatically when found with data in it.");
proc2_warning = 1;
}
do_proc2 = 0;
}
else do_proc2 = 2;
}
else if(do_proc3 == 1 && strcmp(type, "proc3") == 0) {
// the first number is the count of numbers present
// so we start for word 2
unsigned long long sum = 0;
unsigned int i, j;
for(i = 0, j = 2; j < words && nfs_proc3_values[i].name[0] ; i++, j++) {
nfs_proc3_values[i].value = str2ull(procfile_lineword(ff, l, j), NULL);
nfs_proc3_values[i].present = 1;
sum += nfs_proc3_values[i].value;
}
if(sum == 0ULL) {
if(!proc3_warning) {
collector_info("Disabling /proc/net/rpc/nfs v3 procedure calls chart. It seems unused on this machine. It will be enabled automatically when found with data in it.");
proc3_warning = 1;
}
do_proc3 = 0;
}
else do_proc3 = 2;
}
else if(do_proc4 == 1 && strcmp(type, "proc4") == 0) {
// the first number is the count of numbers present
// so we start for word 2
unsigned long long sum = 0;
unsigned int i, j;
for(i = 0, j = 2; j < words && nfs_proc4_values[i].name[0] ; i++, j++) {
nfs_proc4_values[i].value = str2ull(procfile_lineword(ff, l, j), NULL);
nfs_proc4_values[i].present = 1;
sum += nfs_proc4_values[i].value;
}
if(sum == 0ULL) {
if(!proc4_warning) {
collector_info("Disabling /proc/net/rpc/nfs v4 procedure calls chart. It seems unused on this machine. It will be enabled automatically when found with data in it.");
proc4_warning = 1;
}
do_proc4 = 0;
}
else do_proc4 = 2;
}
}
if(do_net == 2) {
static RRDSET *st = NULL;
static RRDDIM *rd_udp = NULL,
*rd_tcp = NULL;
if(unlikely(!st)) {
st = rrdset_create_localhost(
"nfs"
, "net"
, NULL
, "network"
, NULL
, "NFS Client Network"
, "operations/s"
, PLUGIN_PROC_NAME
, PLUGIN_PROC_MODULE_NFS_NAME
, NETDATA_CHART_PRIO_NFS_NET
, update_every
, RRDSET_TYPE_STACKED
);
rrdset_flag_set(st, RRDSET_FLAG_DETAIL);
rd_udp = rrddim_add(st, "udp", NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
rd_tcp = rrddim_add(st, "tcp", NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
}
// ignore net_count, net_tcp_connections
(void)net_count;
(void)net_tcp_connections;
rrddim_set_by_pointer(st, rd_udp, net_udp_count);
rrddim_set_by_pointer(st, rd_tcp, net_tcp_count);
rrdset_done(st);
}
if(do_rpc == 2) {
static RRDSET *st = NULL;
static RRDDIM *rd_calls = NULL,
*rd_retransmits = NULL,
*rd_auth_refresh = NULL;
if(unlikely(!st)) {
st = rrdset_create_localhost(
"nfs"
, "rpc"
, NULL
, "rpc"
, NULL
, "NFS Client Remote Procedure Calls Statistics"
, "calls/s"
, PLUGIN_PROC_NAME
, PLUGIN_PROC_MODULE_NFS_NAME
, NETDATA_CHART_PRIO_NFS_RPC
, update_every
, RRDSET_TYPE_LINE
);
rrdset_flag_set(st, RRDSET_FLAG_DETAIL);
rd_calls = rrddim_add(st, "calls", NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
rd_retransmits = rrddim_add(st, "retransmits", NULL, -1, 1, RRD_ALGORITHM_INCREMENTAL);
rd_auth_refresh = rrddim_add(st, "auth_refresh", NULL, -1, 1, RRD_ALGORITHM_INCREMENTAL);
}
rrddim_set_by_pointer(st, rd_calls, rpc_calls);
rrddim_set_by_pointer(st, rd_retransmits, rpc_retransmits);
rrddim_set_by_pointer(st, rd_auth_refresh, rpc_auth_refresh);
rrdset_done(st);
}
if(do_proc2 == 2) {
static RRDSET *st = NULL;
if(unlikely(!st)) {
st = rrdset_create_localhost(
"nfs"
, "proc2"
, NULL
, "nfsv2rpc"
, NULL
, "NFS v2 Client Remote Procedure Calls"
, "calls/s"
, PLUGIN_PROC_NAME
, PLUGIN_PROC_MODULE_NFS_NAME
, NETDATA_CHART_PRIO_NFS_PROC2
, update_every
, RRDSET_TYPE_STACKED
);
}
size_t i;
for(i = 0; nfs_proc2_values[i].present ; i++) {
if(unlikely(!nfs_proc2_values[i].rd))
nfs_proc2_values[i].rd = rrddim_add(st, nfs_proc2_values[i].name, NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
rrddim_set_by_pointer(st, nfs_proc2_values[i].rd, nfs_proc2_values[i].value);
}
rrdset_done(st);
}
if(do_proc3 == 2) {
static RRDSET *st = NULL;
if(unlikely(!st)) {
st = rrdset_create_localhost(
"nfs"
, "proc3"
, NULL
, "nfsv3rpc"
, NULL
, "NFS v3 Client Remote Procedure Calls"
, "calls/s"
, PLUGIN_PROC_NAME
, PLUGIN_PROC_MODULE_NFS_NAME
, NETDATA_CHART_PRIO_NFS_PROC3
, update_every
, RRDSET_TYPE_STACKED
);
}
size_t i;
for(i = 0; nfs_proc3_values[i].present ; i++) {
if(unlikely(!nfs_proc3_values[i].rd))
nfs_proc3_values[i].rd = rrddim_add(st, nfs_proc3_values[i].name, NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
rrddim_set_by_pointer(st, nfs_proc3_values[i].rd, nfs_proc3_values[i].value);
}
rrdset_done(st);
}
if(do_proc4 == 2) {
static RRDSET *st = NULL;
if(unlikely(!st)) {
st = rrdset_create_localhost(
"nfs"
, "proc4"
, NULL
, "nfsv4rpc"
, NULL
, "NFS v4 Client Remote Procedure Calls"
, "calls/s"
, PLUGIN_PROC_NAME
, PLUGIN_PROC_MODULE_NFS_NAME
, NETDATA_CHART_PRIO_NFS_PROC4
, update_every
, RRDSET_TYPE_STACKED
);
}
size_t i;
for(i = 0; nfs_proc4_values[i].present ; i++) {
if(unlikely(!nfs_proc4_values[i].rd))
nfs_proc4_values[i].rd = rrddim_add(st, nfs_proc4_values[i].name, NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
rrddim_set_by_pointer(st, nfs_proc4_values[i].rd, nfs_proc4_values[i].value);
}
rrdset_done(st);
}
return 0;
}