Windows performance counters 🔗

Description 🔗

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

Use this monitor to receive metrics from Windows performance counters.

This monitor is available on Windows.

Note

For information on the OpenTelemetry receiver based on the Windows Performance Counters input plugin, see Windows Performance Counters receiver.

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 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host:
- Install on Windows
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of 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.

Read more on how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
Learn about config options in Collector default configuration.

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.

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