Get metrics from your Windows applications/servers with Windows Management Instrumentation (WMI) in real time to
Note: It is recommended that the PDH check be used instead in all cases due to its significantly less overhead and thus better scalability.
If you are only collecting standard metrics from Microsoft Windows and other packaged applications, there are no installation steps. If you need to define new metrics to collect from your application, then you have a few options:
To learn more about using System.Diagnostics, see the MSDN documentation. After adding your metric you should be able to find it in WMI. To browse the WMI namespaces you may find this tool useful: WMI Explorer. You can find the same information with Powershell here. Also review the information in the Datadog Knowledge Base article.
If you assign the new metric a category of My_New_Metric, the WMI path is
If the metric isn’t showing up in WMI, try running
winmgmt /resyncperf to force the computer to reregister the performance libraries with WMI.
Wmi Check configuration.
init_config: instances: - class: Win32_OperatingSystem metrics: - [NumberOfProcesses, system.proc.count, gauge] - [NumberOfUsers, system.users.count, gauge] - class: Win32_PerfFormattedData_PerfProc_Process metrics: - [ThreadCount, proc.threads.count, gauge] - [VirtualBytes, proc.mem.virtual, gauge] - [PercentProcessorTime, proc.cpu_pct, gauge] tag_by: Name - class: Win32_PerfFormattedData_PerfProc_Process metrics: - [IOReadBytesPerSec, proc.io.bytes_read, gauge] tag_by: Name tag_queries: - [IDProcess, Win32_Process, Handle, CommandLine]
The metrics definitions include three components:
This feature is available starting with version 5.3 of the agent
Each WMI query has 2 required options,
metrics and six optional options,
class is the name of the WMI class, for example
Win32_PerfFormattedData_PerfProc_Process. You can find many of the standard class names on the MSDN docs. The
Win32_FormattedData_* classes provide many useful performance counters by default.
metrics is a list of metrics you want to capture, with each item in the
list being a set of
[<WMI_PROPERTY_NAME>, <METRIC_NAME>, <METRIC_TYPE>]:
<WMI_PROPERTY_NAME>is something like
ThreadCount. The standard properties are also available on the MSDN docs for each class.
<METRIC_NAME>is the name you want to show up in Datadog.
<METRIC_TYPE>is from the standard choices for all agent checks, such as gauge, rate, histogram or counter.
host is the optional target of the WMI query,
localhost is assumed by default. If you set this option, make sure that Remote Management is enabled on the target host see here for more information.
namespace is the optional WMI namespace to connect to (default to
filters is a list of filters on the WMI query you may want. For example, for a process-based WMI class you may want metrics for only certain processes running on your machine, so you could add a filter for each process name. You can also use the ‘%’ character as a wildcard.
provider is the optional WMI provider (default to
32 on Datadog Agent 32-bit or
64). It is used to request WMI data from the non-default provider. Available options are:
See MSDN for more information.
tag_by optionally lets you tag each metric with a property from the WMI class you’re using. This is only useful when you have multiple values for your WMI query.
tags optionally lets you tag each metric with a set of fixed values.
tag_queries optionally lets you specify a list of queries, to tag metrics with a target class property. Each item in the list is a set of
[<LINK_SOURCE_PROPERTY>, <TARGET_CLASS>, <LINK_TARGET_CLASS_PROPERTY>, <TARGET_PROPERTY>] where:
<LINK_SOURCE_PROPERTY>contains the link value
<TARGET_CLASS>is the class to link to
<LINK_TARGET_CLASS_PROPERTY>is the target class property to link to
<TARGET_PROPERTY>contains the value to tag with
It translates to a WMI query:
SELECT '<TARGET_PROPERTY>' FROM '<TARGET_CLASS>' WHERE '<LINK_TARGET_CLASS_PROPERTY>' = '<LINK_SOURCE_PROPERTY>'
[IDProcess, Win32_Process, Handle, CommandLine] tags each process with its command line. Any instance number will be removed from tag_by values i.e. name:process#1 => name:process. NB: The agent must be running under an Administrator account for this to work as the
CommandLine property is not accessible to non-admins.
Run the Agent’s
status subcommand and look for
wmi_check under the Checks section.
See metadata.csv for a list of metrics provided by this integration.
The WMI check does not include any events.
The WMI check does not include any service checks.
Need help? Contact Datadog support.
Mistake in the docs? Feel free to contribute!