Spectator

Overview

Spectator is a Windows Service for taking measurements from Performance Counters or WMI and publishing them to a Statsd-compatible server.

Features:

• Installs as a Windows service (via Topshelf)
• Supports reading metric values from Performance Counters or from from WMI (via ManagedObjectSearcher queries)
• Pushes metrics via UDP to any Statsd-compatible server
• Customisable metric names via templates
• Exclude particular Performance Counter instances from being measured, using exclusion and/or inclusion patterns
• JSON configuration via local file (base-spectator-config.json)
• Dynamic configuration via override configurations kept in a Consul key/value store
  • Local caching of remote override configuration in case of temporary Consul outage

Quick Start

Edit the spectator.exe.config file to set the Consul connection settings (or leave the ConsulHost setting empty to load from the local spectator-config.json file):

<appSettings>
   <add key="Spectator.ConsulHost" value="consul.server.com:8500" />
   <add key="Spectator.ConsulKey" value="metrics/spectator/config"/>
</appSettings>

Install the service via Topshelf (http://docs.topshelf-project.com/en/latest/overview/commandline.html):

spectator.exe install

Start the service via Topshelf:

spectator.exe start

Base Configuration Example

{
  "statsdHost": "statsd.server.com",
  "statsdPort": 8125,
  "metricPrefix": "metrics.prefix.{machine}",
  "interval":  "00:00:15",
  "metrics": [
    {
	  /* Performance counter */
      "source": "performanceCounter",
      "path": "\\System\\Context Switches/sec",
      "type": "gauge",
      "template": "system.processor.context_switches_per_sec"
    },
    {
	  /* Performance counter reading a particular instance */
      "source": "performanceCounter",
      "path": "\\Paging File(_Total)\\% Usage",
      "type": "gauge",
      "template": "system.swap.percent_used"
    },
    {
	  /* Performance counter reading all instances */
      "source": "performanceCounter",
      "path": "\\Network Interface(*)\\Bytes Sent/sec",
      "type": "gauge",
      "template": "system.network.interface.{instance}.bytes_sent_per_sec",
      "exclude": "^(isatap|Teredo).*$"
    },
    {
	  /* Windows Management Instrumentation (WMI) */
      "source": "windowsManagementInstrumentation",
      "path": "\\Win32_ComputerSystem\\TotalPhysicalMemory",
      "type": "gauge",
      "template": "system.memory.total_physical"
    },
  ]
}

License

spectator is made available as-is under the Apache License, Version 2.0. See the LICENSE file for full license details.