From 8c3e4eef78902a85970a2708ed307362a3045237 Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Mon, 7 Feb 2022 13:58:36 +0100 Subject: [PATCH] Add documentation --- collectors/README.md | 2 ++ collectors/nfs3Metric.md | 39 +++++++++++++++++++++++++ collectors/nfs4Metric.md | 62 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+) create mode 100644 collectors/nfs3Metric.md create mode 100644 collectors/nfs4Metric.md diff --git a/collectors/README.md b/collectors/README.md index cabb74a..a79fa03 100644 --- a/collectors/README.md +++ b/collectors/README.md @@ -29,6 +29,8 @@ In contrast to the configuration files for sinks and receivers, the collectors c * [`customcmd`](./customCmdMetric.md) * [`ipmistat`](./ipmiMetric.md) * [`topprocs`](./topprocsMetric.md) +* [`nfs3stat`](./nfs3Metric.md) +* [`nfs4stat`](./nfs4Metric.md) ## Todos diff --git a/collectors/nfs3Metric.md b/collectors/nfs3Metric.md new file mode 100644 index 0000000..63937ea --- /dev/null +++ b/collectors/nfs3Metric.md @@ -0,0 +1,39 @@ + +## `nfs3stat` collector + +```json + "nfs3stat": { + "nfsstat" : "/path/to/nfsstat", + "exclude_metrics": [ + "nfs3_total" + ] + } +``` + +The `nfs3stat` collector reads data from `nfsstat` command and outputs a handful **node** metrics. If a metric is not required, it can be excluded from forwarding it to the sink. There is currently no possibility to get the metrics per mount point. + + +Metrics: +* `nfs3_total` +* `nfs3_null` +* `nfs3_getattr` +* `nfs3_setattr` +* `nfs3_lookup` +* `nfs3_access` +* `nfs3_readlink` +* `nfs3_read` +* `nfs3_write` +* `nfs3_create` +* `nfs3_mkdir` +* `nfs3_symlink` +* `nfs3_remove` +* `nfs3_rmdir` +* `nfs3_rename` +* `nfs3_link` +* `nfs3_readdir` +* `nfs3_readdirplus` +* `nfs3_fsstat` +* `nfs3_fsinfo` +* `nfs3_pathconf` +* `nfs3_commit` + diff --git a/collectors/nfs4Metric.md b/collectors/nfs4Metric.md new file mode 100644 index 0000000..71d9613 --- /dev/null +++ b/collectors/nfs4Metric.md @@ -0,0 +1,62 @@ + +## `nfs4stat` collector + +```json + "nfs4stat": { + "nfsstat" : "/path/to/nfsstat", + "exclude_metrics": [ + "nfs4_total" + ] + } +``` + +The `nfs4stat` collector reads data from `nfsstat` command and outputs a handful **node** metrics. If a metric is not required, it can be excluded from forwarding it to the sink. There is currently no possibility to get the metrics per mount point. + + +Metrics: +* `nfs4_total` +* `nfs4_null` +* `nfs4_read` +* `nfs4_write` +* `nfs4_commit` +* `nfs4_open` +* `nfs4_open_conf` +* `nfs4_open_noat` +* `nfs4_open_dgrd` +* `nfs4_close` +* `nfs4_setattr` +* `nfs4_fsinfo` +* `nfs4_renew` +* `nfs4_setclntid` +* `nfs4_confirm` +* `nfs4_lock` +* `nfs4_lockt` +* `nfs4_locku` +* `nfs4_access` +* `nfs4_getattr` +* `nfs4_lookup` +* `nfs4_lookup_root` +* `nfs4_remove` +* `nfs4_rename` +* `nfs4_link` +* `nfs4_symlink` +* `nfs4_create` +* `nfs4_pathconf` +* `nfs4_statfs` +* `nfs4_readlink` +* `nfs4_readdir` +* `nfs4_server_caps` +* `nfs4_delegreturn` +* `nfs4_getacl` +* `nfs4_setacl` +* `nfs4_rel_lkowner` +* `nfs4_exchange_id` +* `nfs4_create_session` +* `nfs4_destroy_session` +* `nfs4_sequence` +* `nfs4_get_lease_time` +* `nfs4_reclaim_comp` +* `nfs4_secinfo_no` +* `nfs4_bind_conn_to_ses` + +