New Relic Infrastructure custom integration to monitor TCP ports (using Powershell)

com.newrelic.tcp-port-monitor-config.yaml

integration_name: com.newrelic.tcp-port-monitor
instances:
  - name: localhost
    command: metrics
    arguments:
      server: localhost
      port: 21
    labels:
      env: development

com.newrelic.tcp-port-monitor-definition.yaml

name: com.newrelic.tcp-port-monitor
protocol_version: 1
description: Monitors TCP ports and reports if they are open or not
commands:
  metrics:
    command:
      - C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe
      - .\tcp-port-monitor.ps1
    interval: 60

tcp-port-monitor.ps1

$output = @{"name" = "com.newrelic.tcp-port-monitor"; "protocol_version" = "1"; integration_version = "0.1.0"}

$output.metrics = @()
$output.inventory = @{}
$output.events = @()

$server = $Env:SERVER
$port = $Env:PORT

$client = New-Object System.Net.Sockets.TcpClient;
Try {
  $client.Connect($server, $port)
  $conn = 1
} Catch {
  $conn = 0
} Finally {
  $client.Dispose()
  $output.metrics += @{"event_type" = "NewRelicTCPPortMonitor"; "net.portOpen" = $conn; "server" = $server; "port" = ":$($port)"}
}

$output | ConvertTo-Json -Compress

Installation Instructions

On Windows, Infrastructure is installed at C:\Program Files\New Relic\newrelic-infra\. Drop the tcp-port-monitor.ps1 and com.newrelic.tcp-port-monitor-definition.yaml files in the custom-integrations folder. Drop com.newrelic.tcp-port-monitor-config.yaml into the integrations.d folder.

Update the path to the correct path to Powershell.exe on your system.

Update the instances to monitor in the config file.

Restart the New Relic Infrastructure Agent service.

View Metrics

The responses are stored within Insights. To query the data, use the following query:

SELECT timestamp, `net.portOpen`, server, port FROM NewRelicTCPPortMonitor