Free disk space (filesystems)

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 Host metrics receiver.

The Splunk Distribution of OpenTelemetry Collector uses the 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.

Benefits

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata Catalog.

Installation

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the integration, as described in the Configuration section.
Restart the Splunk Distribution of the OpenTelemetry Collector.

Configuration

To use this integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
- See how to Use Smart Agent monitors with the Collector.
- See how to set up the Smart Agent receiver.
- For a list of common configuration options, refer to Common configuration settings for monitors.
- Learn more about the Collector at Get started: Understand and use the Collector.

Example

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/filesystems:
    type: filesystems
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

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:

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

The following table shows the configuration options for this monitor.


Option	Required	Type	Description
`hostFSPath`	no	`string`	Path to the root of the host filesystem. It is useful when running in a container and the host filesystem is mounted in a subdirectory under /. The disk usage metrics emitted will be based at this path.
`fsTypes`	no	`list of strings`	The filesystem types to include. If this is not set, the default value is the set of all non-logical/virtual filesystems on the system. On Linux this list is determined by reading the `/proc/filesystems` file and choosing the filesystems that do not have the `nodev` modifier.
`mountPoints`	no	`list of strings`	The mount paths to include/exclude. Note: If you are using the hostFSPath option, do not include the `/hostfs/` mount in the filter. If both this and `fsTypes` are specified, the two filters combine in an AND relationship.
`sendModeDimension`	no	`bool`	Set to `true` to emit the "mode" dimension, which represents whether the mount is "rw" or "ro". (default: `false`)

Metrics

The following metrics are available for this integration:

https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/filesystems/metadata.yaml

Notes

To learn more about the available in Splunk Observability Cloud see Metric types.
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics.

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal.
Contact Splunk Support.

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups.

Documentation