Docs » Configure application receivers » Configure application 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 by using the SignalFx Smart Agent Receiver.

This monitor is available on Windows.

Benefits 🔗

After you’ve configured the integration, you can:

  • 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 the integration:

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

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

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. The Smart Agent Receiver lets you use existing Smart Agent monitors as OpenTelemetry Collector metric receivers.

Using this monitor assumes that you have a configured environment with a functional Smart Agent release bundle on your system, which is already provided for x86_64/amd64 Splunk Distribution of OpenTelemetry Collector installation paths.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your configuration file:

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

To complete the integration, include the telegraf/win_perf_counters receiver in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file.

Sample YAML configuration:

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"

Usage 🔗

Use this integration to read Windows performance counters.

See configuration examples for specific use cases that show how the Splunk OpenTelemetry Collector can integrate and complement existing environments.

Event-sending functionality 🔗

This monitor includes event-sending functionality to let you post your own custom events to Observability Cloud. For example, you can send your own custom event when you deploy a new version of your software or update other parts of your infrastructure. You can then view these events in the Observability Cloud user interface (UI).

Monitors with event-sending functionality should be made members of a logs pipeline that utilizes a SignalFx exporter to make the event submission requests. Use a Resource Detection processor to ensure that host identity and other useful information is made available as event dimensions.

For example:

service:
  pipelines:
    logs:
      receivers:
        - smartagent/<receiver>
# Adds the Resource Detection processor to the logs pipeline.        
      processors:
        - resourcedetection
      exporters:
        - signalfx

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)
counterRefreshInterval no int64 The frequency that counter paths should be expanded and how often to refresh counters from configuration. This is expressed as a duration. (default: 5s)
useWildCardExpansion no bool If true, instance indexes will be included in instance names, and wildcards will be expanded and localized (if applicable). If false, non partial wildcards will be expanded and instance names will not include instance indexes. (default: false)
printValid no bool Print out the configurations that match available performance counters (default: false)
pcrMetricNames no bool If true, metric names will be emitted in the format emitted by the SignalFx PerfCounterReporter (default: false)

The nested objects config 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 fetch for the performance counter object
measurement no string The name of the telegraf measurement that will be used as a metric name
warnOnMissing no bool Log a warning if the perf counter object is missing (default: false)
failOnMissing no bool Panic if the performance counter object is missing (this will stop the agent) (default: false)
includeTotal no bool Include the total instance when collecting performance counter metrics (default: false)

Metrics 🔗

The Splunk Distribution of OpenTelemetry Collector does not do any built-in filtering of metrics for this receiver.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud: