Host metadata properties 🔗
The Splunk Distribution of OpenTelemetry Collector provides this integration as the
host-metadata monitor via the Smart Agent Receiver.
host-metadata monitor collects metadata properties about a host. This monitor is required for some views in Splunk Observability Cloud to operate. This monitor accepts endpoints. This monitor does not allow multiple instances.
In containerized environments host
/proc may not be located
directly under the root path. You can specify the path to
etc using the top level agent configurations
etcPath, as shown in the following example:
procPath: /proc etcPath: /etc monitors: - type: host-metadata
Metadata updates occur on a sparse interval of approximately
1m, 1m, 1h, and 1d, and continue repeating once per day.
Interval configuration for this monitor does not affect the
sparse interval on which metadata is collected.
To install this integration:
Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.
Configure the monitor, as described in the next section.
The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.
Note: Providing a
host-metadata monitor entry in your Smart Agent or Collector configuration is required for its use. Use the appropriate form for your agent type.
Smart Agent 🔗
To activate this monitor in the Smart Agent, add the following to your agent configuration:
monitors: # All monitor config goes under this key - type: host-metadata ... # Additional config
See Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.
Splunk Distribution of OpenTelemetry Collector 🔗
To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:
receivers: smartagent/host-metadata: type: host-metadata ... # Additional config
To complete the monitor activation, you must also include the
smartagent/host-metadata receiver item in a
metrics pipeline. To do this, add the receiver item to the
receivers section of your configuration file.
See configuration examples for specific use cases that show how the collector can integrate and complement existing environments.
These are the metrics available for this integration.
Non-default metrics (version 4.7.0+) 🔗
To emit metrics that are not default, you can add those metrics in the
extraMetrics configuration option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to
To see a list of metrics that will be emitted, you can run
agent-status monitors after configuring this monitor in a running agent instance.
The following dimensions may occur on metrics emitted by this monitor. Some dimensions may be specific to certain metrics.
||The version of collectd in the signalfx-agent|
||The name of the host kernel|
||The release of the host kernel|
||The version of the host kernel|
||The version of the os on the host|
||The version of the signalfx-agent|