From 44c9d33657bed12cea298444a7ae659c6e0c62e4 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 13 Oct 2023 15:35:59 +0200 Subject: [PATCH 1/3] Update filesystems.rst --- gdi/monitors-hosts/filesystems.rst | 70 +++++++++++++++++++++++++++++- 1 file changed, 69 insertions(+), 1 deletion(-) diff --git a/gdi/monitors-hosts/filesystems.rst b/gdi/monitors-hosts/filesystems.rst index 9c4112a13..91a220f1f 100644 --- a/gdi/monitors-hosts/filesystems.rst +++ b/gdi/monitors-hosts/filesystems.rst @@ -4,10 +4,78 @@ Free disk space (filesystems) ============================= .. meta:: - :description: Use this Splunk Observability Cloud integrationfor the file systems / filesystems monitor. See benefits, install, configuration, and metrics + :description: Use this Splunk Observability Cloud integration for the file systems / filesystems monitor. See benefits, install, configuration, and metrics .. note:: If you are using the Splunk Distribution of OpenTelemetry Collector and want to collect file system utilization metrics, use the native OTel component :ref:`host-metrics-receiver`. +The :ref:`Splunk Distribution of OpenTelemetry Collector ` uses the :ref:`Smart Agent receiver ` with the ``filesystems`` monitor type to to retrieve file system metrics. + +This integration is available on Linux and Windows. On Linux, this monitor relies on the ``/proc`` filesystem. If the underlying host's ``/proc`` file system is mounted somewhere other than ``/proc``, specify the path using the top level setting ``procPath``. + + +Benefits +-------- + +.. include:: /_includes/benefits.rst + +Installation +------------ + +.. include:: /_includes/collector-installation-linux.rst + +Configuration +------------- + +.. include:: /_includes/configuration.rst + +Example +~~~~~~~ + +To activate this integration, add the following to your Collector +configuration: + +.. code:: yaml + + receivers: + smartagent/filesystems: + type: filesystems + ... # Additional config + +Next, add the monitor to the ``service.pipelines.metrics.receivers`` +section of your configuration file: + +.. code:: yaml + + service: + pipelines: + metrics: + receivers: [smartagent/filesystems] + logs: + receivers: [smartagent/filesystems] + +The following example shows how to collect additional metrics from a variefy of file system types: + +.. code:: yaml + + smartagent/filesystems: + type: filesystems + extraMetrics: + - df_complex.reserved + - df_inodes.free + - df_inodes.used + - percent_inodes.free + - percent_inodes.used + - percent_bytes.free + - percent_bytes.reserved + - percent_bytes.used + fsTypes: + - ext3 + - ext4 + - nfs + - xfs + - btrfs + sendModeDimension: true + Configuration settings ---------------------- From 802614c2535a421760b9dff5c9a9cc32da5adcc2 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 13 Oct 2023 15:49:12 +0200 Subject: [PATCH 2/3] Update filesystems.rst --- gdi/monitors-hosts/filesystems.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/monitors-hosts/filesystems.rst b/gdi/monitors-hosts/filesystems.rst index 91a220f1f..894b7f7c4 100644 --- a/gdi/monitors-hosts/filesystems.rst +++ b/gdi/monitors-hosts/filesystems.rst @@ -8,7 +8,7 @@ Free disk space (filesystems) .. note:: If you are using the Splunk Distribution of OpenTelemetry Collector and want to collect file system utilization metrics, use the native OTel component :ref:`host-metrics-receiver`. -The :ref:`Splunk Distribution of OpenTelemetry Collector ` uses the :ref:`Smart Agent receiver ` with the ``filesystems`` monitor type to to retrieve file system metrics. +The :ref:`Splunk Distribution of OpenTelemetry Collector ` uses the :ref:`Smart Agent receiver ` with the ``filesystems`` monitor type to retrieve free disk space metrics. This integration is available on Linux and Windows. On Linux, this monitor relies on the ``/proc`` filesystem. If the underlying host's ``/proc`` file system is mounted somewhere other than ``/proc``, specify the path using the top level setting ``procPath``. From a32930badad688bd660fb5ff182ea036ea9d2e90 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 13 Oct 2023 15:52:07 +0200 Subject: [PATCH 3/3] Update filesystems.rst --- gdi/monitors-hosts/filesystems.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/monitors-hosts/filesystems.rst b/gdi/monitors-hosts/filesystems.rst index 894b7f7c4..3b6d13095 100644 --- a/gdi/monitors-hosts/filesystems.rst +++ b/gdi/monitors-hosts/filesystems.rst @@ -21,7 +21,7 @@ Benefits Installation ------------ -.. include:: /_includes/collector-installation-linux.rst +.. include:: /_includes/collector-installation.rst Configuration -------------