network

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 26, 2021 License: MIT Imports: 4 Imported by: 0

README

= Network plugin
:toc: macro

The network plugin provides checks for low-level network services.

== Checks

=== network.connect

[source,goplum]
----
check network.connect "example" {
  address = "hostname:1234"
  network = "tcp6"
}
----

Attempts to open a network connection to the given address. Addresses must be in
the form "host:port", "host%zone:port", "[host]:port" or "[host%zone]:port".

By default, connection attempts will be made over TCP (IPv6 or IPv4 using Fast Fallback).
If the `network` parameter is included then connection attempts will be limited to that
network. Valid options are: "tcp", "tcp4", "tcp6", "udp", "udp4", "udp6".

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConnectCheck

type ConnectCheck struct {
	Network string
	Address string
}

func (ConnectCheck) Execute

func (c ConnectCheck) Execute(ctx context.Context) goplum.Result

func (ConnectCheck) Validate

func (c ConnectCheck) Validate() error

type Plugin

type Plugin struct{}

func (Plugin) Alert

func (p Plugin) Alert(kind string) goplum.Alert

func (Plugin) Check

func (p Plugin) Check(kind string) goplum.Check

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL