Host metrics receiver 🔗

Description 🔗

A receiver is how data gets into the Splunk Distribution of OpenTelemetry Collector. Receivers support one or more data sources - traces, metrics, or logs.

The host metrics receiver generates metrics about the host system scraped from various sources. Use this receiver when the Collector is deployed as an agent.

The supported pipeline type for this receiver is metrics.

Note

Metrics produced by this receiver count towards the custom metric ingestion limit. See System limits for Splunk Infrastructure Monitoring.

To filter unwanted metrics, see the filter processor documentation on GitHub: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor.

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 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 Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

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

Configuration 🔗

The collection interval and the categories of metrics to be scraped can be configured, as shown in the following example.

hostmetrics:
  collection_interval: <duration> # The default is 1m.
  scrapers:
    <scraper1>:
    <scraper2>:
    ...

The following table shows the available scrapers:

Scraper	Supported OS	Description
cpu	Not supported on macOS when compiled without Cgo, which is the default.	CPU utilization metrics
disk	Not supported on macOS when compiled without Cgo, which is the default.	Disk I/O metrics
load	All	CPU load metrics
filesystem	All	File system utilization metrics
memory	All	Memory utilization metrics
network	All	Network interface I/O metrics & TCP connection metrics
paging	All	Paging or swap space utilization and I/O metrics
processes	Linux	Process count metrics
process	Linux and Windows	Per process CPU, memory, and disk I/O metrics

Scraper configuration 🔗

Scrapers extract data from endpoints and then send that data to a specified target. See the following sections for scraper configurations.

Disk 🔗

disk:
  <include|exclude>:
    devices: [ <device name>, ... ]
    match_type: <strict|regexp>

File system 🔗

Note

The SignalFx exporter excludes some available file system metrics by default. Learn more about default metric filters in GitHub. See the complete list of file system metrics in GitHub.

filesystem:
  <include_devices|exclude_devices>:
    devices: [ <device name>, ... ]
    match_type: <strict|regexp>
  <include_fs_types|exclude_fs_types>:
    fs_types: [ <filesystem type>, ... ]
    match_type: <strict|regexp>
  <include_mount_points|exclude_mount_points>:
    mount_points: [ <mount point>, ... ]
    match_type: <strict|regexp>

For example, for Linux systems, / is a common mount point:

filesystem:
  include_mount_points:
    mount_points: ["/"]
    match_type: strict

Similarly, for Windows systems, C: is a common mount point.

filesystem:
  include_mount_points:
    mount_points: ["C:"]
    match_type: strict

Find more examples in our GitHub repos.

Network 🔗

network:
  <include|exclude>:
    interfaces: [ <interface name>, ... ]
    match_type: <strict|regexp>

Process 🔗

process:
  <include|exclude>:
    names: [ <process name>, ... ]
    match_type: <strict|regexp>
  mute_process_name_error: <true|false>
  scrape_process_delay: <time>

Advanced configurations 🔗

Filtering 🔗

To only gather a subset of metrics from a particular source, use the host metrics receiver with the filter processor.

Different frequencies 🔗

To scrape some metrics at a different frequency than others, configure multiple host metrics receivers with different collection_interval values. For example:

receivers:
  hostmetrics:
    collection_interval: 30s
    scrapers:
      cpu:
      memory:

  hostmetrics/disk:
    collection_interval: 1m
    scrapers:
      disk:
      filesystem:

service:
  pipelines:
    metrics:
      receivers: [hostmetrics, hostmetrics/disk]

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics