WHERE DO I START?
You are here:Integrations > Windows
  • Top ↑

Windows

Summary

The Netuitive Windows agent is a Microsoft Windows service that collects, aggregates, and publishes windows performance counters and attributes. Netuitive's Windows agent is similar in concept and design to collectd. Windows integration with Netuitive is as easy as executing an MSI installer and configuring the service. The Netuitive Windows Agent is pre-configured to send the most important performance metrics, windows events, and system attributes to Netuitive, but it can be configured to send additional or different data if required. See Windows Plugins for more information. Instructions on checking the version downloaded and troubleshooting are also included below.

Important   Microsoft SQL Server, IIS, and .NET metrics are native to our Windows Agent, so you will only have to use the one Windows integration in your account to receive all Windows-related metrics. View the list of metrics here. You can also add custom metrics if the default metrics are not enough.
Relevant Topic(s)   

Configuration

Note   If you need to disable an existing Windows integration or view the unique API key assigned to your account, navigate to the Integrations page under the user account drop-down menu and click the integration designated as Windows under the Integration column.

Installation

Setting up the Windows agent is a four-step process:

  1. Copy the unique API key from the Windows integration in your account.
  2. Download the Windows agent MSI installer and install the agent.
  3. Optionally, configure a proxy.
  4. Start the agent.

Step 1: Copy the API key from the Windows integration in your account

  1. From the top navigation menu, select Integrations.
  2. Click the Windows Server card. The name should be already populated, and Data Collection should be enabled. A unique API key for your account has already been generated.
  3. Copy the API key.

Step 2: Download and install the Windows Agent

  1. Download the latest Windows agent here. Ensure you download the correct version for your environment.
  2. Open a command line interface and change to the directory you downloaded the Windows agent to.
  3. Run the following command:

    msiexec /quiet /package CollectdWin-x64.msi NETUITIVE_API_KEY=my_api_key

    ... where my_api_key is the unique API key generated for your account that you copied in step 1. Windows will install the agent and set the API key in the WriteNetuitive.config file.

Note   If you'd prefer to manually install the agent, see Manually Installing the Windows Agent.

Step 3: Setup a proxy (Optional)

  1. Optionally, if you have a web proxy in your environment, you may need to configure the agent to use it. See Proxy Configuration for more information.

Step 4: Start the agent

  1. Open the Windows Service Control Manager.
  2. Select the CollectdWinService.
  3. Start the service. If the service is already running, you'll need to restart it for any configuration changes to take effect.
    Note   This integration's package (computed metrics, dashboards, and policies that will give you important events and alerts) will be automatically enabled and provisioned to your account as soon as Netuitive receives data from the integration. The PACKAGES button on the integration setup page will become active once data is received, so you'll be able to disable and re-enable the package at will.

Additional Configuration Options

Windows Plugins

There are two types of Windows plugins: Read (which allow our Windows agent to read data) and Write (which allow our Windows agent to write data). The following plugins are enabled by default:

  • ReadWindowsPerfCounters
  • ReadWindowsAttributes
  • ReadWindowsEvents
  • WriteNetuitive

This configuration is recommended for monitoring a Windows server with Netuitive. Other Read/Write plugins are available as documented below (note that the Write Console plugin has no configuration settings). To change which plugins are enabled, edit the CollectdWin.config file (located in C:\Program Files\CollectdWin\config or C:\Program Files (x86)\CollectdWin\config depending on your environment).

Read

Write

Proxy Configuration

The Windows agent does not use a proxy by default, but you may need to configure one if you have a proxy enabled in your browser.

Determining if you have a proxy enabled

  1. Open Internet Explorer.
  2. Click the Tools icon, and then click Internet Options.
  3. On the Connections tab, click LAN settings.
    If any of the checkboxes are selected and the appropriate information is filled out, you may need to configure proxy settings to enable data being posted by the agent on your server.

Configuring the proxy

  1. Add the following to the end of the CollectdWinService.exe.config configuration file after the <startup> section and before the closing </configuration> tag:

    <system.net>

    <defaultProxy enabled="true" useDefaultCredentials="true">

    <proxy/>

    </defaultProxy>

    </system.net>

    Note   The file will be located in C:\Program Files\CollectdWin or C:\Program Files (x86)\CollectdWin depending on your environment.
  2. Replace the <proxy /> element with one of the options below (corresponding to which option was selected in Internet Explorer).

Proxy Options Examples

More information about proxy settings can be found in the MSDN.

Dependencies

OS

All editions of Windows 7, 8, 8.1, 10, Windows Server 2012, and Windows Server 2012 R2

Note   The versions of Windows/Windows Server listed above have the required .NET Framework installed. In some cases, the required version of the .NET Framework may be installed but not enabled by default. Other older versions of Windows or Windows Server may work if you can install .NET Framework v. 3.5 or v. 4.5.

Miscellaneous

Microsoft .NET Framework v. 3.5 or v. 4.5