diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/windows-services-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/windows-services-integration.mdx index 0c3fa385f82..7d8e40a205e 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/windows-services-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/windows-services-integration.mdx @@ -14,12 +14,6 @@ import infrastructureWindowsServices from 'images/infrastructure_diagram_windows New Relic's Windows services integration collects data about the services running on your Microsoft Windows hosts and sends it to our platform. You can check the state and start mode of each service, find out which hosts are running a service, set up for services, and more. -Our integration is bundled with the [Windows infrastructure agent](/docs/infrastructure/install-infrastructure-agent/windows-installation/install-infrastructure-monitoring-agent-windows). If you're monitoring Windows hosts on New Relic, you only need to enable the integration to get Windows services data into our platform. - -## Why it matters [#value] - -[Microsoft Windows services](https://docs.microsoft.com/en-us/dotnet/framework/windows-services/introduction-to-windows-service-applications) are the Windows equivalent of daemons in Unix and Linux: long-running executables that can be started, stopped, paused, and restarted without a graphical interface. Knowing which services are enabled, or their state or health, is essential when monitoring Windows infrastructure. - With our Windows services integration you can: * Check all your Windows services, their state (running, stopped, etc.), start mode (auto, manual, etc.), and other service [metadata](#metadata). @@ -27,6 +21,9 @@ With our Windows services integration you can: * [Set alerts](#set-alerts) based on any Windows services that you are monitoring using New Relic. * Install the [Windows Services Quickstart](https://newrelic.com/instant-observability/winservices) or create your own to track your Windows services. +Our integration is bundled with the [Windows infrastructure agent](/docs/infrastructure/install-infrastructure-agent/windows-installation/install-infrastructure-monitoring-agent-windows). If you're monitoring Windows hosts on New Relic, you only need to enable the integration to get Windows services data into our platform. + + New Relic - Windows services integration - Metric data**version 1.12.1 or higher** for our [infrastructure monitoring agent](/docs/infrastructure/install-infrastructure-agent/windows-installation/install-infrastructure-monitoring-agent-windows) installed on a supported host. The x86 Windows versions are not yet supported. -## Install and activate [#install] + + + +## Install the infrastructure agent [#infra-install] -To install the Windows services integration: +To use the Windows services integration, you need to first [install the infrastructure agent](/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent-new-relic/) on the same host. All our on-host integrations require the infrastructure agent, which helps expose and report metrics to New Relic. + + +## Configure the Windows services integration [#configure] + +To activate and configure the Windows services integration: 1. Change the directory to the integrations folder: @@ -57,31 +62,11 @@ To install the Windows services integration: ```shell copy winservices-config.yml.sample winservices-config.yml ``` -3. Edit the `winservices-config.yml` file as described in the [configuration settings](#config) and save it. - -### Update your integration [#update] - -The Windows services integration is bundled with the infrastructure monitoring agent. To update the integration, [update the agent](/docs/infrastructure/install-infrastructure-agent/update-or-uninstall/update-infrastructure-agent/) to the latest version. - -## Configure the integration [#config] - -To enable the integration, edit and save the `winservices-config.yml`: - -* Uncomment `exporter_bind_address:` and `exporter_bind_port:` -* Add the name of the services you want to monitor to `include_matching_entities:` - -By default, no service is included. To include and filter services, you must edit `include_matching_entities:`. +3. Edit the `winservices-config.yml` file. By default, no service is included. To include and filter services, you must edit `include_matching_entities:`. -Also, the configuration option [`inventory_source`](/docs/infrastructure/host-integrations/infrastructure-integrations-sdk/specifications/host-integrations-standard-configuration-format) is not compatible with the integration. + Here's an example of the Windows services integration configuration with both a regex pattern matching all services named `win32.*` and a direct match for the `newrelic-infra` service: -Here's an example of the Windows services integration configuration with both a regex pattern matching all services named `win32.*` and a direct match for the `newrelic-infra` service: - - - - ```yml + ```yml integrations: - name: nri-winservices config: @@ -95,9 +80,34 @@ Here's an example of the Windows services integration configuration with both a timeout: 60s ``` - For more information, see our documentation about the [general structure of on-host integration configurations](/docs/integrations/integrations-sdk/file-specifications/host-integration-configuration-overview). - - +For more information, see our documentation about the [general structure of on-host integration configurations](/docs/integrations/integrations-sdk/file-specifications/host-integration-configuration-overview). + + + +## Restart the New Relic infrastructure agent + +Restart your infrastructure agent: + +```shell +sudo systemctl restart newrelic-infra.service +``` + +In a couple of minutes, your application will send metrics to [one.newrelic.com](https://one.newrelic.com). + + + +## Find your data + +You can choose our pre-built dashboard template named `Windows services integration ` to monitor your Windows services. Follow these steps to use our pre-built dashboard template: + + 1. From [one.newrelic.com](https://one.newrelic.com), go to the **+ Add data** page. + 2. Click on **Dashboards**. + 3. In the search bar, type `Windows services`. + 4. The Windows services dashboard should appear. Click on it to install it. + +Your Windows services dashboard is considered a custom dashboard and can be found in the **Dashboards** UI. For docs on using and editing dashboards, see [our dashboard docs](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards). + + ## Set up an alert [#set-alerts] diff --git a/src/images/infrastructure_screenshot-crop_windows-services-metric.webp b/src/images/infrastructure_screenshot-crop_windows-services-metric.webp index 52412c2bd00..7678643bee8 100644 Binary files a/src/images/infrastructure_screenshot-crop_windows-services-metric.webp and b/src/images/infrastructure_screenshot-crop_windows-services-metric.webp differ