Adding feature to allow the hostname of the metrics to be overwritten in the XML configuration file by modifying the ConvertTo-GraphiteMetric function.

Modified Import-XMLConfig function to import the new configuration value, and updated Pester Tests
Added Pester Tests for the the ConvertTo-GraphiteMetric function.
Updated readme.md with new configuration value.

Author: MattHodge

Functions/ConvertTo-GraphiteMetric.Tests.ps1

@@ -0,0 +1,66 @@
+$here = Split-Path -Parent $MyInvocation.MyCommand.Path
+$toplevel = Split-Path -Parent $here
+$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
+
+. "$here\$sut"
+
+Describe "ConvertTo-GraphiteMetric" {
+    Context "Metric Transformation - Base Function" {
+        $TestMetric = ConvertTo-GraphiteMetric -MetricToClean "\\myServer\network interface(realtek pcie gbe family controller)\bytes received/sec"
+
+        It "Should Return Something" {
+            $TestMetric | Should Not BeNullOrEmpty
+        }
+        It "Should Provide myServer.networkinterface.realtekpciegbefamilycontroller.bytesreceived-sec as Output" {
+            $TestMetric | Should MatchExactly "myServer.networkinterface.realtekpciegbefamilycontroller.bytesreceived-sec"
+        }
+        It "Should Not Contain Left Parentheses" {
+            $TestMetric | Should Not Match "\("
+        }
+        It "Should Not Contain Right Parentheses" {
+            $TestMetric | Should Not Match "\)"
+        }
+        It "Should Not Contain Forward Slash" {
+            $TestMetric | Should Not Match "\/"
+        }
+        It "Should Not Contain Back Slash" {
+            $TestMetric | Should Not Match "\\"
+        }
+        It "Should Contain a Period" {
+            $TestMetric | Should Match "\."
+        }
+    }
+    Context "Metric Transformation - Remove Underscores" {
+        $TestMetric = ConvertTo-GraphiteMetric -MetricToClean "\\myServer\Processor(_Total)\% Processor Time" -RemoveUnderscores
+
+        It "Should Return Something" {
+            $TestMetric | Should Not BeNullOrEmpty
+        }
+        It "Should Return myServer.production.net.Processor.Total.ProcessorTime as Output" {
+            $TestMetric | Should MatchExactly "myServer.Processor.Total.ProcessorTime"
+        }
+        It "Should Not Contain Underscores" {
+            $TestMetric | Should Not Match "_"
+        }
+    }
+    Context "Metric Transformation - Provide Nice Output for Physical Disks" {
+        $TestMetric = ConvertTo-GraphiteMetric -MetricToClean "\\myServer\physicaldisk(1 e:)\avg. disk write queue length" -RemoveUnderscores -NicePhysicalDisks
+
+        It "Should Return Something" {
+            $TestMetric | Should Not BeNullOrEmpty
+        }
+        It "Should Return myServer.physicaldisk.e-drive.diskwritequeuelength as Output" {
+            $TestMetric | Should MatchExactly "myServer.physicaldisk.e-drive.diskwritequeuelength"
+        }
+    }
+    Context "Metric Transformation - Replace HostName" {
+        $TestMetric = ConvertTo-GraphiteMetric -MetricToClean "\\$($env:COMPUTERNAME)\physicaldisk(1 e:)\avg. disk write queue length" -RemoveUnderscores -NicePhysicalDisks -HostName "my.new.hostname"
+
+        It "Should Return Something" {
+            $TestMetric | Should Not BeNullOrEmpty
+        }
+        It "Should Return my.new.hostname.physicaldisk.e-drive.diskwritequeuelength as Output" {
+            $TestMetric | Should MatchExactly "my.new.hostname.physicaldisk.e-drive.diskwritequeuelength"
+        }
+    }
+}

Functions/ConvertTo-GraphiteMetric.ps1

@@ -16,13 +16,26 @@ Function ConvertTo-GraphiteMetric
     .Parameter NicePhysicalDisks
         Makes the physical disk perf counters prettier
 
+    .Parameter HostName
+        Allows you to override the hostname of the metrics before sending. Default is not to override and use what the Windows Performance Counters provide.
+
+    .Example
+        PS> ConvertTo-GraphiteMetric -MetricToClean "\\myServer\network interface(realtek pcie gbe family controller)\bytes received/sec"
+            myServer.networkinterface.realtekpciegbefamilycontroller.bytesreceived-sec
+
+            Cleaning a Windows Performance Counter so its ready for Graphite.
+
     .Example
-        PS> ConvertTo-GraphiteMetric -MetricToClean "\Processor(_Total)\% Processor Time"
-            .Processor._Total.ProcessorTime
+        PS> ConvertTo-GraphiteMetric -MetricToClean "\\myServer\Processor(_Total)\% Processor Time" -RemoveUnderscores
+            myServer.Processor.Total.ProcessorTime
+
+            Cleaning a Windows Performance Counter so its ready for Graphite and removing underscores.
 
     .Example
-        PS> ConvertTo-GraphiteMetric -MetricToClean "\Processor(_Total)\% Processor Time" -RemoveUnderscores
-            .Processor.Total.ProcessorTime
+        PS> ConvertTo-GraphiteMetric -MetricToClean "\\myServer\Processor(_Total)\% Processor Time" -RemoveUnderscores -HostName myserver.production.net
+            myserver.production.net.Processor.Total.ProcessorTime
+
+            Cleaning a Windows Performance Counter so its ready for Graphite and removing underscores. Replacing HostName with custom name.
 
     .Notes
         NAME:      ConvertTo-GraphiteMetric
