From 4b447d04830e4ab908a348f8446a1c125ecd106f Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Thu, 14 Sep 2023 12:09:55 -0600 Subject: [PATCH] docs(inputs.procstat): Add docs on permissions and metric details (#13921) --- plugins/inputs/procstat/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/plugins/inputs/procstat/README.md b/plugins/inputs/procstat/README.md index 55cf8d615..83719fb8c 100644 --- a/plugins/inputs/procstat/README.md +++ b/plugins/inputs/procstat/README.md @@ -78,8 +78,25 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. Preliminary support for Windows has been added, however you may prefer using the `win_perf_counters` input plugin as a more mature alternative. +### Permissions + +Some files or directories may require elevated permissions. As such a user may +need to provide telegraf with higher levels of permissions to access and produce +metrics. + ## Metrics +For descriptions of these tags and fields, consider reading one of the +following: + +- [Linux Kernel /proc Filesystem][kernel /proc] +- [proc manpage][manpage] + +[kernel /proc]: https://www.kernel.org/doc/html/latest/filesystems/proc.html +[manpage]: https://man7.org/linux/man-pages/man5/proc.5.html + +Below are an example set of tags and fields: + - procstat - tags: - pid (when `pid_tag` is true)