Windows Services

Agent Check

Windows OS Supported

Overview

This check monitors the state of any Windows Service and submits a service check to Datadog.

Setup

Installation

The Windows Service check is included in the Datadog Agent package, so you don’t need to install anything else on your Windows hosts.

Configuration

Edit the windows_service.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample windows_service.d/conf.yaml for all available configuration options. Below is an example configuration:

init_config:

instances:

    ## @param services  - list of strings - required
    ## List of services to monitor e.g. Dnscache, wmiApSrv, etc.
    ##
    ## If any service is set to `ALL`, all services registered with the SCM will be monitored.
    ##
    ## This matches all services starting with service, as if service.* is configured.
    ## For an exact match, use ^service$
    #
    # - services:
    #    - <SERVICE_NAME_1>
    #    - <SERVICE_NAME_2>
  - services:
      - wmiApSrv
      - SNMPTRAP

    ## @param disable_legacy_service_tag - boolean - optional - default: false
    ## Whether or not to stop submitting the tag `service` that has been renamed
    ## to `windows_service` and disable the associated deprecation warning.
    #
    # disable_legacy_service_tag: false
    disable_legacy_service_tag: true

    ## @param tags - list of key:value element - optional
    ## List of tags to attach to every service check emitted by this integration.
    ##
    ## Learn more about tagging at https://docs.datadoghq.com/tagging
    #
    # tags:
    #   - <KEY_1>:<VALUE_1>
    #   - <KEY_2>:<VALUE_2>
    tags:
      - provider:amazon

Provide service names as they appear in the services.msc properties field (e.g. wmiApSrv), NOT the display name (e.g. WMI Performance Adapter). For names with spaces: enclose the whole name in double quotation marks (e.g. “Bonjour Service”). Note: Spaces are replaced by underscores in Datadog.

Restart the Agent to start monitoring the services and sending service checks to Datadog.

Metrics collection

The Windows Service check can potentially emit custom metrics, which may impact your billing.

Validation

Run the Agent’s status subcommand and look for windows_service under the Checks section.

Data Collected

Metrics

The Windows Service check does not include any metrics.

Events

The Windows Service check does not include any events.

Service Checks

windows_service.state:
The Agent submits this service check for each Windows service configured in services, tagging the service check with ‘service:<service_name>’. The service check takes on the following statuses depending on Windows status:

Windows status	windows_service.state
Stopped	CRITICAL
Start Pending	WARNING
Stop Pending	WARNING
Running	OK
Continue Pending	WARNING
Pause Pending	WARNING
Paused	WARNING
Unknown	UNKNOWN

If the service cannot be accessed by the Agent due to a permission restriction or an incorrect name, the service check reports UNKNOWN.

Troubleshooting

Need help? Contact Datadog support.

Datadog Docs