@@ -39,9 +52,18 @@ Function ConvertTo-GraphiteMetric
         [switch]$RemoveUnderscores,
 
         [parameter(Mandatory = $false)]
-        [switch]$NicePhysicalDisks
+        [switch]$NicePhysicalDisks,
+
+        [parameter(Mandatory = $false)]
+        [string]$HostName=$env:COMPUTERNAME
     )
 
+    # If HostName is being overwritten
+    if ($HostName -ne $env:COMPUTERNAME)
+    {
+        $MetricToClean = $MetricToClean -replace "\\\\$($env:COMPUTERNAME)\\","\\$($HostName)\"
+    }
+
     # Removing Beginning Backslashes"
     $cleanNameOfSample = $MetricToClean -replace '^\\\\', ''
 

Functions/Internal.Tests.ps1

@@ -11,8 +11,8 @@ Describe "Importing of XML Configuration File" {
         It "Loaded Configuration File Should Not Be Empty" {
             $Config | Should Not BeNullOrEmpty
         }
-        It "Should Have 15 Properties" {
-            $Config.Count | Should Be 15
+        It "Should Have 16 Properties" {
+            $Config.Count | Should Be 16
         }
         It "SendUsingUDP should be Boolean" {
             $Config.SendUsingUDP -is [Boolean] | Should Be $true

Functions/Internal.ps1

@@ -32,11 +32,20 @@ Function Import-XMLConfig
     # Load Configuration File
     $xmlfile = [xml]([System.IO.File]::ReadAllText($configPath))
 
-    #Set the Graphite carbon server location and port number
+    # Set the Graphite carbon server location and port number
     $Config.CarbonServer = $xmlfile.Configuration.Graphite.CarbonServer
     $Config.CarbonServerPort = $xmlfile.Configuration.Graphite.CarbonServerPort
 
-    #Get Metric Send Interval From Config
+    # Get the HostName to use for the metrics from the config file
+    $Config.NodeHostName = $xmlfile.Configuration.Graphite.NodeHostName
+    
+    # Set the NodeHostName to ComputerName
+    if($Config.NodeHostName -eq '$env:COMPUTERNAME')
+    {
+        $Config.NodeHostName = $env:COMPUTERNAME
+    }
+
+    # Get Metric Send Interval From Config
     [int]$Config.MetricSendIntervalSeconds = $xmlfile.Configuration.Graphite.MetricSendIntervalSeconds
 
     # Convert Value in Configuration File to Bool for Sending via UDP

Functions/Start-StatsToGraphite.ps1

@@ -140,7 +140,7 @@ Function Start-StatsToGraphite
                 if ([string]::IsNullOrWhiteSpace($Config.Filters) -or $sample.Path -notmatch [regex]$Config.Filters)
                 {
                     # Run the sample path through the ConvertTo-GraphiteMetric function
-                    $cleanNameOfSample = ConvertTo-GraphiteMetric -MetricToClean $sample.Path -RemoveUnderscores -NicePhysicalDisks
+                    $cleanNameOfSample = ConvertTo-GraphiteMetric -MetricToClean $sample.Path -RemoveUnderscores -NicePhysicalDisks -HostName $Config.NodeHostName
 
                     # Build the full metric path
                     $metricPath = $Config.MetricPath + '.' + $cleanNameOfSample

README.md

@@ -11,6 +11,7 @@ More details at [http://www.hodgkins.net.au/mswindows/using-powershell-to-send-m
 * Can collect values by using T-SQL queries against MS SQL databases
 * Converts time to UTC on sending
 * All configuration can be done from a simple XML file
+* Allows you to override the hostname in Windows Performance Counters before sending on to Graphite
 * Reloads the XML configuration file automatically. For example, if more counters are added to the configuration file, the script will notice and start sending metrics for them to Graphite in the next send interval
 * Additional functions are exposed that allow you to send data to Graphite from PowerShell easily. [Here](#functions) is the list of included functions
 * Script can be installed to run as a service
@@ -38,6 +39,7 @@ Configuration Name | Description
 CarbonServer | The server name where Carbon is running. The Carbon daemon is usually running on the Graphite server.
 CarbonServerPort | The port number for Carbon. Its default port number is 2003.
 MetricPath | The path of the metric you want to be sent to the server. If you are using HostedGraphite, put your API key before the rest of the metric path, for example `YOUR-API-KEY.datacenter1.servers`.
+NodeHostName | This allows you to override the hostname of the server before sending the metrics on to Graphite. Default is use `$env:COMPUTERNAME`, which will use the local computer name.
 MetricSendIntervalSeconds | The interval to send metrics to Carbon; I recommend 5 seconds or greater. The more metrics you are collecting the longer it takes to send them to the Graphite server. You can see how long it takes to send the metrics each time the loop runs by using running the `Start-StatsToGraphite` function and having *VerboseOutput* set to *True*.
 SendUsingUDP | Sends metrics via UDP instead of TCP.
 

StatsToGraphiteConfig.xml

@@ -4,6 +4,7 @@
         <CarbonServer>yourCarbonServerNameOrIP</CarbonServer>
         <CarbonServerPort>2003</CarbonServerPort>
         <MetricPath>datacenter1.servers</MetricPath>
+        <NodeHostName>$env:COMPUTERNAME</NodeHostName>
         <MetricSendIntervalSeconds>5</MetricSendIntervalSeconds>
         <SendUsingUDP>False</SendUsingUDP>
     </Graphite>