Windows Additional Information

Relevant Topic(s)   

Using Windows Server 2003

If you are monitoring a Windows Server 2003 instance and are having trouble seeing data in Metricly, you may need to install a hotfix from Microsoft. In August 2016, AWS disabled an SSL cipher in their standard ELB policy that was the last supported SSL cipher that comes with Windows Server 2003 by default. Microsoft has created a hotfix (Windows Server 2003 R2 32Bit and 64Bit) to add more modern ciphers to your OS, which will fix the issue. The hotfix can be found here.

Note: Versions of the Windows Agent later than v0.7.4.55 do not support Windows Server 2003.

Adding Custom Metrics

Adding additional Windows performance counters will create custom metrics that will be monitored by Metricly.

Adding custom metrics is a three-step process:

  1. Open the Add Counters window.
  2. Prepare a new Counter(s) in the ReadWindowsPerfCounters file.
  3. Fill in custom Counter information using the Add Counters window.

Step 1: Open the Add Counters window

  1. Open perfmon (Performance Monitor) on your computer.
  2. Once Performance Monitor is open, click Performance Monitor in the Monitoring Tools folder. You should see a graph being drawn.
  3. Click Add  above the graph. An “Add Counters” window opens. Leave the window open.

Step 2: Prepare a new Counter

  1. Navigate to the ReadWindowsPerfCounters file (typically located in C:\Program Files\CollectdWin\config) and open it.
  2. Optionally, at the top of the file but below the <Counters> tag, place a comment to section off your new custom category of counters.
    <!-- CustomCategoryName -->
  3. Add a blank Counter tag template:

Step 3: Fill in Counter information

  1. Follow the diagram below to fill out the Category, Name, and Instance fields (case sensitive) in the blank counter template you added in step 2.3. The picture outlines the expanded Processor counter category.

    Not all categories will have instances available. In the above example, the instances correlate to the processor’s cores, where _Total would calculate the metric selected for all four cores. Options you can use for the Instance field:

    • “” for no specific instances.
    • “_Total” for an aggregate of all instances.
    • “.*” to make a branch for each instance.
    • “{specific_instance_name}” for only a specific instance.
  2. Navigate to the types.db file (typically located in C:\Program Files\CollectdWin) and open it.
  3. Use your best judgment to match a type in types.db to the category you selected in step 3.1. Input the type (case sensitive) you wish to use into the CollectdType field.
    If you chose to monitor a Processor category metric, you would choose the cpu type in types.db.
  4. Type a metric category for the CollectdPlugin field. This field can be anything you want, and it will display in Metricly as shown below.
  5. Type a metric name for the CollectdTypeInstance field. This field can also be anything you want and will be used as the metric’s name in Metricly, but be sure to make it entirely unique.
  6. Save the ReadWindowsPerfCounters file.

Example Counters

  • A Web Service counter that tracks the total instances of Current Connections.
      Category="Web Service"
      Name="Current Connections"
  • Three Process counters that check the status of different aspects of the Windows agent service.
      Name="% Processor Time"
      Name="Thread Count"
      Name="Private Bytes"

Checking the Version

You may need the verify the version of the Windows agent you’re currently using.

  1. Open the Element Detail panel for a WINSRV element.
  2. On the Summary panel, navigate to the Attributes widget.
    The agent attribute contains the version number.

Manually Installing the Windows Agent

  1. Download the latest Windows agent here. Ensure you download the correct version for your environment.
  2. Run the setup wizard and follow the instructions to install it.
  3. Navigate to the WriteMetricly.config file.
    The file will be located in C:\Program Files\CollectdWin\config or C:\Program Files (x86)\CollectdWin\config depending on your environment.
  4. Open the file and locate the line <WriteMetriclyURL=”{apikey}” />.
  5. Replace {apikey} in the URL with the API key generated in step 1.
  6. Save the file, and start the agent.

Manually Updating the Hostname

  1. After downloading the Windows agent, open the CollectdWin.config file.
  2. At the top of the file, update the Hostname setting to the desired value.
    <GeneralSettings Interval="60" Timeout="120" 
    StoreRates="false" Hostname="" />
  3. Save the file and restart the CollectdWin service (if it’s currently running).


Logs are written to C:\ProgramData\CollectdWin\CollectdWin.log by default. Errors are written to the Event Log. You can adjust the log file level by editing the line below near the end of the CollectdWinService.exe.config (located in C:\Program Files\CollectdWin\config or C:\Program Files (x86)\CollectdWin\config) file:

<logger name="*" writeTo="default" minlevel="[Trace/Debug/Info/Warn/Error/Fatal]" />

Upgrading the Windows Agent

To upgrade the Windows agent, follow the installation steps listed on the main Windows Integration page using the version of the agent you wish to upgrade to. The latest versions of the agent can be downloaded from the agent repo and details of the releases can be found on the Github project page.

Installing a new version of the agent will overwrite changes you have made to existing agent configuration files located in C:\Program Files\CollectdWin\config or C:\Program Files (x86)\CollectdWin\config depending on your environment. To preserve those changes, it is recommended you create backups of the files prior to upgrading.

Removing the Windows Agent

  1. Open the Programs and Features list.
  2. Right click the CollectdWinService (64 bit) program.
  3. Click Uninstall.
  4. If any prompt appears, click Yes to confirm that you want to delete the program.