portcheck

README

TCP endpoint monitoring with Netdata

This module will monitors one or more TCP services availability and response time.

Charts

It produces the following charts for every monitoring port:

• TCP Check Status in boolean
• Current State Duration in seconds
• TCP Connection Latency in ms

Configuration

Edit the go.d/portcheck.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/portcheck.conf

Here is an example for 2 servers:

jobs:
  - name: server1
    host: 127.0.0.1
    ports:
      - 22
      - 23

  - name: server2
    host: 203.0.113.10
    ports:
      - 80
      - 81
      - 8081

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the portcheck collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

First, navigate to your plugins directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

./go.d.plugin -d -m portcheck

Documentation

Index

• type Charts
• type Config
• type Dims
• type PortCheck
  • func New() *PortCheck
  • func (pc PortCheck) Charts() *Charts
  • func (PortCheck) Check() bool
  • func (PortCheck) Cleanup()
  • func (pc *PortCheck) Collect() map[string]int64
  • func (pc *PortCheck) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	Host    string       `yaml:"host"`
	Ports   []int        `yaml:"ports"`
	Timeout web.Duration `yaml:"timeout"`
}

/ Config is the Portcheck module configuration file.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type PortCheck

type PortCheck struct {
	module.Base
	Config      `yaml:",inline"`
	UpdateEvery int `yaml:"update_every"`
	// contains filtered or unexported fields
}

PortCheck portcheck module.

func New

func New() *PortCheck

New creates PortCheck with default values.

func (PortCheck) Charts

func (pc PortCheck) Charts() *Charts

Charts creates charts.

func (PortCheck) Check

func (PortCheck) Check() bool

Check makes check.

func (PortCheck) Cleanup

func (PortCheck) Cleanup()

Cleanup makes cleanup.

func (*PortCheck) Collect

func (pc *PortCheck) Collect() map[string]int64

Collect collects metrics.

func (*PortCheck) Init

func (pc *PortCheck) Init() bool

Init makes initialization.