Docs » Configure application receivers » Configure application exporters and receivers for monitoring » Windows performance counters

Windows performance counters 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the telegraf/win_perf_counters monitor type using the SignalFx Smart Agent Receiver.

Use this monitor to receive metrics from Windows performance counters.

This monitor is available on Windows.

Benefits 🔗

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

  • View metrics using the built-in dashboard. 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 Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/telegraf/win_perf_counters:
    type: telegraf/win_perf_counters
    ... # Additional config

The following snippet shows a sample configuration with counters and settings:

receivers:
 - type: telegraf/win_perf_counters
   printValid: true
   objects:
    - objectName: "Processor"
      instances:
       - "*"
      counters:
       - "% Idle Time"
       - "% Interrupt Time"
       - "% Privileged Time"
       - "% User Time"
       - "% Processor Time"
      includeTotal: true
      measurement: "win_cpu"

To complete the monitor activation, you must also include the smartagent/telegraf/win_perf_counters receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/telegraf/win_perf_counters]

Configuration settings 🔗

The following table shows the configuration options for the telegraf/win_perf_counters receiver:

Option Required Type Description
objects No list of objects (see below) Contains the configuration of the monitor.
counterRefreshInterval No int64 Frequency of expansion of the counter paths and counter refresh. The default value is 5s)
useWildCardExpansion No bool If set to true, instance indexes are included in instance names, and wildcards are expanded and localized when applicable. The default value is false.
printValid No bool Print the configurations that match available performance counters. The default value is false.
pcrMetricNames No bool If true, metric names are emitted in the PerfCounterReporter format. The default value is false.

The nested objects configuration object has the following fields:

Option Required Type Description
objectName No string The name of a Windows performance counter object.
counters No list of strings The name of the counters to collect from the performance counter object.
instances No list of strings The Windows performance counter instances to retrieve for the performance counter object.
measurement No string The name of the Telegraf measurement to be used as a metric name.
warnOnMissing No bool Log a warning if the performance counter object is missing. The default value is false.
failOnMissing No bool Throws an error if the performance counter object is missing. The default value is false.
includeTotal No bool Include the total instance when collecting performance counter metrics. The default value is false.

Metrics 🔗

The Splunk Distribution of OpenTelemetry Collector doesn’t filter metrics for this receiver.

Troubleshooting 🔗

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

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