graphite_powershell

####Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with graphite_powershell
   • What graphite_powershell affects
   • Setup requirements
   • Beginning with graphite_powershell
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

##Overview

Module to send metrics to graphite from windows

##Module Description

Installs a windows service that reports system metrics to graphite

##Setup

###What graphite_powershell affects

• Powershell file and xml config file
• windows service

###Beginning with graphite_powershell

Install with defaults:

  class { 'graphite_powershell':
    server => 'graphite.mycorp.com'
  }

Install and just send network counters:

  class { 'graphite_powershell':
    server               => 'graphite.mycorp.com',
    performance_counters => [
      '\Network Interface(*)\Bytes Received/sec',
      '\Network Interface(*)\Bytes Sent/sec',
      '\Network Interface(*)\Packets Received Unicast/sec',
      '\Network Interface(*)\Packets Sent Unicast/sec',
      '\Network Interface(*)\Packets Received Non-Unicast/sec',
      '\Network Interface(*)\Packets Sent Non-Unicast/sec',
    ]
  }

##Usage

Using the graphite_powershell module consists predominantly of defining performance counters and filters.


```puppet
  class { 'graphite_powershell':
    server => undef,
    install_url => 'https://raw.githubusercontent.com/MattHodge/Graphite-PowerShell-Functions/master/Graphite-PowerShell.ps1',
    install_dir => 'C:/GraphitePowershell',
    port => '2003',
    metric_path => 'performance.windows',
    metric_send_interval => '10',
    timezone => 'UTC',
    performance_counters => [
      '\Network Interface(*)\Bytes Received/sec',
      '\Network Interface(*)\Bytes Sent/sec',
      '\Network Interface(*)\Packets Received Unicast/sec',
      '\Network Interface(*)\Packets Sent Unicast/sec',
      '\Network Interface(*)\Packets Received Non-Unicast/sec',
      '\Network Interface(*)\Packets Sent Non-Unicast/sec',
      '\Processor(_Total)\% Processor Time',
      '\Memory\Available MBytes',
      '\Memory\Pages/sec',
      '\Memory\Pages Input/sec',
      '\System\Processor Queue Length',
      '\System\Threads',
      '\PhysicalDisk(*)\Avg. Disk Write Queue Length',
      '\PhysicalDisk(*)\Avg. Disk Read Queue Length'
    ],
    metric_filters => [ 'isatap', 'teredo tunneling' ],
    verbose_logging => true
  }

##Reference

###Classes ####Pulic Classes

• graphite_powershell: Guides the install of graphite powershell and creates the windows service

##Limitations

This module is tested on the following platforms:

• Windows 2008 R2

It is tested with the OSS version of Puppet only.

##Development

###Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.

###Running tests

This project contains tests for both rspec-puppet and beaker to verify functionality. For in-depth information please see their respective documentation.

Quickstart:

gem install bundler bundle install bundle exec rake spec BEAKER_DEBUG=yes bundle exec rspec spec/acceptance

2014-07-07 Release 0.1.0

• initial version