portcheck

README

portcheck

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

It produces the following charts for every monitoring port:

1. TCP Check Status in boolean

• success
• failed
• timeout

1. Current State Duration in seconds

• time

1. TCP Connection Latency in ms

• time

configuration

Here is an example for 2 servers:

jobs:
  - name: server1
    host: 127.0.0.1
    ports: [22, 23]
      
  - name: server2
    host: 10.0.0.1
    ports: [80, 81, 8080]

For all available options please see module configuration file.

---

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.